Skip to content

run-load-data

Help command

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

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

 csm_data.commands.api.run_load_data.description 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-##########  csm_data.commands.api.run_l… │
│                                                 ENV: CSM_ORGANIZATION_ID     │
│                                                 [required]                   │
│ *  --workspace-id                 w-##########  csm_data.commands.api.run_l… │
│                                                 ENV: CSM_WORKSPACE_ID        │
│                                                 [required]                   │
│ *  --runner-id                    s-##########  csm_data.commands.api.run_l… │
│                                                 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          csm_data.commands.api.run_l… │
│                                                 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.  │
╰──────────────────────────────────────────────────────────────────────────────╯