kinetica.CreateProjectionRequest

A set of parameters for Kinetica.createProjection. More…

Inheritance diagram for kinetica.CreateProjectionRequest:

Collaboration diagram for kinetica.CreateProjectionRequest:

Classes
struct	Options
	A set of string constants for the parameter CreateProjectionRequest.options. More…

Public Member Functions
	CreateProjectionRequest ()
	Constructs a CreateProjectionRequest object with default parameters.

	CreateProjectionRequest (string table_name, string projection_name, IList< string > column_names, IDictionary< string, string > options=null)
	Constructs a CreateProjectionRequest object with the specified parameters.

	CreateProjectionRequest ()
	Constructs a CreateProjectionRequest object with default parameters.

	CreateProjectionRequest (string table_name, string projection_name, IList< string > column_names, IDictionary< string, string > options=null)
	Constructs a CreateProjectionRequest object with the specified parameters.

Public Member Functions inherited from kinetica.KineticaData
	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

	KineticaData (KineticaType type)
	Constructor from Kinetica Type.

	KineticaData (System.Type type=null)
	Default constructor, with optional System.Type.

object	Get (int fieldPos)
	Retrieve a specific property from this object.

void	Put (int fieldPos, object fieldValue)
	Write a specific property to this object.

Properties
string	table_name `[get, set]`
	Name of the existing table on which the projection is to be applied, in [schema_name.

string	projection_name `[get, set]`
	Name of the projection to be created, in [schema_name.

IList< string >	column_names = new List<string>() `[get, set]`
	List of columns from CreateProjectionRequest.table_name to be included in the projection.

IDictionary< string, string >	options = new Dictionary<string, string>() `[get, set]`
	Optional parameters.

Properties inherited from kinetica.KineticaData
Schema	Schema `[get]`
	Avro Schema for this class.

Additional Inherited Members
Static Public Member Functions inherited from kinetica.KineticaData
static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

static ? RecordSchema	SchemaFromType (System.Type t, KineticaType? ktype=null)
	Create an Avro Schema from a System.Type and a KineticaType.

Detailed Description

A set of parameters for Kinetica.createProjection.

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 Kinetica.getRecordsByColumn.

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 CreateProjectionRequest.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)).

Definition at line 43 of file CreateProjection.cs.

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/4]

kinetica.CreateProjectionRequest.CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameters.

Definition at line 839 of file CreateProjection.cs.

◆ CreateProjectionRequest() [2/4]

kinetica.CreateProjectionRequest.CreateProjectionRequest	(	string	table_name,
		string	projection_name,
		IList< string >	column_names,
		IDictionary< string, string >	options = null )

inline

Constructs a CreateProjectionRequest object with the specified parameters.

Parameters

table_name	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.
projection_name	Name of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
column_names	List of columns from table_name to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax ‘column_name as alias’.
options	Optional parameters. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of 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. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of projection_name and use Kinetica.createSchema 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 ”. EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ”. IS_REPLICATED: If TRUE then the projection will be replicated even if the source table is not. Supported values: TRUE FALSE The default value is FALSE. OFFSET: The number of initial results to skip (this can be useful for paging through the results). The default value is ‘0’. LIMIT: The number of records to keep. The default value is ‘-9999’. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. ‘timestamp asc, x desc’. The columns specified must be present in 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 ”. CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this projection. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this projection. CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in column_names . If any alias is given for any column name, the alias must be used, rather than the original column name. TTL: Sets the TTL of the projection specified in projection_name . SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. ‘column1, column2’. The columns specified must be present in 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 ”. PERSIST: If TRUE, then the projection specified in 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. Supported values: TRUE FALSE The default value is FALSE. PRESERVE_DICT_ENCODING: If TRUE, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: TRUE FALSE The default value is TRUE. RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: TRUE FALSE The default value is FALSE. PARTITION_TYPE: Partitioning scheme to use. Supported values: 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. Supported values: TRUE FALSE The default value is FALSE. VIEW_ID: ID of view of which this projection is a member. The default value is ”. STRATEGY_DEFINITION: The tier strategy for the table and its columns. COMPRESSION_CODEC: The default compression codec for the projection’s columns. JOIN_WINDOW_FUNCTIONS: 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’. JOIN_WINDOW_FUNCTIONS_THRESHOLD: 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 ”. QUALIFY_FILTER: 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 default value is an empty Dictionary.

Definition at line 1259 of file CreateProjection.cs.

◆ CreateProjectionRequest() [3/4]

kinetica.CreateProjectionRequest.CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameters.

Definition at line 839 of file CreateProjection.cs.

◆ CreateProjectionRequest() [4/4]

kinetica.CreateProjectionRequest.CreateProjectionRequest	(	string	table_name,
		string	projection_name,
		IList< string >	column_names,
		IDictionary< string, string >	options = null )

inline

Constructs a CreateProjectionRequest object with the specified parameters.

Parameters

