Skip to content

dump-to-azure

Help command

> csm-data store dump-to-azure --help

 Usage: csm-data store dump-to-azure [OPTIONS]                                  

 Dump a datastore to a Azure storage account.                                   
 Will upload everything from a given data store to a Azure storage container.   

 3 modes currently exists :                                                     

  • sqlite : will dump the data store underlying database as is                 
  • csv : will convert every table of the datastore to csv and send them as     
    separate files                                                              
  • parquet : will convert every table of the datastore to parquet and send     
    them as separate files                                                      

 Make use of the azure.storage.blob library to access the container             

 More information is available on this page:                                    
 [https://learn.microsoft.com/en-us/azure/storage/blobs/storage-quickstart-blob 
 s-python?tabs=managed-identity%2Croles-azure-portal%2Csign-in-azure-cli&pivots 
 =blob-storage-quickstart-scratch)                                              

╭─ OPTIONS ────────────────────────────────────────────────────────────────────╮
│ *  --store-folder      PATH                  The folder containing the store │
│                                              files                           │
│                                              ENV:                            │
│                                              CSM_PARAMETERS_ABSOLUTE_PATH    │
│                                              [required]                      │
│    --output-type       [sqlite|csv|parquet]  Choose the type of file output  │
│                                              to use                          │
│ *  --account-name      TEXT                  The account name on Azure to    │
│                                              upload to                       │
│                                              ENV: AZURE_ACCOUNT_NAME         │
│                                              [required]                      │
│    --container-name    TEXT                  The container name on Azure to  │
│                                              upload to                       │
│                                              ENV: AZURE_CONTAINER_NAME       │
│    --prefix            PREFIX                A prefix by which all uploaded  │
│                                              files should start with in the  │
│                                              container                       │
│                                              ENV: CSM_DATA_PREFIX            │
│ *  --tenant-id         ID                    Tenant Identity used to connect │
│                                              to Azure storage system         │
│                                              ENV: AZURE_TENANT_ID            │
│                                              [required]                      │
│ *  --client-id         ID                    Client Identity used to connect │
│                                              to Azure storage system         │
│                                              ENV: AZURE_CLIENT_ID            │
│                                              [required]                      │
│ *  --client-secret     ID                    Client Secret tied to the ID    │
│                                              used to connect to Azure        │
│                                              storage system                  │
│                                              ENV: AZURE_CLIENT_SECRET        │
│                                              [required]                      │
│    --web-help                                Open the web documentation      │
│    --help                                    Show this message and exit.     │
╰──────────────────────────────────────────────────────────────────────────────╯