gpudb::HasPermissionRequest Struct Reference

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

#include <gpudb/protocol/has_permission.h>

Public Member Functions
	HasPermissionRequest ()
	Constructs a HasPermissionRequest object with default parameters. More...
	HasPermissionRequest (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 HasPermissionRequest object with the specified parameters. More...

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

Detailed Description

A set of parameters for GPUdb::hasPermission.

Checks if the specified user has the specified permission on the specified object.

Definition at line 19 of file has_permission.h.

Constructor & Destructor Documentation

HasPermissionRequest() [1/2]

gpudb::HasPermissionRequest::HasPermissionRequest ( )

inline

Constructs a HasPermissionRequest object with default parameters.

Definition at line 24 of file has_permission.h.

HasPermissionRequest() [2/2]

gpudb::HasPermissionRequest::HasPermissionRequest ( 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 HasPermissionRequest object with the specified parameters.

Parameters

[in]	principal_	Name of the user for which the permission is being checked. Must be an existing user. If blank, will use the current user. The default value is ''.
[in]	object_	Name of object to check for the requested permission. It is recommended to use a fully-qualified name when possible.
[in]	objectType_	The type of object being checked. Supported values: has_permission_context: Context has_permission_credential: Credential has_permission_datasink: Data Sink has_permission_datasource: Data Source has_permission_directory: KiFS File Directory has_permission_graph: A Graph object has_permission_proc: UDF Procedure has_permission_schema: Schema has_permission_sql_proc: SQL Procedure has_permission_system: System-level access has_permission_table: Database Table has_permission_table_monitor: Table monitor
[in]	permission_	Permission to check for. Supported values: has_permission_admin: Full read/write and administrative access on the object. has_permission_connect: Connect access on the given data source or data sink. has_permission_create: Ability to create new objects of this type. has_permission_delete: Delete rows from tables. has_permission_execute: Ability to Execute the Procedure object. has_permission_insert: Insert access to tables. has_permission_read: Ability to read, list and use the object. has_permission_update: Update access to the table. has_permission_user_admin: Access to administer users and roles that do not have system_admin permission. has_permission_write: Access to write, change and delete objects.
[in]	options_	Optional parameters. has_permission_no_error_if_not_exists: If false will return an error if the provided object_ does not exist or is blank. If true then it will return false for hasPermission. Supported values: has_permission_true has_permission_false The default value is has_permission_false. The default value is an empty map.

Definition at line 150 of file has_permission.h.

Member Data Documentation

object

std::string gpudb::HasPermissionRequest::object

Name of object to check for the requested permission.

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

Definition at line 170 of file has_permission.h.

objectType

std::string gpudb::HasPermissionRequest::objectType

The type of object being checked.

Supported values:

• has_permission_context: Context
• has_permission_credential: Credential
• has_permission_datasink: Data Sink
• has_permission_datasource: Data Source
• has_permission_directory: KiFS File Directory
• has_permission_graph: A Graph object
• has_permission_proc: UDF Procedure
• has_permission_schema: Schema
• has_permission_sql_proc: SQL Procedure
• has_permission_system: System-level access
• has_permission_table: Database Table
• has_permission_table_monitor: Table monitor

Definition at line 202 of file has_permission.h.

options

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

Optional parameters.

• has_permission_no_error_if_not_exists: If false will return an error if the provided object does not exist or is blank. If true then it will return false for hasPermission. Supported values:
  • has_permission_true
  • has_permission_false
  The default value is has_permission_false.

The default value is an empty map.

Definition at line 255 of file has_permission.h.

permission

std::string gpudb::HasPermissionRequest::permission

Permission to check for.

Supported values:

• has_permission_admin: Full read/write and administrative access on the object.
• has_permission_connect: Connect access on the given data source or data sink.
• has_permission_create: Ability to create new objects of this type.
• has_permission_delete: Delete rows from tables.
• has_permission_execute: Ability to Execute the Procedure object.
• has_permission_insert: Insert access to tables.
• has_permission_read: Ability to read, list and use the object.
• has_permission_update: Update access to the table.
• has_permission_user_admin: Access to administer users and roles that do not have system_admin permission.
• has_permission_write: Access to write, change and delete objects.

Definition at line 231 of file has_permission.h.

principal

std::string gpudb::HasPermissionRequest::principal

Name of the user for which the permission is being checked.

Must be an existing user. If blank, will use the current user. The default value is ''.

Definition at line 164 of file has_permission.h.

---

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

• gpudb/protocol/has_permission.h