GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
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, view, or collection. The available modifications include the following:

Manage a table's columns–a column can be added, removed, or have its type and properties modified, including whether it is compressed or not.

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.

Create or delete a foreign key on a particular column.

Manage a range-partitioned or a manual list-partitioned table's partitions.

Set (or reset) the tier strategy of a table or view.

Refresh and manage the refresh mode of a materialized view.

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. This setting trumps any role-based access controls that may be in place; e.g., a user with write access to a table marked read-only will not be able to insert records into it. The mode can be set to read-only, write-only, read/write, and no access.

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

Definition at line 72 of file alter_table.h.

Constructor & Destructor Documentation

gpudb::AlterTableRequest::AlterTableRequest ( )
inline

Constructs an AlterTableRequest object with default parameter values.

Definition at line 79 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
[in]value_The value of the modification, depending on action. For example, if action is add_column, this would be the column name; while the column's definition would be covered by the column_type, column_properties, column_default_value, and add_column_expression in options. If action is ttl, it would be the number of minutes for the new TTL. If action is refresh, this field would be blank.
[in]options_Optional parameters.

Definition at line 384 of file alter_table.h.

Member Data Documentation

std::string gpudb::AlterTableRequest::action

Definition at line 393 of file alter_table.h.

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

Definition at line 395 of file alter_table.h.

std::string gpudb::AlterTableRequest::tableName

Definition at line 392 of file alter_table.h.

std::string gpudb::AlterTableRequest::value

Definition at line 394 of file alter_table.h.


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