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:
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.
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).
map of string to strings
Optional parameters.The default value is an empty map ( {} ).
Show options
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
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
[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.
[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
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
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 of the format ‘source_column references shard_by_column from target_table(primary_key_column)’.
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.
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
Sets the TTL of the table specified in input parameter table_name.
Indicates the number of records per chunk to be used for this table.
Indicates the target maximum data size for each column in a chunk to be used for this table.
Indicates the target maximum data size for all columns in a chunk to be used for this 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:
Set startup data loading scheme for the table.The default value is system.
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.
Set startup primary-key index generation scheme for the table.The default value is system.
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 Kinetica 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:
String
‘OK’ or ‘ERROR’
String
Empty if success or an error message
String
‘create_table_response’ or ‘none’ in case of an error
String
Empty string
JSON or String
This embedded JSON represents the result of the /create/table endpoint:
Show data_str
string
Value of input parameter table_name.
string
Value of input parameter type_id.
boolean
[DEPRECATED—this will always return false] Indicates if the created entity is a schema.
map of string to strings
Additional information.The default value is an empty map ( {} ).
Show info
The fully qualified name of the new table (i.e. including the schema).
Empty string in case of an error.
Assistant
Responses are generated using AI and may contain mistakes.