A set of parameters for GPUdb::createProjection. More...

#include <gpudb/protocol/create_projection.h>

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

	CreateProjectionRequest (const std::string &tableName_, const std::string &projectionName_, const std::vector< std::string > &columnNames_, const std::map< std::string, std::string > &options_)
	Constructs a CreateProjectionRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
	Name of the existing table on which the projection is to be applied, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::string	projectionName
	Name of the projection to be created, in [ schema_name. ]table_name format, using standard name resolution rules and meeting table naming criteria. More...

std::vector< std::string >	columnNames
	List of columns from tableName to be included in the projection. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::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 GPUdb::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 tableName 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 49 of file create_projection.h.

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/2]

gpudb::CreateProjectionRequest::CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameters.

Definition at line 54 of file create_projection.h.

◆ CreateProjectionRequest() [2/2]

gpudb::CreateProjectionRequest::CreateProjectionRequest	(	const std::string &	tableName_,
		const std::string &	projectionName_,
		const std::vector< std::string > &	columnNames_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateProjectionRequest object with the specified parameters.

Parameters

[in]	tableName_	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.
[in]	projectionName_	Name of the projection to be created, in [schema_name.]table_name format, using standard name resolution rules and meeting table naming criteria.
[in]	columnNames_	List of columns from tableName_ to be included in the projection. Can include derived columns. Can be specified as aliased via the syntax 'column_name as alias'.
[in]	options_	Optional parameters. create_projection_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of projectionName_. 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: create_projection_true create_projection_false The default value is create_projection_false. create_projection_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of projectionName_ and use GPUdb::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 ''. create_projection_expression: An optional filter expression to be applied to the source table prior to the projection. The default value is ''. create_projection_is_replicated: If true then the projection will be replicated even if the source table is not. Supported values: create_projection_true create_projection_false The default value is create_projection_false. create_projection_offset: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'. create_projection_limit: The number of records to keep. The default value is '-9999'. create_projection_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 columnNames_. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. create_projection_chunk_size: Indicates the number of records per chunk to be used for this projection. create_projection_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this projection. create_projection_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this projection. create_projection_create_indexes: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in columnNames_. If any alias is given for any column name, the alias must be used, rather than the original column name. create_projection_ttl: Sets the TTL of the projection specified in projectionName_. create_projection_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames_. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''. create_projection_persist: If true, then the projection specified in projectionName_ 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: create_projection_true create_projection_false The default value is create_projection_false. create_projection_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values: create_projection_true create_projection_false The default value is create_projection_true. create_projection_retain_partitions: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values: create_projection_true create_projection_false The default value is create_projection_false. create_projection_partition_type: Partitioning scheme to use. Supported values: create_projection_RANGE: Use range partitioning. create_projection_INTERVAL: Use interval partitioning. create_projection_LIST: Use list partitioning. create_projection_HASH: Use hash partitioning. create_projection_SERIES: Use series partitioning. create_projection_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. create_projection_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. create_projection_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: create_projection_true create_projection_false The default value is create_projection_false. create_projection_view_id: ID of view of which this projection is a member. The default value is ''. create_projection_strategy_definition: The tier strategy for the table and its columns. create_projection_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'. create_projection_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 ''. The default value is an empty map.

Definition at line 411 of file create_projection.h.

Member Data Documentation

◆ columnNames

std::vector<std::string> gpudb::CreateProjectionRequest::columnNames

List of columns from tableName 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 444 of file create_projection.h.

◆ options

std::map<std::string, std::string> gpudb::CreateProjectionRequest::options

Optional parameters.

create_projection_create_temp_table: If true, a unique temporary table name will be generated in the sys_temp schema and used in place of projectionName. 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:
- create_projection_true
- create_projection_false
The default value is create_projection_false.
create_projection_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of projectionName and use GPUdb::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 ''.
create_projection_expression: An optional filter expression to be applied to the source table prior to the projection. The default value is ''.
create_projection_is_replicated: If true then the projection will be replicated even if the source table is not. Supported values:
- create_projection_true
- create_projection_false
The default value is create_projection_false.
create_projection_offset: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'.
create_projection_limit: The number of records to keep. The default value is '-9999'.
create_projection_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 columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
create_projection_chunk_size: Indicates the number of records per chunk to be used for this projection.
create_projection_chunk_column_max_memory: Indicates the target maximum data size for each column in a chunk to be used for this projection.
create_projection_chunk_max_memory: Indicates the target maximum data size for all columns in a chunk to be used for this projection.
create_projection_create_indexes: Comma-separated list of columns on which to create indexes on the projection. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name.
create_projection_ttl: Sets the TTL of the projection specified in projectionName.
create_projection_shard_key: Comma-separated list of the columns to be sharded on; e.g. 'column1, column2'. The columns specified must be present in columnNames. If any alias is given for any column name, the alias must be used, rather than the original column name. The default value is ''.
create_projection_persist: If true, then the projection specified in projectionName 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:
- create_projection_true
- create_projection_false
The default value is create_projection_false.
create_projection_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. Supported values:
- create_projection_true
- create_projection_false
The default value is create_projection_true.
create_projection_retain_partitions: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
- create_projection_true
- create_projection_false
The default value is create_projection_false.
create_projection_partition_type: Partitioning scheme to use. Supported values:
- create_projection_RANGE: Use range partitioning.
- create_projection_INTERVAL: Use interval partitioning.
- create_projection_LIST: Use list partitioning.
- create_projection_HASH: Use hash partitioning.
- create_projection_SERIES: Use series partitioning.
create_projection_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.
create_projection_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.
create_projection_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:
- create_projection_true
- create_projection_false
The default value is create_projection_false.
create_projection_view_id: ID of view of which this projection is a member. The default value is ''.
create_projection_strategy_definition: The tier strategy for the table and its columns.
create_projection_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'.
create_projection_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 ''.

The default value is an empty map.

Definition at line 672 of file create_projection.h.

◆ projectionName

std::string gpudb::CreateProjectionRequest::projectionName

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 437 of file create_projection.h.

◆ tableName

std::string gpudb::CreateProjectionRequest::tableName

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 427 of file create_projection.h.

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

gpudb/protocol/create_projection.h

Public Member Functions

Public Attributes