gpudb::CreateProjectionRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/create_projection.h>

Public Member Functions
	CreateProjectionRequest ()
	Constructs a CreateProjectionRequest object with default parameter values. 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
std::string	projectionName
std::vector< std::string >	columnNames
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

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

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

Constructor & Destructor Documentation

gpudb::CreateProjectionRequest::CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameter values.

Definition at line 60 of file create_projection.h.

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. gpudb::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. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_collection_name: [DEPRECATED–please specify the containing schema for the projection as part of projectionName 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 ''. gpudb::create_projection_expression: An optional filter expression to be applied to the source table prior to the projection. The default value is ''. gpudb::create_projection_is_replicated: If true then the projection will be replicated even if the source table is not. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_offset: The number of initial results to skip (this can be useful for paging through the results). The default value is '0'. gpudb::create_projection_limit: The number of records to keep. The default value is '-9999'. gpudb::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 ''. gpudb::create_projection_chunk_size: Indicates the number of records per chunk to be used for this projection. gpudb::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. gpudb::create_projection_ttl: Sets the TTL of the projection specified in projectionName. gpudb::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 ''. gpudb::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. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_preserve_dict_encoding: If true, then columns that were dict encoded in the source table will be dict encoded in the projection. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_true. gpudb::create_projection_retain_partitions: Determines whether the created projection will retain the partitioning scheme from the source table. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_partition_type: Partitioning scheme to use. gpudb::create_projection_RANGE: Use range partitioning. gpudb::create_projection_INTERVAL: Use interval partitioning. gpudb::create_projection_LIST: Use list partitioning. gpudb::create_projection_HASH: Use hash partitioning. gpudb::create_projection_SERIES: Use series partitioning. gpudb::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. gpudb::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. gpudb::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. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_view_id: ID of view of which this projection is a member. The default value is ''. gpudb::create_projection_strategy_definition: The tier strategy for the table and its columns.

Definition at line 286 of file create_projection.h.

Member Data Documentation

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

Definition at line 296 of file create_projection.h.

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

Definition at line 297 of file create_projection.h.

std::string gpudb::CreateProjectionRequest::projectionName

Definition at line 295 of file create_projection.h.

std::string gpudb::CreateProjectionRequest::tableName

Definition at line 294 of file create_projection.h.

---

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

• gpudb/protocol/create_projection.h