GPUdb C++ API  Version 6.2.0.3
gpudb::AlterTableResponse Struct Reference

A set of output parameters for alterTable(const AlterTableRequest&) const. More...

#include <gpudb/protocol/alter_table.h>

Public Member Functions

 AlterTableResponse ()
 Constructs an AlterTableResponse object with default parameter values. More...
 

Public Attributes

std::string tableName
 
std::string action
 
std::string value
 
std::string typeId
 
std::string typeDefinition
 
std::map< std::string, std::vector< std::string > > properties
 
std::string label
 

Detailed Description

A set of output 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. 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.

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 391 of file alter_table.h.

Constructor & Destructor Documentation

◆ AlterTableResponse()

gpudb::AlterTableResponse::AlterTableResponse ( )
inline

Constructs an AlterTableResponse object with default parameter values.

Definition at line 398 of file alter_table.h.

Member Data Documentation

◆ action

std::string gpudb::AlterTableResponse::action

Definition at line 410 of file alter_table.h.

◆ label

std::string gpudb::AlterTableResponse::label

Definition at line 415 of file alter_table.h.

◆ properties

std::map<std::string, std::vector<std::string> > gpudb::AlterTableResponse::properties

Definition at line 414 of file alter_table.h.

◆ tableName

std::string gpudb::AlterTableResponse::tableName

Definition at line 409 of file alter_table.h.

◆ typeDefinition

std::string gpudb::AlterTableResponse::typeDefinition

Definition at line 413 of file alter_table.h.

◆ typeId

std::string gpudb::AlterTableResponse::typeId

Definition at line 412 of file alter_table.h.

◆ value

std::string gpudb::AlterTableResponse::value

Definition at line 411 of file alter_table.h.


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