GPUdb C++ API  Version 5.2.0.0
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
 

Detailed Description

A set of output 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 171 of file alter_table.h.

Constructor & Destructor Documentation

gpudb::AlterTableResponse::AlterTableResponse ( )
inline

Constructs an AlterTableResponse object with default parameter values.

Definition at line 178 of file alter_table.h.

Member Data Documentation

std::string gpudb::AlterTableResponse::action

Definition at line 186 of file alter_table.h.

std::string gpudb::AlterTableResponse::tableName

Definition at line 185 of file alter_table.h.

std::string gpudb::AlterTableResponse::value

Definition at line 187 of file alter_table.h.


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