A set of input parameters for createProjection(const CreateProjectionRequest&) 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 createProjection(const CreateProjectionRequest&) 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 getRecordsByColumnRaw(const GetRecordsByColumnRequest&) 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.

Definition at line 39 of file create_projection.h.

Constructor & Destructor Documentation

◆ CreateProjectionRequest() [1/2]

gpudb::CreateProjectionRequest::CreateProjectionRequest ( )

inline

Constructs a CreateProjectionRequest object with default parameter values.

Definition at line 46 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]	projectionName_	Name of the projection to be created. Has the same naming restrictions as tables.
[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_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 ''. 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_limit: The number of records to keep. The default value is ''. 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_materialize_on_gpu: If true then the columns of the projection will be cached on the GPU. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_chunk_size: Indicates the chunk size to be used for this table. gpudb::create_projection_create_indexes: Comma-separated list of columns on which to create indexes on the output table. 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 table. gpudb::create_projection_true gpudb::create_projection_false The default value is gpudb::create_projection_false. gpudb::create_projection_view_id: view this projection is part of. The default value is ''.

Definition at line 172 of file create_projection.h.

Member Data Documentation

◆ columnNames

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

Definition at line 182 of file create_projection.h.

◆ options

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

Definition at line 183 of file create_projection.h.

◆ projectionName

std::string gpudb::CreateProjectionRequest::projectionName

Definition at line 181 of file create_projection.h.

◆ tableName

std::string gpudb::CreateProjectionRequest::tableName

Definition at line 180 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