Mprove
.mdx

definitions

Usage

➜  ~ mprove definitions -h
Print the CLI definitions

━━━ Usage ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

$ mprove definitions

━━━ Options ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

  --json    (default false)

━━━ Examples ━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━

Print the CLI definitions
  $ mprove definitions

Example Output

➜  ~ mprove definitions
...
  path:        mprove get-query-info
  usage:       mprove get-query-info
  description: 
    """
      Get query info
      
    """
  examples: 
    - 
      - 
        """
          Get Query Info for Chart
          
        """
      - mprove get-query-info --project-id DXYE72ODCP5LWPWH2EXQ --repo-type dev --branch main --env prod --chart-id v1 --get-malloy --get-sql --get-data
    - 
      - 
        """
          Get Query Info for Dashboard
          
        """
      - mprove get-query-info --project-id DXYE72ODCP5LWPWH2EXQ --repo-type dev --branch main --env prod --dashboard-id d1 --get-malloy --get-sql --get-data
    - 
      - 
        """
          Get Query Info for Report
          
        """
      - mprove get-query-info --project-id DXYE72ODCP5LWPWH2EXQ --repo-type dev --branch main --env prod --report-id r1 --get-malloy --get-sql --get-data
  options: 
    - 
      definition:  --project-id #0
      description: (required) Project Id
      required:    false
    - 
      definition:  --repo-type #0
      description: (required, "dev", "production" or "session")
      required:    true
    - 
      definition:  --branch #0
      description: (required) Git Branch
      required:    true
    - 
      definition:  --env #0
      description: (required) Environment
      required:    true
    - 
      definition:  --dashboard-id #0
      description: (dashboard-id, chart-id or report-id required) Dashboard Id (name)
      required:    false
    - 
      definition:  --tile-index #0
      description: (optional) Dashboard Tile Index starting with 0
      required:    false
    - 
      definition:  --chart-id #0
      description: (dashboard-id, chart-id or report-id required) Chart Id (name)
      required:    false
    - 
      definition:  --report-id #0
      description: (dashboard-id, chart-id or report-id required) Report Id (name)
      required:    false
    - 
      definition:  --row-id #0
      description: (optional) Report Row Id
      required:    false
    - 
      definition:  --timezone #0
      description: (default "UTC") Timezone
      required:    false
    - 
      definition:  --detail #0
      description: (default "days") for Report -  "timestamps" | "seconds" | "minutes" | "hours" | "days" | "weeks" | "months" | "quarters" | "years"
      required:    false
    - 
      definition:  --range #0
      description: (default "f`last 5 days`") for Report - Ts Filter Expression
      required:    false
    - 
      definition:  --get-malloy
      description: (default false), show malloy query in output
      required:    false
    - 
      definition:  --get-sql
      description: (default false), show query sql in output
      required:    false
    - 
      definition:  --get-data
      description: (default false), show query data in output
      required:    false
    - 
      definition:  --json
      description: (default false)
      required:    false
    - 
      definition:  --env-file-path #0
      description: (optional) Path to ".env" file
      required:    false
...

On this page