gpudb::GrantPermissionRequest Struct Reference

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

#include <gpudb/protocol/grant_permission.h>

Public Member Functions
	GrantPermissionRequest ()
	Constructs a GrantPermissionRequest object with default parameters. More...
	GrantPermissionRequest (const std::string &principal_, const std::string &object_, const std::string &objectType_, const std::string &permission_, const std::map< std::string, std::string > &options_)
	Constructs a GrantPermissionRequest object with the specified parameters. More...

Public Attributes
std::string	principal
	Name of the user or role for which the permission is being granted. More...
std::string	object
	Name of object permission is being granted to. More...
std::string	objectType
	The type of object being granted to. More...
std::string	permission
	Permission being granted. More...
std::map< std::string, std::string >	options
	Optional parameters. More...

Detailed Description

A set of parameters for GPUdb::grantPermission.

Grant user or role the specified permission on the specified object.

Definition at line 18 of file grant_permission.h.

Constructor & Destructor Documentation

GrantPermissionRequest() [1/2]

gpudb::GrantPermissionRequest::GrantPermissionRequest ( )

inline

Constructs a GrantPermissionRequest object with default parameters.

Definition at line 23 of file grant_permission.h.

GrantPermissionRequest() [2/2]

gpudb::GrantPermissionRequest::GrantPermissionRequest ( const std::string &  principal_, const std::string &  object_, const std::string &  objectType_, const std::string &  permission_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a GrantPermissionRequest object with the specified parameters.

Parameters

[in]	principal_	Name of the user or role for which the permission is being granted. Must be an existing user or role. The default value is ''.
[in]	object_	Name of object permission is being granted to. It is recommended to use a fully-qualified name when possible.
[in]	objectType_	The type of object being granted to. Supported values: grant_permission_context: Context grant_permission_credential: Credential grant_permission_datasink: Data Sink grant_permission_datasource: Data Source grant_permission_directory: KIFS File Directory grant_permission_graph: A Graph object grant_permission_proc: UDF Procedure grant_permission_schema: Schema grant_permission_sql_proc: SQL Procedure grant_permission_system: System-level access grant_permission_table: Database Table grant_permission_table_monitor: Table monitor
[in]	permission_	Permission being granted. Supported values: grant_permission_admin: Full read/write and administrative access on the object. grant_permission_connect: Connect access on the given data source or data sink. grant_permission_create: Ability to create new objects of this type. grant_permission_delete: Delete rows from tables. grant_permission_execute: Ability to Execute the Procedure object. grant_permission_insert: Insert access to tables. grant_permission_monitor: Monitor logs and statistics. grant_permission_read: Ability to read, list and use the object. grant_permission_send_alert: Ability to send system alerts. grant_permission_update: Update access to the table. grant_permission_user_admin: Access to administer users and roles that do not have system_admin permission. grant_permission_write: Access to write, change and delete objects.
[in]	options_	Optional parameters. grant_permission_columns: Apply table security to these columns, comma-separated. The default value is ''. grant_permission_filter_expression: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''. grant_permission_with_grant_option: Allow the recipient to grant the same permission (or subset) to others. Supported values: grant_permission_true grant_permission_false The default value is grant_permission_false. The default value is an empty map.

Definition at line 167 of file grant_permission.h.

Member Data Documentation

object

std::string gpudb::GrantPermissionRequest::object

Name of object permission is being granted to.

It is recommended to use a fully-qualified name when possible.

Definition at line 186 of file grant_permission.h.

objectType

std::string gpudb::GrantPermissionRequest::objectType

The type of object being granted to.

Supported values:

• grant_permission_context: Context
• grant_permission_credential: Credential
• grant_permission_datasink: Data Sink
• grant_permission_datasource: Data Source
• grant_permission_directory: KIFS File Directory
• grant_permission_graph: A Graph object
• grant_permission_proc: UDF Procedure
• grant_permission_schema: Schema
• grant_permission_sql_proc: SQL Procedure
• grant_permission_system: System-level access
• grant_permission_table: Database Table
• grant_permission_table_monitor: Table monitor

Definition at line 218 of file grant_permission.h.

options

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

Optional parameters.

• grant_permission_columns: Apply table security to these columns, comma-separated. The default value is ''.
• grant_permission_filter_expression: Optional filter expression to apply to this grant. Only rows that match the filter will be affected. The default value is ''.
• grant_permission_with_grant_option: Allow the recipient to grant the same permission (or subset) to others. Supported values:
  • grant_permission_true
  • grant_permission_false
  The default value is grant_permission_false.

The default value is an empty map.

Definition at line 282 of file grant_permission.h.

permission

std::string gpudb::GrantPermissionRequest::permission

Permission being granted.

Supported values:

• grant_permission_admin: Full read/write and administrative access on the object.
• grant_permission_connect: Connect access on the given data source or data sink.
• grant_permission_create: Ability to create new objects of this type.
• grant_permission_delete: Delete rows from tables.
• grant_permission_execute: Ability to Execute the Procedure object.
• grant_permission_insert: Insert access to tables.
• grant_permission_monitor: Monitor logs and statistics.
• grant_permission_read: Ability to read, list and use the object.
• grant_permission_send_alert: Ability to send system alerts.
• grant_permission_update: Update access to the table.
• grant_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
• grant_permission_write: Access to write, change and delete objects.

Definition at line 255 of file grant_permission.h.

principal

std::string gpudb::GrantPermissionRequest::principal

Name of the user or role for which the permission is being granted.

Must be an existing user or role. The default value is ''.

Definition at line 180 of file grant_permission.h.

---

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

• gpudb/protocol/grant_permission.h