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

#include <gpudb/protocol/alter_schema.h>

Public Member Functions
	AlterSchemaRequest ()
	Constructs an AlterSchemaRequest object with default parameters. More...

	AlterSchemaRequest (const std::string &schemaName_, const std::string &action_, const std::string &value_, const std::map< std::string, std::string > &options_)
	Constructs an AlterSchemaRequest object with the specified parameters. More...

Public Attributes
std::string	schemaName
	Name of the schema to be altered. More...

std::string	action
	Modification operation to be applied. More...

std::string	value
	The value of the modification, depending on action. More...

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

Detailed Description

A set of parameters for GPUdb::alterSchema.

Used to change the name of a SQL-style schema, specified in schemaName.

Definition at line 20 of file alter_schema.h.

Constructor & Destructor Documentation

◆ AlterSchemaRequest() [1/2]

gpudb::AlterSchemaRequest::AlterSchemaRequest ( )

inline

Constructs an AlterSchemaRequest object with default parameters.

Definition at line 25 of file alter_schema.h.

◆ AlterSchemaRequest() [2/2]

gpudb::AlterSchemaRequest::AlterSchemaRequest	(	const std::string &	schemaName_,
		const std::string &	action_,
		const std::string &	value_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AlterSchemaRequest object with the specified parameters.

Parameters

[in]	schemaName_	Name of the schema to be altered.
[in]	action_	Modification operation to be applied. Supported values: alter_schema_add_comment: Adds a comment describing the schema alter_schema_rename_schema: Renames a schema to value_. Has the same naming restrictions as tables.
[in]	value_	The value of the modification, depending on action_. For now the only value of action_ is rename_schema. In this case the value is the new name of the schema.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 59 of file alter_schema.h.

Member Data Documentation

◆ action

std::string gpudb::AlterSchemaRequest::action

Modification operation to be applied.

Supported values:

alter_schema_add_comment: Adds a comment describing the schema
alter_schema_rename_schema: Renames a schema to value. Has the same naming restrictions as tables.

Definition at line 85 of file alter_schema.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 98 of file alter_schema.h.

◆ schemaName

std::string gpudb::AlterSchemaRequest::schemaName

Name of the schema to be altered.

Definition at line 70 of file alter_schema.h.

◆ value

std::string gpudb::AlterSchemaRequest::value

The value of the modification, depending on action.

For now the only value of action is rename_schema. In this case the value is the new name of the schema.

Definition at line 93 of file alter_schema.h.

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

gpudb/protocol/alter_schema.h

Public Member Functions

Public Attributes