gpudb::LockTableRequest Struct Reference

A set of input parameters for const. More...

#include <gpudb/protocol/lock_table.h>

Public Member Functions
	LockTableRequest ()
	Constructs a LockTableRequest object with default parameter values. More...
	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. More...

Public Attributes
std::string	tableName
std::string	lockType
std::map< std::string, std::string >	options

Detailed Description

A set of input parameters for const.

Manages global access to a table's data. By default a table has a lockType of unlock, 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 disable then no operations are permitted on the table. The lock status can be queried by setting lockType to status.

Definition at line 24 of file lock_table.h.

Constructor & Destructor Documentation

gpudb::LockTableRequest::LockTableRequest ( )

inline

Constructs a LockTableRequest object with default parameter values.

Definition at line 30 of file lock_table.h.

gpudb::LockTableRequest::LockTableRequest ( const std::string &  tableName_, const std::string &  lockType_, const std::map< std::string, std::string > &  options_  )

inline

Constructs a LockTableRequest object with the specified parameters.

Parameters

[in]	tableName_	Name of the table to be locked. It must be a currently existing table, collection, 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. gpudb::lock_table_status: Show locked status gpudb::lock_table_disable: Allow no read/write operations gpudb::lock_table_read_only: Allow only read operations gpudb::lock_table_write_only: Allow only write operations gpudb::lock_table_unlock: Allow all read/write operations
[in]	options_	Optional parameters.

Definition at line 62 of file lock_table.h.

Member Data Documentation

std::string gpudb::LockTableRequest::lockType

Definition at line 70 of file lock_table.h.

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

Definition at line 71 of file lock_table.h.

std::string gpudb::LockTableRequest::tableName

Definition at line 69 of file lock_table.h.

---

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

• gpudb/protocol/lock_table.h