Skip to content

run-load-data

Help command

> csm-data api run-load-data --help

 Usage: csm-data api run-load-data [OPTIONS]                                    

 Download a runner data from the Cosmo Tech API Requires a valid Azure          
 connection either with:                                                        

  • The AZ cli command: az login                                                
  • A triplet of env var AZURE_TENANT_ID, AZURE_CLIENT_ID, AZURE_CLIENT_SECRET  
 Requires env var CSM_API_URL     The URL to a Cosmotech API                    
 Requires env var CSM_API_SCOPE   The identification scope of a Cosmotech API   

╭─ OPTIONS ────────────────────────────────────────────────────────────────────╮
│ *  --organization-id              o-##########  The id of an organization in │
│                                                 the cosmotech api            │
│                                                 ENV: CSM_ORGANIZATION_ID     │
│                                                 [required]                   │
│ *  --workspace-id                 w-##########  The id of a workspace in the │
│                                                 cosmotech api                │
│                                                 ENV: CSM_WORKSPACE_ID        │
│                                                 [required]                   │
│ *  --runner-id                    s-##########  The id of a runner in the    │
│                                                 cosmotech api                │
│                                                 ENV: CSM_RUNNER_ID           │
│                                                 [required]                   │
│ *  --dataset-absolute-path        PATH          csm-data.commands.api.run_l… │
│                                                 ENV:                         │
│                                                 CSM_DATASET_ABSOLUTE_PATH    │
│                                                 [required]                   │
│ *  --parameters-absolute-path     PATH          A local folder to store the  │
│                                                 parameters content           │
│                                                 ENV:                         │
│                                                 CSM_PARAMETERS_ABSOLUTE_PATH │
│                                                 [required]                   │
│    --write-json/--no-write-js…                  csm-data.commands.api.run_l… │
│                                                 ENV: WRITE_JSON              │
│                                                 DEFAULT: write-json          │
│    --write-csv/--no-write-csv                   csm-data.commands.api.run_l… │
│                                                 ENV: WRITE_CSV               │
│                                                 DEFAULT: no-write-csv        │
│    --fetch-dataset/--no-fetch…                  csm-data.commands.api.run_l… │
│                                                 ENV: FETCH_DATASET           │
│                                                 DEFAULT: fetch-dataset       │
│    --parallel/--no-parallel                     csm-data.commands.api.run_l… │
│                                                 ENV:                         │
│                                                 FETCH_DATASETS_IN_PARALLEL   │
│                                                 DEFAULT: parallel            │
│    --web-help                                   Open the web documentation   │
│    --help                                       Show this message and exit.  │
╰──────────────────────────────────────────────────────────────────────────────╯