Data Warehouse API

Data Warehouse for ClickHouse® is a centralized repository to store large sets of structured data, to streamline analysis and reporting for data science and business intelligence.

Concepts

Refer to our dedicated concepts pageOpen in new context to find definitions of terms related to Data Warehouse for ClickHouse®.

Quickstart

1. Configure your environment variables.

   Note

   This is an optional step that seeks to simplify your usage of the Data Warehouse API.

   Code
   export SCW_SECRET_KEY="<API secret key>"
   export SCW_DEFAULT_ZONE="<Scaleway default Availability Zone>"
   export SCW_DEFAULT_REGION="<Scaleway default region>"
   export SCW_PROJECT_ID="<Scaleway Project ID>"

2. Create a deployment: run the following command to create a deployment. You can customize the details in the payload to your needs, using the table below to help.

   Code
   curl -X POST \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     -H "Content-Type: application/json" \
     -d '{
       "cpu_max": 1,
       "cpu_min": 4,
       "name": "MyDeployment",
       "password": "string",
       "project_id": $SCW_PROJECT_ID,
     }' \
     "https://api.scaleway.com/datawarehouse/v1beta1/regions/fr-par/deployments"

3. Get a list of your deployments: run the following command to get a list of all the deployments in your account, with their details:

   Code
   curl -X GET \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "https://api.scaleway.com/datawarehouse/v1beta1/regions/fr-par/deployments"

4. Delete your deployment: run the following command to delete a deployment. Ensure that you replace {resource-id} in the URL with the ID of the deployment you want to delete.

   Code
   curl -X DELETE \
     -H "Content-Type: application/json" \
     -H "X-Auth-Token: $SCW_SECRET_KEY" \
     "https://api.scaleway.com/datawarehouse/v1beta1/regions/fr-par/deployments/{resource-id}"

Going further

For more help using Scaleway Data Warehouse for ClickHouse®, check out the following resources:

• Our main documentationOpen in new context
• The #data-warehouse-beta channel on our Slack CommunityOpen in new context
• Our support ticketing systemOpen in new context.