gpudb::AlterTableRequest Struct Reference

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 or collection. Available modifications include:

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

Making a table protected or not. Protected tables need the admin password to be sent in a clearTable(const ClearTableRequest&) const to delete the table. This can be applied to child tables or collections or views.

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.

Allowing homogeneous child tables. This only applies to collections.

Definition at line 39 of file alter_table.h.

Constructor & Destructor Documentation

gpudb::AlterTableRequest::AlterTableRequest ( )

inline

Constructs an AlterTableRequest object with default parameter values.

Definition at line 46 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 a valid table or collection in GPUdb.
[in]	action	Modification operation to be applied to the table or collection Values: 'create_index', 'delete_index', 'allow_homogeneous_tables', 'protected', 'ttl'.
[in]	value	The value of the modification. May be a column name, 'true' or 'false', or a time-to-live depending on action.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 72 of file alter_table.h.

Member Data Documentation

std::string gpudb::AlterTableRequest::action

Definition at line 81 of file alter_table.h.

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

Definition at line 83 of file alter_table.h.

std::string gpudb::AlterTableRequest::tableName

Definition at line 80 of file alter_table.h.

std::string gpudb::AlterTableRequest::value

Definition at line 82 of file alter_table.h.

---

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

• gpudb/protocol/alter_table.h