gpudb::AlterTableMetadataRequest Struct Reference

A set of input parameters for alterTableMetadata(const AlterTableMetadataRequest&) const. More...

#include <gpudb/protocol/alter_table_metadata.h>

Public Member Functions
	AlterTableMetadataRequest ()
	Constructs an AlterTableMetadataRequest object with default parameter values. More...
	AlterTableMetadataRequest (const std::vector< std::string > &tableNames, const std::map< std::string, std::string > &metadataMap, const std::map< std::string, std::string > &options)
	Constructs an AlterTableMetadataRequest object with the specified parameters. More...

Public Attributes
std::vector< std::string >	tableNames
std::map< std::string, std::string >	metadataMap
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for alterTableMetadata(const AlterTableMetadataRequest&) const.

Updates (adds or changes) metadata for tables. The metadata key and values must both be strings. This is an easy way to annotate whole tables rather than single records within tables. Some examples of metadata are owner of the table, table creation timestamp etc.

Definition at line 21 of file alter_table_metadata.h.

Constructor & Destructor Documentation

gpudb::AlterTableMetadataRequest::AlterTableMetadataRequest ( )

inline

Constructs an AlterTableMetadataRequest object with default parameter values.

Definition at line 28 of file alter_table_metadata.h.

gpudb::AlterTableMetadataRequest::AlterTableMetadataRequest ( const std::vector< std::string > &  tableNames, const std::map< std::string, std::string > &  metadataMap, const std::map< std::string, std::string > &  options  )

inline

Constructs an AlterTableMetadataRequest object with the specified parameters.

Parameters

[in]	tableNames	Names of the tables whose metadata will be updated. All specified tables must exist in GPUdb, or GPUdb will return an error.
[in]	metadataMap	A map which contains the metadata of the tables that are to be updated. Note that only one map is provided for all the tables; so the change will be applied to every table. If the provided map is empty, then all existing metadata for the table(s) will be cleared.
[in]	options	Optional parameters. Default value is an empty std::map.

Definition at line 53 of file alter_table_metadata.h.

Member Data Documentation

std::map<std::string, std::string> gpudb::AlterTableMetadataRequest::metadataMap

Definition at line 61 of file alter_table_metadata.h.

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

Definition at line 62 of file alter_table_metadata.h.

std::vector<std::string> gpudb::AlterTableMetadataRequest::tableNames

Definition at line 60 of file alter_table_metadata.h.

---

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

• gpudb/protocol/alter_table_metadata.h