Version:

Lock TableΒΆ

Manages global access to a table's data. By default a table has a input parameter lock_type of unlock, 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 disable 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

Name Type Description
table_name string Name of the table to be locked. It must be a currently existing table, collection, 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. Default value is 'status'.

Supported Values Description
status Show locked status
disable Allow no read/write operations
read-only Allow only read operations
write-only Allow only write operations
unlock Allow all read/write operations
options map of strings Optional parameters. Default value is an empty map ( {} ).

Output Parameter Description

Name Type Description
lock_type string Returns the lock state of the table.