com.gpudb.protocol

Class LockTableRequest

java.lang.Object

com.gpudb.protocol.LockTableRequest

All Implemented Interfaces:

org.apache.avro.generic.GenericContainer, org.apache.avro.generic.IndexedRecord

public class LockTableRequest
extends Object
implements org.apache.avro.generic.IndexedRecord

A set of parameters for GPUdb.lockTable(LockTableRequest).

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LockTableRequest.LockType The type of lock being applied to the table.

Constructor Summary

Constructors

Constructor and Description
LockTableRequest() Constructs a LockTableRequest object with default parameters.
LockTableRequest(String tableName, String lockType, Map<String,String> options) Constructs a LockTableRequest object with the specified parameters.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(Object obj)
Object	get(int index) This method supports the Avro framework and is not intended to be called directly by the user.
static org.apache.avro.Schema	getClassSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getLockType()
Map<String,String>	getOptions()
org.apache.avro.Schema	getSchema() This method supports the Avro framework and is not intended to be called directly by the user.
String	getTableName()
int	hashCode()
void	put(int index, Object value) This method supports the Avro framework and is not intended to be called directly by the user.
LockTableRequest	setLockType(String lockType)
LockTableRequest	setOptions(Map<String,String> options)
LockTableRequest	setTableName(String tableName)
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LockTableRequest

public LockTableRequest()

Constructs a LockTableRequest object with default parameters.

LockTableRequest

public LockTableRequest(String tableName,
                String lockType,
                Map<String,String> options)

Constructs a LockTableRequest object with the specified parameters.

Parameters:

tableName - Name of the table to be locked. It must be a currently existing table, collection, or view.

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:

• 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.

Method Detail

getClassSchema

public static org.apache.avro.Schema getClassSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Returns:

the schema for the class.

getTableName

public String getTableName()

Returns:

Name of the table to be locked. It must be a currently existing table, collection, or view.

setTableName

public LockTableRequest setTableName(String tableName)

Parameters:

tableName - Name of the table to be locked. It must be a currently existing table, collection, or view.

Returns:

this to mimic the builder pattern.

getLockType

public String getLockType()

Returns:

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.

setLockType

public LockTableRequest setLockType(String lockType)

Parameters:

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:

• 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.

Returns:

this to mimic the builder pattern.

getOptions

public Map<String,String> getOptions()

Returns:

Optional parameters.

setOptions

public LockTableRequest setOptions(Map<String,String> options)

Parameters:

options - Optional parameters.

Returns:

this to mimic the builder pattern.

getSchema

public org.apache.avro.Schema getSchema()

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

getSchema in interface org.apache.avro.generic.GenericContainer

Returns:

the schema object describing this class.

get

public Object get(int index)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

get in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to get

Returns:

value of the field with the given index.

Throws:

IndexOutOfBoundsException

put

public void put(int index,
       Object value)

This method supports the Avro framework and is not intended to be called directly by the user.

Specified by:

put in interface org.apache.avro.generic.IndexedRecord

Parameters:

index - the position of the field to set

value - the value to set

Throws:

IndexOutOfBoundsException

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

public String toString()

Overrides:

toString in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object