Skip to content

Latest commit

 

History

History
36 lines (27 loc) · 3.03 KB

BulkCreateDatabasesRequest.md

File metadata and controls

36 lines (27 loc) · 3.03 KB

BulkCreateDatabasesRequest

Request body for POST /databases/bulk. One template plus a count, so the body stays small whatever count is. Any schemas and tables declared here are applied to every database in the batch; load data into them afterwards exactly as you would for a database created one at a time.

Properties

Name Type Description Notes
count int How many databases to create.
default_catalog str Name the default catalog answers to inside each database, as on a single create. Defaults to `default`. [optional]
default_schema str Schema that unqualified table names resolve to inside each database. [optional]
expires_at str When the created databases expire. Accepts an RFC 3339 timestamp or a relative duration such as `24h`, `90m`, or `7d`. [optional]
idempotency_key str Repeat this value to retry a request safely. A retry carrying a key that was already used returns the original batch — the same `batch_id` and the same databases — instead of creating a second set. The key identifies the request, not its contents: reusing a key with a different `count` or template returns the original batch unchanged rather than reporting a mismatch. Use a fresh key per distinct request. [optional]
name_template str Optional display-label pattern for each database. `{index}` is replaced with the database's zero-based position — for example `tenant-{index}` produces `tenant-0`, `tenant-1`, and so on. Labels are not identifiers and are not required to be unique. [optional]
schemas List[DatabaseDefaultSchemaDecl] Schemas and tables to declare on every database in the batch, in the same shape a single create accepts. The declaration applies identically to each database, so a batch of 10,000 declaring one table yields 10,000 databases that each hold that table and are ready to load — with no follow-up call per database. Omitted or empty means each database starts with no tables. [optional]

Example

from hotdata.models.bulk_create_databases_request import BulkCreateDatabasesRequest

# TODO update the JSON string below
json = "{}"
# create an instance of BulkCreateDatabasesRequest from a JSON string
bulk_create_databases_request_instance = BulkCreateDatabasesRequest.from_json(json)
# print the JSON string representation of the object
print(BulkCreateDatabasesRequest.to_json())

# convert the object into a dict
bulk_create_databases_request_dict = bulk_create_databases_request_instance.to_dict()
# create an instance of BulkCreateDatabasesRequest from a dict
bulk_create_databases_request_from_dict = BulkCreateDatabasesRequest.from_dict(bulk_create_databases_request_dict)

[Back to Model list] [Back to API list] [Back to README]