Patch

/tables/add_columns/

This endpoint adds Columns to a Database Table.

Security

HTTP

Type basic

Basic authentication using VMS user name and password

API Key: ApiToken

Header parameter nameApiToken

Send current valid API token in an Authorization header with format Api-Token .

Body parameters

Expand All

object

database_name

string Required

Name of the Database

schema_name

string Required

Name of the Schema

name

string Required

Name of the object

arrow_schema

Array of object (TabularColumnArrowSchema) Required

Description of table columns

object

name

string Required

Name of the object

field

object Required

Column type

Example{ "column_type": "map", "key_type": { "column_type": "bool" }, "value_type": { "column_type": "bool" } }

tenant_id

integer

Tenant ID

is_imports_table

boolean

Is table actually a sub-table to track imported .parquet files.

sorted_column_names

Array of string

Array of sorted column names

string

vector_indexes

Array of object (VectorIndex)

Vector indexes to create on this table. At most one index is supported per table. CLI format per index: column:METRIC. Multiple indexes are separated with ;.

object

column_name

string Required

Column name to create a vector index on.

distance_metric

string Required

Distance metric for the vector index.

EUCLIDEAN: standard Euclidean distance.
NEGATIVE_INNER_PRODUCT: negative inner product for similarity search.
COSINE: cosine distance (derived from cosine similarity).

Valid values[ "EUCLIDEAN", "NEGATIVE_INNER_PRODUCT", "COSINE" ]

cluster_quantization

string Required

Quantization mode used during vector index clustering.

Valid values[ "SCALAR_8BIT", "NONE" ]

search_quantization

string Required

Quantization mode used during vector index search.

Valid values[ "SCALAR_8BIT", "NONE" ]

clustering_progress

integer

Vector-index reclustering progress as a percentage (0-100).

clustering_progress_label

string

Vector-index reclustering progress label. Higher label means higher progress.

Valid values[ "A+", "A", "B", "C" ]

partitions_config

Array of object (TransformNode)

Ordered list of partition transforms

object

Transform expression.

Supported signatures (validated server-side):

identity(column)
year(column)
month(column)
day(column)
hour(column)
truncate(int, column)
bucket(int, column)

type

string Required

Valid values[ "transform" ]

value

string Required

Valid values[ "identity", "year", "month", "day", "hour", "truncate", "bucket" ]

args

Array of object (ArgNode) Required

object

Transform argument node.

type=column -> value must be a column name (string)
type=const -> value must be a scalar (int, float, string, bool)

type

string Required

Valid values[ "const", "column" ]

value

object Required

Constant scalar (int, float, string, bool)

Responses

204

OK

Add Columns to a Database Table