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

#include <gpudb/protocol/alter_table_metadata.h>

Public Member Functions
	AlterTableMetadataRequest ()
	Constructs an AlterTableMetadataRequest object with default parameters. 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
	Names of the tables whose metadata will be updated, in [ schema_name. ]table_name format, using standard name resolution rules. More...

std::map< std::string, std::string >	metadataMap
	A map which contains the metadata of the tables that are to be updated. More...

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

Detailed Description

A set of parameters for GPUdb::alterTableMetadata.

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

◆ AlterTableMetadataRequest() [1/2]

gpudb::AlterTableMetadataRequest::AlterTableMetadataRequest ( )

inline

Constructs an AlterTableMetadataRequest object with default parameters.

Definition at line 27 of file alter_table_metadata.h.

◆ AlterTableMetadataRequest() [2/2]

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, in [schema_name.]table_name format, using standard name resolution rules. All specified tables must exist, or an error will be returned.
[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. The default value is an empty map.

Definition at line 55 of file alter_table_metadata.h.

Member Data Documentation

◆ metadataMap

std::map<std::string, std::string> gpudb::AlterTableMetadataRequest::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.

Definition at line 77 of file alter_table_metadata.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 82 of file alter_table_metadata.h.

◆ tableNames

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

Names of the tables whose metadata will be updated, in [ schema_name. ]table_name format, using standard name resolution rules.

All specified tables must exist, or an error will be returned.

Definition at line 69 of file alter_table_metadata.h.

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

gpudb/protocol/alter_table_metadata.h

Public Member Functions

Public Attributes