Creates a new projection of an existing
table. A projection represents a subset of the columns (potentially including
derived columns) of a table.For projection details and examples, see
Projections. For limitations, see
Projection Limitations and Cautions.Window functions, which can perform operations
like moving averages, are available through this endpoint as well as
/get/records/bycolumn.A projection can be created with a different
shard key than the source table. By
specifying shard_key, the projection will be sharded according to the
specified columns, regardless of how the source table is sharded. The source
table can even be unsharded or replicated.If input parameter table_name is empty, selection is performed against a
single-row virtual table. This can be useful in executing temporal
(NOW()), identity
(USER()), or
constant-based functions
(GEODIST(-77.11, 38.88, -71.06, 42.36)).
Name of the existing table on which the projection is to be applied, in [schema_name.]table_name format, using standard name resolution rules. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.
List of columns from input parameter table_name to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax ‘column_name as alias’.
If true, a unique temporary table name will be generated in the sys_temp schema and used in place of input parameter projection_name. If persist is false (or unspecified), then this is always allowed even if the caller does not have permission to create tables. The generated name is returned in qualified_projection_name.The default value is false.The supported values are:
[DEPRECATED—please specify the containing schema for the projection as part of input parameter projection_name and use /create/schema to create the schema if non-existent] Name of a schema for the projection. If the schema is non-existent, it will be automatically created.The default value is ”.
Comma-separated list of the columns to be sorted by; e.g. ‘timestamp asc, x desc’. The columns specified must be present in input parameter column_names. If any alias is given for any column name, the alias must be used, rather than the original column name.The default value is ”.
Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in input parameter column_names. If any alias is given for any column name, the alias must be used, rather than the original column name.
Comma-separated list of the columns to be sharded on; e.g. ‘column1, column2’. The columns specified must be present in input parameter column_names. If any alias is given for any column name, the alias must be used, rather than the original column name.The default value is ”.
If true, then the projection specified in input parameter projection_name will be persisted and will not expire unless a ttl is specified. If false, then the projection will be an in-memory table and will expire unless a ttl is specified otherwise.The default value is false.The supported values are:
If true, then columns that were dict encoded in the source table will be dict encoded in the projection.The default value is true.The supported values are:
Determines whether the created projection will retain the partitioning scheme from the source table.The default value is false.The supported values are:
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:
If set, window functions which require a reshard will be computed separately and joined back together, if the width of the projection is greater than the join_window_functions_threshold.The default value is true.
If the projection is greater than this width (in bytes), then window functions which require a reshard will be computed separately and joined back together.The default value is ”.
An optional filter expression applied to the projection after window function evaluation, equivalent to a SQL QUALIFY clause. May reference window function aliases as well as any other column in the projection. Rows for which the expression evaluates to false (or NULL) are removed from the projection.The default value is ”.
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:
