Skip to main content
Package 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.

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.

  • ​
    Constructor Details

    • ​
      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, in [schema_name.]table_name format, using standard name resolution rules. It must be a currently existing table 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:The default value is STATUS.
      options - Optional parameters. The default value is an empty Map.

  • ​
    Method Details

    • ​
      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()
      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.
      Returns:
      The current value of tableName.

    • ​
      setTableName

      public LockTableRequest setTableName(String 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.
      Parameters:
      tableName - The new value for tableName.
      Returns:
      this to mimic the builder pattern.

    • ​
      getLockType

      public String getLockType()
      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:The default value is STATUS.
      Returns:
      The current value of lockType.

    • ​
      setLockType

      public LockTableRequest setLockType(String 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:The default value is STATUS.
      Parameters:
      lockType - The new value for lockType.
      Returns:
      this to mimic the builder pattern.

    • ​
      getOptions

      public Map<String,String> getOptions()
      Optional parameters. The default value is an empty Map.
      Returns:
      The current value of options.

    • ​
      setOptions

      public LockTableRequest setOptions(Map<String,String> options)
      Optional parameters. The default value is an empty Map.
      Parameters:
      options - The new value for options.
      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