A set of parameters for GPUdb::alterTableColumns. More...

#include <gpudb/protocol/alter_table_columns.h>

Public Member Functions
	AlterTableColumnsRequest ()
	Constructs an AlterTableColumnsRequest object with default parameters. 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
	Table on which the operation will be performed. More...

std::vector< std::map< std::string, std::string > >	columnAlterations
	List of alter table add/delete/change column requests - all for the same table. More...

std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::alterTableColumns.

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, including whether it is dictionary encoded or not.

Definition at line 30 of file alter_table_columns.h.

Constructor & Destructor Documentation

◆ AlterTableColumnsRequest() [1/2]

gpudb::AlterTableColumnsRequest::AlterTableColumnsRequest ( )

inline

Constructs an AlterTableColumnsRequest object with default parameters.

Definition at line 36 of file alter_table_columns.h.

◆ AlterTableColumnsRequest() [2/2]

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 [schema_name.]table_name format, using standard name resolution rules.
[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 66 of file alter_table_columns.h.

Member Data Documentation

◆ columnAlterations

std::vector<std::map<std::string, std::string> > gpudb::AlterTableColumnsRequest::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'}]

Definition at line 90 of file alter_table_columns.h.

◆ options

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

Optional parameters.

Definition at line 95 of file alter_table_columns.h.

◆ tableName

std::string gpudb::AlterTableColumnsRequest::tableName

Table on which the operation will be performed.

Must be an existing table or view, in [ schema_name. ]table_name format, using standard name resolution rules.

Definition at line 79 of file alter_table_columns.h.

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

gpudb/protocol/alter_table_columns.h

Public Member Functions

Public Attributes