gpudb::AlterTableRequest Struct Reference

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

#include <gpudb/protocol/alter_table.h>

Public Member Functions
	AlterTableRequest ()
	Constructs an AlterTableRequest object with default parameter values. More...
	AlterTableRequest (const std::string &tableName_, const std::string &action_, const std::string &value_, const std::map< std::string, std::string > &options_)
	Constructs an AlterTableRequest object with the specified parameters. More...

Public Attributes
std::string	tableName
std::string	action
std::string	value
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Apply various modifications to a table or collection. Available modifications include:

Creating or deleting an index on a particular column. This can speed up certain search queries (such as const, const, const) when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Setting the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every table & view within the collection will have its TTL set to the given value.

Making a table protected or not. Protected tables have their TTLs set to not automatically expire. This can be applied to tables, views, and collections.

Allowing homogeneous tables within a collection.

Managing a table's columns–a column can be added or removed, or have its type modified.

Definition at line 41 of file alter_table.h.

Constructor & Destructor Documentation

gpudb::AlterTableRequest::AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameter values.

Definition at line 48 of file alter_table.h.

gpudb::AlterTableRequest::AlterTableRequest ( const std::string &  tableName_, const std::string &  action_, const std::string &  value_, const std::map< std::string, std::string > &  options_  )

inline

Constructs an AlterTableRequest object with the specified parameters.

Parameters

[in]	tableName_	Table on which the operation will be performed. Must be an existing table, view, or collection.
[in]	action_	Modification operation to be applied gpudb::alter_table_create_index: Creates an index on the column name specified in value. If this column is already indexed, an error will be returned. gpudb::alter_table_delete_index: Deletes an existing index on the column name specified in value. If this column does not have indexing turned on, an error will be returned. gpudb::alter_table_allow_homogeneous_tables: Sets whether homogeneous tables are allowed in the given collection. This action is only valid if tableName is a collection. The value must be either 'true' or 'false'. gpudb::alter_table_protected: Sets whether the given tableName should be protected or not. The value must be either 'true' or 'false'. gpudb::alter_table_ttl: Sets the TTL of the table, view, or collection specified in tableName. The value must be the desired TTL in minutes. gpudb::alter_table_add_column: Add a column value to the table. set the column properties in options gpudb::alter_table_delete_column: Delete a column value from the table gpudb::alter_table_change_column: Change properties of a column value in the table. set the column properties in options gpudb::alter_table_rename_table: Rename a table, view or collection to value. Has the same naming restrictions as tables.
[in]	value_	The value of the modification. May be a column name, 'true' or 'false', or a TTL depending on action.
[in]	options_	Optional parameters. gpudb::alter_table_column_default_value: when adding a column: set a default value, for existing data. gpudb::alter_table_column_properties: when adding or changing a column: set the column properties (strings, separated by a comma: data, store_only, text_search, char8, int8 etc). gpudb::alter_table_column_type: when adding or changing a column: set the column type (strings, separated by a comma: int, double, string, null etc). gpudb::alter_table_validate_change_column: Validate the type change before applying column_change request. Default is true (if option is missing). If true, then validate all values. A value too large (or too long) for the new type will prevent any change. If false, then when a value is too large or long, it will be truncated. gpudb::alter_table_true: true gpudb::alter_table_false: false gpudb::alter_table_copy_values_from_column: when adding or changing a column: enter column name - from where to copy values.

Definition at line 141 of file alter_table.h.

Member Data Documentation

std::string gpudb::AlterTableRequest::action

Definition at line 150 of file alter_table.h.

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

Definition at line 152 of file alter_table.h.

std::string gpudb::AlterTableRequest::tableName

Definition at line 149 of file alter_table.h.

std::string gpudb::AlterTableRequest::value

Definition at line 151 of file alter_table.h.

---

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

• gpudb/protocol/alter_table.h