Contact UsGet started
© 2024 Iron Hive LLC Belgrade

Managed Service for ClickHouse API, gRPC: DatabaseService.Create

Written by
Updated at October 17, 2024

Creates a new ClickHouse database in the specified cluster.

gRPC request

rpc Create (CreateDatabaseRequest) returns (operation.Operation)

CreateDatabaseRequest

{
  "clusterId": "string",
  "databaseSpec": {
    "name": "string"
  }
}

Field

Description

clusterId

string

Required field. ID of the ClickHouse cluster to create a database in.
To get the cluster ID, use a ClusterService.List request.

databaseSpec

DatabaseSpec

Required field. Configuration of the database to create.

DatabaseSpec

Field

Description

name

string

Required field. Name of the ClickHouse database. 1-63 characters long.

operation.Operation

{
  "id": "string",
  "description": "string",
  "createdAt": "google.protobuf.Timestamp",
  "createdBy": "string",
  "modifiedAt": "google.protobuf.Timestamp",
  "done": "bool",
  "metadata": {
    "clusterId": "string",
    "databaseName": "string"
  },
  // Includes only one of the fields `error`, `response`
  "error": "google.rpc.Status",
  "response": {
    "name": "string",
    "clusterId": "string"
  }
  // end of the list of possible fields
}

An Operation resource. For more information, see Operation.

Field

Description

id

string

ID of the operation.

description

string

Description of the operation. 0-256 characters long.

createdAt

google.protobuf.Timestamp

Creation timestamp.

createdBy

string

ID of the user or service account who initiated the operation.

modifiedAt

google.protobuf.Timestamp

The time when the Operation resource was last modified.

done

bool

If the value is false, it means the operation is still in progress.
If true, the operation is completed, and either error or response is available.

metadata

CreateDatabaseMetadata

Service-specific metadata associated with the operation.
It typically contains the ID of the target resource that the operation is performed on.
Any method that returns a long-running operation should document the metadata type, if any.

error

google.rpc.Status

The error result of the operation in case of failure or cancellation.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

response

Database

The normal response of the operation in case of success.
If the original method returns no data on success, such as Delete,
the response is google.protobuf.Empty.
If the original method is the standard Create/Update,
the response should be the target resource of the operation.
Any method that returns a long-running operation should document the response type, if any.

Includes only one of the fields error, response.

The operation result.
If done == false and there was no failure detected, neither error nor response is set.
If done == false and there was a failure detected, error is set.
If done == true, exactly one of error or response is set.

CreateDatabaseMetadata

Field

Description

clusterId

string

ID of the ClickHouse cluster where a database is being created.

databaseName

string

Name of the ClickHouse database that is being created.

Database

A ClickHouse Database resource. For more information, see the
Developer's Guide.

Field

Description

name

string

Name of the database.

clusterId

string

ID of the ClickHouse cluster that the database belongs to.
Previous
List
Next
Delete