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

#include <gpudb/protocol/create_user_internal.h>

Public Member Functions
	CreateUserInternalRequest ()
	Constructs a CreateUserInternalRequest object with default parameters. More...

	CreateUserInternalRequest (const std::string &name_, const std::string &password_, const std::map< std::string, std::string > &options_)
	Constructs a CreateUserInternalRequest object with the specified parameters. More...

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

std::string	password
	Initial password of the user to be created. More...

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

Detailed Description

A set of parameters for GPUdb::createUserInternal.

Creates a new internal user (a user whose credentials are managed by the database system).

Definition at line 19 of file create_user_internal.h.

Constructor & Destructor Documentation

◆ CreateUserInternalRequest() [1/2]

gpudb::CreateUserInternalRequest::CreateUserInternalRequest ( )

inline

Constructs a CreateUserInternalRequest object with default parameters.

Definition at line 25 of file create_user_internal.h.

◆ CreateUserInternalRequest() [2/2]

gpudb::CreateUserInternalRequest::CreateUserInternalRequest	(	const std::string &	name_,
		const std::string &	password_,
		const std::map< std::string, std::string > &	options_
	)

inline

Constructs a CreateUserInternalRequest object with the specified parameters.

Parameters

[in]	name_	Name of the user to be created. Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.
[in]	password_	Initial password of the user to be created. May be an empty string for no password.
[in]	options_	Optional parameters. create_user_internal_activated: Is the user allowed to login. Supported values: create_user_internal_true: User may login create_user_internal_false: User may not login The default value is create_user_internal_true. create_user_internal_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values: create_user_internal_true create_user_internal_false The default value is create_user_internal_true. create_user_internal_default_schema: Default schema to associate with this user create_user_internal_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied. create_user_internal_resource_group: Name of an existing resource group to associate with this user The default value is an empty map.

Definition at line 105 of file create_user_internal.h.

Member Data Documentation

◆ name

std::string gpudb::CreateUserInternalRequest::name

Name of the user to be created.

Must contain only lowercase letters, digits, and underscores, and cannot begin with a digit. Must not be the same name as an existing user or role.

Definition at line 117 of file create_user_internal.h.

◆ options

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

Optional parameters.

create_user_internal_activated: Is the user allowed to login. Supported values:
- create_user_internal_true: User may login
- create_user_internal_false: User may not login
The default value is create_user_internal_true.
create_user_internal_create_home_directory: When true, a home directory in KiFS is created for this user. Supported values:
- create_user_internal_true
- create_user_internal_false
The default value is create_user_internal_true.
create_user_internal_default_schema: Default schema to associate with this user
create_user_internal_directory_data_limit: The maximum capacity to apply to the created directory if create_home_directory is true. Set to -1 to indicate no upper limit. If empty, the system default limit is applied.
create_user_internal_resource_group: Name of an existing resource group to associate with this user

The default value is an empty map.

Definition at line 170 of file create_user_internal.h.

◆ password

std::string gpudb::CreateUserInternalRequest::password

Initial password of the user to be created.

May be an empty string for no password.

Definition at line 123 of file create_user_internal.h.

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

gpudb/protocol/create_user_internal.h

Public Member Functions

Public Attributes