A set of parameters for Kinetica.createProjection(string,string,IList<string>,IDictionary<string, string>). More...

Inheritance diagram for kinetica.CreateProjectionRequest:

Collaboration diagram for kinetica.CreateProjectionRequest:

Classes
struct	Options
	Optional parameters. More...

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

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

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

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

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

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

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

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

IList< string >	column_names `[get, set]`
	List of columns from to be included in the projection. More...

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

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

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. More...

Detailed Description

A set of parameters for Kinetica.createProjection(string,string,IList<string>,IDictionary<string, string>).

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(string,IList<string>,long,long,IDictionary<string, string>).
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.

Definition at line 41 of file CreateProjection.cs.

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/2]

kinetica.CreateProjectionRequest.CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameters.

Definition at line 508 of file CreateProjection.cs.

◆ CreateProjectionRequest() [2/2]

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.
projection_name	Name of the projection to be created. Has the same naming restrictions as tables.
column_names	List of columns from 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. COLLECTION_NAME: Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. 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. LIMIT: The number of records to keep. The default value is ''. 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 . If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. MATERIALIZE_ON_GPU: If true then the columns of the projection will be cached on the GPU. Supported values: TRUE FALSE The default value is FALSE. CHUNK_SIZE: Indicates the chunk size to be used for this table. CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in . 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 . SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in . 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 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 table. Supported values: TRUE FALSE The default value is FALSE. VIEW_ID: view this projection is part of. The default value is ''. The default value is an empty Dictionary.

Definition at line 680 of file CreateProjection.cs.

Property Documentation

◆ column_names

IList<string> kinetica.CreateProjectionRequest.column_names

getset

List of columns from 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 345 of file CreateProjection.cs.

◆ options

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

getset

Optional parameters.

COLLECTION_NAME: Name of a collection to which the projection is to be assigned as a child. If the collection provided is non-existent, the collection will be automatically created. If empty, then the projection will be at the top level. 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.
LIMIT: The number of records to keep. The default value is ''.
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 . If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
MATERIALIZE_ON_GPU: If true then the columns of the projection will be cached on the GPU. Supported values:
- TRUE
- FALSE
The default value is FALSE.
CHUNK_SIZE: Indicates the chunk size to be used for this table.
CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the output table. The columns specified must be present in . 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 .
SHARD_KEY: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in . 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 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 table. Supported values:
- TRUE
- FALSE
The default value is FALSE.
VIEW_ID: view this projection is part of. The default value is ''.

The default value is an empty Dictionary.

Definition at line 503 of file CreateProjection.cs.

◆ projection_name

string kinetica.CreateProjectionRequest.projection_name

getset

Name of the projection to be created.

Has the same naming restrictions as tables.

Definition at line 339 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.

Definition at line 334 of file CreateProjection.cs.

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

Kinetica/Protocol/CreateProjection.cs

Classes

Public Member Functions

Properties

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/2]

◆ CreateProjectionRequest() [2/2]

Property Documentation

◆ column_names

◆ options

◆ projection_name

◆ table_name