A set of parameters for Kinetica.lockTable. More...
Inheritance diagram for kinetica.LockTableRequest:
Collaboration diagram for kinetica.LockTableRequest:
Classes | |
| struct | LockType |
| A set of string constants for the parameter lock_type. More... | |
Public Member Functions | |
| LockTableRequest () | |
| Constructs a LockTableRequest object with default parameters. More... | |
| LockTableRequest (string table_name, string lock_type=null, IDictionary< string, string > options=null) | |
| Constructs a LockTableRequest object with the specified parameters. More... | |
| Public Member Functions inherited from kinetica.KineticaData | |
| KineticaData (KineticaType type) | |
| Constructor from Kinetica Type More... | |
| KineticaData (System.Type type=null) | |
| Default constructor, with optional System.Type More... | |
| object | Get (int fieldPos) |
| Retrieve a specific property from this object More... | |
| void | Put (int fieldPos, object fieldValue) |
| Write a specific property to this object More... | |
Properties | |
| string | table_name [get, set] |
| Name of the table to be locked, in [schema_name. More... | |
| string | lock_type = LockType.STATUS [get, set] |
| The type of lock being applied to the table. More... | |
| IDictionary< string, string > | options = new Dictionary<string, string>() [get, set] |
| Optional parameters. More... | |
| Properties inherited from kinetica.KineticaData | |
| Schema | Schema [get] |
| Avro Schema for this class More... | |
Additional Inherited Members | |
| Static Public Member Functions inherited from kinetica.KineticaData | |
| static ? RecordSchema | SchemaFromType (System.Type t, KineticaType? ktype=null) |
| Create an Avro Schema from a System.Type and a KineticaType. More... | |
Detailed Description
A set of parameters for Kinetica.lockTable.
Manages global access to a table's data. By default a table has a lock_type 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 lock_type is NO_ACCESS then no operations are permitted on the table. The lock status can be queried by setting lock_type to STATUS.
Definition at line 26 of file LockTable.cs.
Constructor & Destructor Documentation
◆ LockTableRequest() [1/2]
|
inline |
Constructs a LockTableRequest object with default parameters.
Definition at line 99 of file LockTable.cs.
◆ LockTableRequest() [2/2]
|
inline |
Constructs a LockTableRequest object with the specified parameters.
- Parameters
-
table_name 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. lock_type 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: - STATUS: Show locked status
- NO_ACCESS: Allow no read/write operations
- READ_ONLY: Allow only read operations
- WRITE_ONLY: Allow only write operations
- READ_WRITE: Allow all read/write operations
options Optional parameters. The default value is an empty Dictionary.
Definition at line 143 of file LockTable.cs.
Property Documentation
◆ lock_type
|
getset |
The type of lock being applied to the table.
Supported values:
- STATUS: Show locked status
- NO_ACCESS: Allow no read/write operations
- READ_ONLY: Allow only read operations
- WRITE_ONLY: Allow only write operations
- READ_WRITE: Allow all read/write operations
The default value is STATUS.
Definition at line 90 of file LockTable.cs.
◆ options
|
getset |
Optional parameters.
The default value is an empty Dictionary.
Definition at line 95 of file LockTable.cs.
◆ table_name
|
getset |
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 58 of file LockTable.cs.
The documentation for this class was generated from the following file:
- Kinetica/Protocol/LockTable.cs
