Skip to main content
URL: http://<db.host>:<db.port>/lock/table
Manages global access to a table’s data. By default a table has a input parameter 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 input parameter lock_type is no_access then no operations are permitted on the table. The lock status can be queried by setting input parameter lock_type to status.

​
Input Parameter Description

​
table_name
string
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
string
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.The default value is status.
  • 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
map of string to strings
Optional parameters.The default value is an empty map ( {} ).

​
Output Parameter Description

The Kinetica server embeds the endpoint response inside a standard response structure which contains status information and the actual response to the query. Here is a description of the various fields of the wrapper:
​
status
String
‘OK’ or ‘ERROR’
​
message
String
Empty if success or an error message
​
data_type
String
‘lock_table_response’ or ‘none’ in case of an error
​
data
String
Empty string
​
data_str
JSON or String
This embedded JSON represents the result of the /lock/table endpoint:Empty string in case of an error.