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

#include <gpudb/protocol/alter_user.h>

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

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

Public Attributes
std::string	name
	Name of the user to be altered. More...

std::string	action
	Modification operation to be applied to the user. 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::alterUser.

Alters a user.

Definition at line 17 of file alter_user.h.

Constructor & Destructor Documentation

◆ AlterUserRequest() [1/2]

gpudb::AlterUserRequest::AlterUserRequest ( )

inline

Constructs an AlterUserRequest object with default parameters.

Definition at line 22 of file alter_user.h.

◆ AlterUserRequest() [2/2]

gpudb::AlterUserRequest::AlterUserRequest	(	const std::string &	name_,
		const std::string &	action_,
		const std::string &	value_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs an AlterUserRequest object with the specified parameters.

Parameters

[in]	name_	Name of the user to be altered. Must be an existing user.
[in]	action_	Modification operation to be applied to the user. Supported values: alter_user_set_activated: Is the user allowed to login. alter_user_true: User may login alter_user_false: User may not login alter_user_set_comment: Sets the comment for an internal user. alter_user_set_default_schema: Set the default_schema for an internal user. An empty string means the user will have no default schema. alter_user_set_password: Sets the password of the user. The user must be an internal user. alter_user_set_resource_group: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.
[in]	value_	The value of the modification, depending on action_.
[in]	options_	Optional parameters. The default value is an empty map.

Definition at line 72 of file alter_user.h.

Member Data Documentation

◆ action

std::string gpudb::AlterUserRequest::action

Modification operation to be applied to the user.

Supported values:

alter_user_set_activated: Is the user allowed to login.
alter_user_true: User may login
alter_user_false: User may not login
alter_user_set_comment: Sets the comment for an internal user.
alter_user_set_default_schema: Set the default_schema for an internal user. An empty string means the user will have no default schema.
alter_user_set_password: Sets the password of the user. The user must be an internal user.
alter_user_set_resource_group: Sets the resource group for an internal user. The resource group must exist, otherwise, an empty string assigns the user to the default resource group.

Definition at line 111 of file alter_user.h.

◆ name

std::string gpudb::AlterUserRequest::name

Name of the user to be altered.

Must be an existing user.

Definition at line 83 of file alter_user.h.

◆ options

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

Optional parameters.

The default value is an empty map.

Definition at line 121 of file alter_user.h.

◆ value

std::string gpudb::AlterUserRequest::value

The value of the modification, depending on action.

Definition at line 116 of file alter_user.h.

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

gpudb/protocol/alter_user.h

Public Member Functions

Public Attributes