Kinetica C# API  Version 7.1.10.0
 All Classes Namespaces Files Functions Variables Enumerations Enumerator Properties Pages
kinetica.CreateProjectionRequest Class Reference

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, in [schema_name. More...
 
string projection_name [get, set]
 Name of the projection to be created, in [schema_name. 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.
If 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 56 of file CreateProjection.cs.

Constructor & Destructor Documentation

kinetica.CreateProjectionRequest.CreateProjectionRequest ( )
inline

Constructs a CreateProjectionRequest object with default parameters.

Definition at line 928 of file CreateProjection.cs.

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_nameName 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_nameName of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
column_namesList 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'.
optionsOptional parameters.
  • CREATE_TEMP_TABLE: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of . 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: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of 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 ''.
  • 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: 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 . 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.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. 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: 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: The default value is TRUE.
  • RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is FALSE.
  • PARTITION_TYPE: Partitioning scheme to use. Supported values:
  • 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: 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.
The default value is an empty Dictionary.

Definition at line 1236 of file CreateProjection.cs.

Property Documentation

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 636 of file CreateProjection.cs.

IDictionary<string, string> kinetica.CreateProjectionRequest.options = new List<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 . 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: The default value is FALSE.
  • COLLECTION_NAME: [DEPRECATED–please specify the containing schema for the projection as part of 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 ''.
  • 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: 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 . 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.
  • CREATE_INDEXES: Comma-separated list of columns on which to create indexes on the projection. 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: 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: The default value is TRUE.
  • RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: The default value is FALSE.
  • PARTITION_TYPE: Partitioning scheme to use. Supported values:
  • 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: 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.

The default value is an empty Dictionary.

Definition at line 923 of file CreateProjection.cs.

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 630 of file CreateProjection.cs.

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 622 of file CreateProjection.cs.


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