Data Warehouse API

v1beta1

Introduction

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 page to find definitions of terms related to Data Warehouse for ClickHouse®.

Quickstart

Configure your environment variables.

Note

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

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>"

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.

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"

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

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"

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.

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}"

Requirements

You have a Scaleway account
You have created an API key and that the API key has sufficient IAM permissions to perform the actions described on this page
You have installed curl

Going further

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

Our main documentation
The #data-warehouse-beta channel on our Slack Community
Our support ticketing system.

Deployments

A deployment is composed of one or multiple replicas.

GET/datawarehouse/v1beta1/regions/{region}/deployments

POST/datawarehouse/v1beta1/regions/{region}/deployments

GET/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

PATCH/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

DELETE/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}

Presets

Data Warehouse preset to help you choose the best configuration.

GET/datawarehouse/v1beta1/regions/{region}/presets

Deployment Versions

ClickHouse® versions powering your deployment.

GET/datawarehouse/v1beta1/regions/{region}/versions

User Management

Manage users associated with a deployment.

GET/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users

PATCH/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

DELETE/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/users/{name}

Database Management

Manage databases within a deployment.

GET/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

POST/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases

DELETE/datawarehouse/v1beta1/regions/{region}/deployments/{deployment_id}/databases/{name}

Endpoint Management

Manage endpoints associated with a deployment.

POST/datawarehouse/v1beta1/regions/{region}/endpoints

DELETE/datawarehouse/v1beta1/regions/{region}/endpoints/{endpoint_id}