Skip to content

api

Help command

> csm-data api --help

 Usage: csm-data api [OPTIONS] COMMAND [ARGS]...                                

 Cosmo Tech API helper command                                                  
 This command will inform you of which connection is available to use for the   
 Cosmo Tech API                                                                 

 If no connection is available, will list all possible set of parameters and    
 return an error code,                                                          

 You can use this command in a csm-orc template to make sure that API           
 connection is available.                                                       

╭─ OPTIONS ────────────────────────────────────────────────────────────────────╮
│ --web-help      Open the web documentation                                   │
│ --help          Show this message and exit.                                  │
╰──────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ───────────────────────────────────────────────────────────────────╮
│ postgres-send-runner-metadata  csm_data.commands.api.postgres_send_runner_m… │
│ rds-load-csv                   csm_data.commands.api.rds_load_csv.descripti… │
│ rds-send-csv                   csm_data.commands.api.rds_send_csv.descripti… │
│ rds-send-store                 csm_data.commands.api.rds_send_store.descrip… │
│ run-load-data                  csm_data.commands.api.run_load_data.descript… │
│                                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       │
│ runtemplate-load-handler       csm_data.commands.api.runtemplate_load_handl… │
│ tdl-load-files                 csm_data.commands.api.tdl_load_files.descrip… │
│ tdl-send-files                 csm_data.commands.api.tdl_send_files.descrip… │
│ wsf-load-file                  csm_data.commands.api.wsf_load_file.descript… │
│ wsf-send-file                  csm_data.commands.api.wsf_send_file.descript… │
╰──────────────────────────────────────────────────────────────────────────────╯