GPUdb C++ API  Version 7.0.19.0
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
gpudb::AlterTableColumnsRequest Struct Reference

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

#include <gpudb/protocol/alter_table_columns.h>

Public Member Functions

 AlterTableColumnsRequest ()
 Constructs an AlterTableColumnsRequest object with default parameter values. More...
 
 AlterTableColumnsRequest (const std::string &tableName_, const std::vector< std::map< std::string, std::string > > &columnAlterations_, const std::map< std::string, std::string > &options_)
 Constructs an AlterTableColumnsRequest object with the specified parameters. More...
 

Public Attributes

std::string tableName
 
std::vector< std::map
< std::string, std::string > > 
columnAlterations
 
std::map< std::string,
std::string > 
options
 

Detailed Description

A set of input parameters for const.

Apply various modifications to columns in a table, view. 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.

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 34 of file alter_table_columns.h.

Constructor & Destructor Documentation

gpudb::AlterTableColumnsRequest::AlterTableColumnsRequest ( )
inline

Constructs an AlterTableColumnsRequest object with default parameter values.

Definition at line 41 of file alter_table_columns.h.

gpudb::AlterTableColumnsRequest::AlterTableColumnsRequest ( const std::string &  tableName_,
const std::vector< std::map< std::string, std::string > > &  columnAlterations_,
const std::map< std::string, std::string > &  options_ 
)
inline

Constructs an AlterTableColumnsRequest object with the specified parameters.

Parameters
[in]tableName_Table on which the operation will be performed. Must be an existing table or view.
[in]columnAlterations_list of alter table add/delete/change column requests - all for the same table. each request is a map that includes 'column_name', 'action' and the options specific for the action, note that the same options as in alter table requests but in the same map as the column name and the action. For example: [{'column_name':'col_1','action':'change_column','rename_column':'col_2'}, {'column_name':'col_1','action':'add_column', 'type':'int','default_value':'1'} ]
[in]options_Optional parameters.

Definition at line 72 of file alter_table_columns.h.

Member Data Documentation

std::vector<std::map<std::string, std::string> > gpudb::AlterTableColumnsRequest::columnAlterations

Definition at line 80 of file alter_table_columns.h.

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

Definition at line 81 of file alter_table_columns.h.

std::string gpudb::AlterTableColumnsRequest::tableName

Definition at line 79 of file alter_table_columns.h.


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