com.gpudb.protocol

Class CreateProjectionRequest

java.lang.Object

com.gpudb.protocol.CreateProjectionRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class CreateProjectionRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.createProjection(CreateProjectionRequest).

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.getRecordsByColumnRaw(GetRecordsByColumnRequest).

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

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CreateProjectionRequest.Options Optional parameters.

Constructor Summary

Constructors

Constructor and Description
CreateProjectionRequest() Constructs a CreateProjectionRequest object with default parameters.
CreateProjectionRequest(String tableName, String projectionName, List<String> columnNames, Map<String,String> options) Constructs a CreateProjectionRequest object with the specified parameters.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
List<String>	getColumnNames()
Map<String,String>	getOptions()
String	getProjectionName()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
CreateProjectionRequest	setColumnNames(List<String> columnNames)
CreateProjectionRequest	setOptions(Map<String,String> options)
CreateProjectionRequest	setProjectionName(String projectionName)
CreateProjectionRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

CreateProjectionRequest

public CreateProjectionRequest()

Constructs a CreateProjectionRequest object with default parameters.

CreateProjectionRequest

public CreateProjectionRequest(String tableName,
                               String projectionName,
                               List<String> columnNames,
                               Map<String,String> options)

Constructs a CreateProjectionRequest object with the specified parameters.

Parameters:

tableName - Name of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.

projectionName - Name of the projection to be created. Has the same naming restrictions as tables.

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

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 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 ''.
• MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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 columnNames. 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 projectionName.
• 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 ''.
• 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:
  • 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. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: ID of view of which this projection is a member. The default value is ''.

The default value is an empty Map.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

Name of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.

setTableName

public CreateProjectionRequest setTableName(String tableName)

Parameters:

tableName - Name of the existing table on which the projection is to be applied. An empty table name creates a projection from a single-row virtual table, where columns specified should be constants or constant expressions.

Returns:

this to mimic the builder pattern.

getProjectionName

public String getProjectionName()

Returns:

Name of the projection to be created. Has the same naming restrictions as tables.

setProjectionName

public CreateProjectionRequest setProjectionName(String projectionName)

Parameters:

projectionName - Name of the projection to be created. Has the same naming restrictions as tables.

Returns:

this to mimic the builder pattern.

getColumnNames

public List<String> getColumnNames()

Returns:

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

setColumnNames

public CreateProjectionRequest setColumnNames(List<String> columnNames)

Parameters:

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

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

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 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 ''.
• MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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 columnNames. 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 projectionName.
• 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 ''.
• 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:
  • 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. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: ID of view of which this projection is a member. The default value is ''.

The default value is an empty Map.

setOptions

public CreateProjectionRequest setOptions(Map<String,String> options)

Parameters:

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 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 ''.
• MATERIALIZE_ON_GPU: No longer used. See Resource Management Concepts for information about how resources are managed, Tier Strategy Concepts for how resources are targeted for VRAM, and Tier Strategy Usage for how to specify a table's priority in VRAM. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• 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 columnNames. 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 projectionName.
• 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 ''.
• 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:
  • 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. Supported values:
  • TRUE
  • FALSE
  The default value is TRUE.
• RETAIN_PARTITIONS: Determines whether the created projection will retain the partitioning scheme from the source table. Supported values:
  • TRUE
  • FALSE
  The default value is FALSE.
• VIEW_ID: ID of view of which this projection is a member. The default value is ''.

The default value is an empty Map.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
                Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object