/create/table

URL: http://<db.host>:<db.port>/create/table

Creates a new table with the given type (definition of columns). The type is specified in input parameter type_id as either a numerical type ID (as returned by /create/type) or as a list of columns, each specified as a list of the column name, data type, and any column attributes.

Example of a type definition with some parameters:

[
        ["id", "int8", "primary_key"],
        ["dept_id", "int8", "primary_key", "shard_key"],
        ["manager_id", "int8", "nullable"],
        ["first_name", "char32"],
        ["last_name", "char64"],
        ["salary", "decimal"],
        ["hire_date", "date"]
]

Each column definition consists of the column name (which should meet the standard column naming criteria), the column's specific type (int, long, float, double, string, bytes, or any of the properties map values from /create/type), and any data handling, data key, or data replacement properties.

A table may optionally be designated to use a replicated distribution scheme, or be assigned: foreign keys to other tables, a partitioning scheme, and/or a tier strategy.

Input Parameter Description

Name

Type

Description

table_name

string

Name of the table to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria. Error for requests with existing table of the same name and type ID may be suppressed by using the no_error_if_exists option.

type_id

string

The type for the table, specified as either an existing table's numerical type ID (as returned by /create/type) or a type definition (as described above).

options

map of string to strings

Optional parameters. The default value is an empty map ( {} ).

Supported Parameters (keys)

Parameter Description

no_error_if_exists

If true, prevents an error from occurring if the table already exists and is of the given type. If a table with the same ID but a different type exists, it is still an error. The default value is false. The supported values are:

true
false

create_temp_table

If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter table_name. If is_result_table is true, then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_table_name. The default value is false. The supported values are:

true
false

collection_name

[DEPRECATED--please specify the containing schema as part of input parameter table_name and use /create/schema to create the schema if non-existent] Name of a schema which is to contain the newly created table. If the schema is non-existent, it will be automatically created.

is_collection

[DEPRECATED--please use /create/schema to create a schema instead] Indicates whether to create a schema instead of a table. The default value is false. The supported values are:

true
false

is_replicated

Affects the distribution scheme for the table's data. If true and the given type has no explicit shard key defined, the table will be replicated. If false, the table will be sharded according to the shard key specified in the given input parameter type_id, or randomly sharded, if no shard key is specified. Note that a type containing a shard key cannot be used to create a replicated table. The default value is false. The supported values are:

true
false

foreign_keys

Semicolon-separated list of foreign keys, of the format '(source_column_name [, ...]) references target_table_name(primary_key_column_name [, ...]) [as foreign_key_name]'.

foreign_shard_key

Foreign shard key of the format 'source_column references shard_by_column from target_table(primary_key_column)'.

partition_type

Partitioning scheme to use.

Supported Values	Description
RANGE	Use range partitioning.
INTERVAL	Use interval partitioning.
LIST	Use list partitioning.
HASH	Use hash partitioning.
SERIES	Use series partitioning.

partition_keys

Comma-separated list of partition keys, which are the columns or column expressions by which records will be assigned to partitions defined by partition_definitions.

partition_definitions

Comma-separated list of partition definitions, whose format depends on the choice of partition_type. See range partitioning, interval partitioning, list partitioning, hash partitioning, or series partitioning for example formats.

is_automatic_partition

If true, a new partition will be created for values which don't fall into an existing partition. Currently only supported for list partitions. The default value is false. The supported values are:

true
false

ttl

Sets the TTL of the table specified in input parameter table_name.

chunk_size

Indicates the number of records per chunk to be used for this table.

chunk_column_max_memory

Indicates the target maximum data size for each column in a chunk to be used for this table.

chunk_max_memory

Indicates the target maximum data size for all columns in a chunk to be used for this table.

is_result_table

Indicates whether the table is a memory-only table. A result table cannot contain columns with text_search data- handling, and it will not be retained if the server is restarted. The default value is false. The supported values are:

true
false

strategy_definition

The tier strategy for the table and its columns.

compression_codec

The default compression codec for this table's columns.

load_vectors_policy

Set startup data loading scheme for the table The default value is system.

Supported Values	Description
always	Load as much vector data as possible into memory before accepting requests.
lazy	Load the necessary vector data at start, and load the remainder lazily.
on_demand	Load vector data as requests use it.
system	Load vector data using the system-configured default.

build_pk_index_policy

Set startup primary-key index generation scheme for the table The default value is system.

Supported Values	Description
always	Generate as much primary key index data as possible before accepting requests.
lazy	Generate the necessary primary key index data at start, and load the remainder lazily.
on_demand	Generate primary key index data as requests use it.
system	Generate primary key index data using the system-configured default.

Output Parameter Description

The GPUdb server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:

Name

Type

Description

status

String

'OK' or 'ERROR'

message

String

Empty if success or an error message

data_type

String

'create_table_response' or 'none' in case of an error

data

String

Empty string

data_str

JSON or String

This embedded JSON represents the result of the /create/table endpoint:

Name

Type

Description

table_name

string

Value of input parameter table_name.

type_id

string

Value of input parameter type_id.

is_collection

boolean

[DEPRECATED--this will always return false] Indicates if the created entity is a schema.

info

map of string to strings

Additional information. The default value is an empty map ( {} ).

Possible Parameters (keys)	Parameter Description
qualified_table_name	The fully qualified name of the new table (i.e. including the schema)

Empty string in case of an error.