kinetica.LockTableRequest Class Reference

A set of parameters for Kinetica.lockTable(string,string,IDictionary{string, string}). More...

Inheritance diagram for kinetica.LockTableRequest:

Collaboration diagram for kinetica.LockTableRequest:

Classes
struct	LockType
	The type of lock being applied to the table. 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. More...
string	lock_type [get, set]
	The type of lock being applied to the table. More...
IDictionary< string, string >	options = LockType.STATUS [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(string,string,IDictionary{string, string}).

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

kinetica.LockTableRequest.LockTableRequest ( )

inline

Constructs a LockTableRequest object with default parameters.

Definition at line 130 of file LockTable.cs.

kinetica.LockTableRequest.LockTableRequest ( string  table_name, string  lock_type = null, IDictionary< string, string >  options = null  )

inline

Constructs a LockTableRequest object with the specified parameters.

Parameters

table_name	Name of the table to be locked. It must be a currently existing table, collection, 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 The default value is STATUS.
options	Optional parameters. The default value is an empty Dictionary.

Definition at line 173 of file LockTable.cs.

Property Documentation

string kinetica.LockTableRequest.lock_type

getset

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

The default value is STATUS.

Definition at line 121 of file LockTable.cs.

IDictionary<string, string> kinetica.LockTableRequest.options = LockType.STATUS

getset

Optional parameters.

The default value is an empty Dictionary.

Definition at line 125 of file LockTable.cs.

string kinetica.LockTableRequest.table_name

getset

Name of the table to be locked.

It must be a currently existing table, collection, or view.

Definition at line 86 of file LockTable.cs.

---

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

• Kinetica/Protocol/LockTable.cs