table_name	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.
projection_name	Name of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
column_names	List of columns from table_name to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax ‘column_name as alias’.
options	Optional parameters. CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of 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. Supported values: TRUE FALSE The default value is FALSE. COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of projection_name and use Kinetica.createSchema 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 ”. EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ”. IS_REPLICATED: If TRUE then the projection will be replicated even if the source table is not. Supported values: TRUE FALSE The default value is FALSE. OFFSET: The number of initial results to skip (this can be useful for paging through the results). The default value is ‘0’. LIMIT: The number of records to keep. The default value is ‘-9999’. ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. ‘timestamp asc, x desc’. The columns specified must be present in 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 ”. CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection. CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this projection. CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this projection. CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in column_names . If any alias is given for any column name, the alias must be used, rather than the original column name. TTL: Sets the TTL of the projection specified in projection_name . SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. ‘column1, column2’. The columns specified must be present in 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 ”. PERSIST: If TRUE, then the projection specified in 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. Supported values: TRUE FALSE The default value is FALSE. PRESERVE_DICT_ENCODING: If TRUE, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: TRUE FALSE The default value is TRUE. RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: TRUE FALSE The default value is FALSE. PARTITION_TYPE: Partitioning scheme to use. Supported values: 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. Supported values: TRUE FALSE The default value is FALSE. VIEW_ID: ID of view of which this projection is a member. The default value is ”. STRATEGY_DEFINITION: The tier strategy for the table and its columns. COMPRESSION_CODEC: The default compression codec for the projection’s columns. JOIN_WINDOW_FUNCTIONS: 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’. JOIN_WINDOW_FUNCTIONS_THRESHOLD: 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 ”. QUALIFY_FILTER: 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 default value is an empty Dictionary.

Definition at line 1259 of file CreateProjection.cs.

Property Documentation

◆ column_names

IList< string > kinetica.CreateProjectionRequest.column_names = new List<string>()

getset

List of columns from CreateProjectionRequest.table_name to be included in the projection.

Can include derived columns. Can be specified as aliased via the syntax ‘column_name as alias’.

Definition at line 432 of file CreateProjection.cs.

◆ options

IDictionary< string, string > kinetica.CreateProjectionRequest.options = new Dictionary<string, string>()

getset

Optional parameters.

CREATE_TEMP_TABLE: If TRUE, a unique temporary table name will be generated in the sys_temp schema and used in place of CreateProjectionRequest.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. Supported values:
- TRUE
- FALSE
The default value is FALSE.
COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of CreateProjectionRequest.projection_name and use Kinetica.createSchema 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 ”.
EXPRESSION: An optional filter expression to be applied to the source table prior to the projection. The default value is ”.
IS_REPLICATED: If TRUE then the projection will be replicated even if the source table is not. Supported values:
- TRUE
- FALSE
The default value is FALSE.
OFFSET: The number of initial results to skip (this can be useful for paging through the results). The default value is ‘0’.
LIMIT: The number of records to keep. The default value is ‘-9999’.
ORDER_BY: Comma-separated list of the columns to be sorted by; e.g. ‘timestamp asc, x desc’. The columns specified must be present in CreateProjectionRequest.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 ”.
CHUNK_SIZE: Indicates the number of records per chunk to be used for this projection.
CHUNK_COLUMN_MAX_MEMORY: Indicates the target maximum data size for each column in a chunk to be used for this projection.
CHUNK_MAX_MEMORY: Indicates the target maximum data size for all columns in a chunk to be used for this projection.
CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in CreateProjectionRequest.column_names. If any alias is given for any column name, the alias must be used, rather than the original column name.
TTL: Sets the TTL of the projection specified in CreateProjectionRequest.projection_name.
SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. ‘column1, column2’. The columns specified must be present in CreateProjectionRequest.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 ”.
PERSIST: If TRUE, then the projection specified in CreateProjectionRequest.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. Supported values:
- TRUE
- FALSE
The default value is FALSE.
PRESERVE_DICT_ENCODING: If TRUE, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values:
- TRUE
- FALSE
The default value is TRUE.
RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
PARTITION_TYPE: Partitioning scheme to use. Supported values:
- 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. Supported values:
- TRUE
- FALSE
The default value is FALSE.
VIEW_ID: ID of view of which this projection is a member. The default value is ”.
STRATEGY_DEFINITION: The tier strategy for the table and its columns.
COMPRESSION_CODEC: The default compression codec for the projection’s columns.
JOIN_WINDOW_FUNCTIONS: 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’.
JOIN_WINDOW_FUNCTIONS_THRESHOLD: 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 ”.
QUALIFY_FILTER: 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 default value is an empty Dictionary.

Definition at line 835 of file CreateProjection.cs.

◆ projection_name

string kinetica.CreateProjectionRequest.projection_name

getset

Name of the projection to be created, in [schema_name.

]table_name format, using standard name resolution rules and meeting table naming criteria.

Definition at line 425 of file CreateProjection.cs.

◆ table_name

string kinetica.CreateProjectionRequest.table_name

getset

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.

Definition at line 417 of file CreateProjection.cs.

The documentation for this class was generated from the following files:

_build/public-os_ubuntu24.04-arch_amd64-cc_gcc_13.3.0/install/Kinetica/Protocol/CreateProjection.cs
Kinetica/Protocol/CreateProjection.cs

​ Classes

​ Public Member Functions

​ Properties

​ Additional Inherited Members

​Detailed Description

​Constructor & Destructor Documentation

​◆ CreateProjectionRequest() [1/4]

​◆ CreateProjectionRequest() [2/4]

​◆ CreateProjectionRequest() [3/4]

​◆ CreateProjectionRequest() [4/4]

​Property Documentation

​◆ column_names

​◆ options

​◆ projection_name

​◆ table_name

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/4]

◆ CreateProjectionRequest() [2/4]

◆ CreateProjectionRequest() [3/4]

◆ CreateProjectionRequest() [4/4]

Property Documentation

◆ column_names

◆ options

◆ projection_name

◆ table_name