A set of parameters for GPUdb::lockTable. More…
#include <gpudb/protocol/lock_table.h>
Public Member Functions | |
| LockTableRequest () | |
| Constructs a LockTableRequest object with default parameters. | |
| LockTableRequest (const std::string &tableName_, const std::string &lockType_, const std::map< std::string, std::string > &options_) | |
| Constructs a LockTableRequest object with the specified parameters. | |
Public Attributes | |
| std::string | tableName |
| Name of the table to be locked, in [ schema_name. ]table_name format, using standard name resolution rules. | |
| std::string | lockType |
| The type of lock being applied to the table. | |
| std::map< std::string, std::string > | options |
| Optional parameters. | |
Detailed Description
A set of parameters for GPUdb::lockTable.
Manages global access to a table’s data. By default a table has a lockType of read_write, indicating all operations are permitted. A user may request a read_only or a write_only lock, after which only read or write operations, respectively, are permitted on the table until the lock is removed. When lockType is no_access then no operations are permitted on the table. The lock status can be queried by setting lockType to status.
Definition at line 26 of file lock_table.h.
Constructor & Destructor Documentation
◆ LockTableRequest() [1/2]
| inline |
Constructs a LockTableRequest object with default parameters.
Definition at line 31 of file lock_table.h.
◆ LockTableRequest() [2/2]
| inline |
Constructs a LockTableRequest object with the specified parameters.
| [in] | tableName_ | Name of the table to be locked, in [schema_name.]table_name format, using standard name resolution rules. It must be a currently existing table or view. |
| [in] | lockType_ | The type of lock being applied to the table. Setting it to status will return the current lock status of the table without changing it. Supported values:
|
| [in] | options_ | Optional parameters. The default value is an empty map. |
Definition at line 74 of file lock_table.h.
Member Data Documentation
◆ lockType
| std::string gpudb::LockTableRequest::lockType |
The type of lock being applied to the table.
Setting it to status will return the current lock status of the table without changing it. Supported values:
- lock_table_status: Show locked status.
- lock_table_no_access: Allow no read/write operations.
- lock_table_read_only: Allow only read operations.
- lock_table_write_only: Allow only write operations.
- lock_table_read_write: Allow all read/write operations.
The default value is lock_table_status.
Definition at line 110 of file lock_table.h.
◆ options
| std::map<std::string, std::string> gpudb::LockTableRequest::options |
Optional parameters.
The default value is an empty map.
Definition at line 115 of file lock_table.h.
◆ tableName
| std::string gpudb::LockTableRequest::tableName |
Name of the table to be locked, in [ schema_name. ]table_name format, using standard name resolution rules.
It must be a currently existing table or view.
Definition at line 88 of file lock_table.h.
The documentation for this struct was generated from the following file:
- gpudb/protocol/lock_table.h