A set of input parameters for alterTable(const AlterTableRequest&) 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 alterTable(const AlterTableRequest&) const.

Apply various modifications to a table, view, or collection. The available modifications include the following:

Create or delete an index on a particular column. This can speed up certain operations when using expressions containing equality or relational operators on indexed columns. This only applies to tables.

Set the time-to-live (TTL). This can be applied to tables, views, or collections. When applied to collections, every contained table & view that is not protected will have its TTL set to the given value.

Set the global access mode (i.e. locking) for a table. The mode can be set to 'no_access', 'read_only', 'write_only' or 'read_write'.

Change the protection mode to prevent or allow automatic expiration. This can be applied to tables, views, and collections.

Allow homogeneous tables within a collection.

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

Set or unset compression for a column.

Definition at line 53 of file alter_table.h.

Constructor & Destructor Documentation

◆ AlterTableRequest() [1/2]

gpudb::AlterTableRequest::AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameter values.

Definition at line 60 of file alter_table.h.

◆ AlterTableRequest() [2/2]

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_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_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_move_to_collection: Moves a table into a collection value. 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_rename_table: Renames a table, view or collection to value. Has the same naming restrictions as tables. gpudb::alter_table_ttl: Sets the TTL of the table, view, or collection specified in tableName. gpudb::alter_table_add_column: Adds the column specified in value to the table specified in tableName. Use column_type and column_properties in options to set the column's type and properties, respectively. gpudb::alter_table_change_column: Changes type and properties of the column specified in value. Use column_type and column_properties in options to set the column's type and properties, respectively. gpudb::alter_table_set_column_compression: Modifies the compression setting on the column specified in value. gpudb::alter_table_delete_column: Deletes the column specified in value from the table specified in tableName. gpudb::alter_table_create_foreign_key: Creates a foreign key using the format 'source_column references target_table(primary_key_column) [ as <foreign_key_name> ]'. gpudb::alter_table_delete_foreign_key: Deletes a foreign key. The value should be the <foreign_key_name> specified when creating the key or the complete string used to define it. gpudb::alter_table_set_global_access_mode: Sets the global access mode (i.e. locking) for the table specified in tableName. Specify the access mode in value. Valid modes are 'no_access', 'read_only', 'write_only' and 'read_write'.
[in]	value_	The value of the modification. May be a column name, 'true' or 'false', a TTL, or the global access mode depending on action.
[in]	options_	Optional parameters. gpudb::alter_table_column_default_value: When adding a column, set a default value for existing records. 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_compression_type: When setting column compression (set_column_compression for action), compression type to use: none (to use no compression) or a valid compression type. gpudb::alter_table_none gpudb::alter_table_snappy gpudb::alter_table_lz4 gpudb::alter_table_lz4hc The default value is gpudb::alter_table_snappy. gpudb::alter_table_copy_values_from_column: When adding or changing a column, enter a column name from the same table being altered to use as a source for the column being added/changed; values will be copied from this source column into the new/modified column. gpudb::alter_table_rename_column: When changing a column, specify new column name. gpudb::alter_table_validate_change_column: When changing a column, validate the change before applying it. 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 The default value is gpudb::alter_table_true.

Definition at line 212 of file alter_table.h.

Member Data Documentation

◆ action

std::string gpudb::AlterTableRequest::action

Definition at line 221 of file alter_table.h.

◆ options

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

Definition at line 223 of file alter_table.h.

◆ tableName

std::string gpudb::AlterTableRequest::tableName

Definition at line 220 of file alter_table.h.

◆ value

std::string gpudb::AlterTableRequest::value

Definition at line 222 of file alter_table.h.

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

gpudb/protocol/alter_table.h

Public Member Functions

Public Attributes