NoSQL Functions

Package: DBMS_CLOUD_OCI_NS_NOSQL

CHANGE_TABLE_COMPARTMENT Function

Change a table's compartment.

Syntax

FUNCTION change_table_compartment (
  table_name_or_id varchar2,
  change_table_compartment_details dbms_cloud_oci_nosql_change_table_compartment_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_change_table_compartment_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`change_table_compartment_details`	(required) Specifications of the source and target compartments.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_INDEX Function

Create a new index on the table identified by tableNameOrId.

Syntax

FUNCTION create_index (
  table_name_or_id varchar2,
  create_index_details dbms_cloud_oci_nosql_create_index_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_create_index_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`create_index_details`	(required) Specifications for the new index.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_REPLICA Function

Add a replica for this table

Syntax

FUNCTION create_replica (
  table_name_or_id varchar2,
  create_replica_details dbms_cloud_oci_nosql_create_replica_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_create_replica_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`create_replica_details`	(required) Specifications for the new replica
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

CREATE_TABLE Function

Create a new table.

Syntax

FUNCTION create_table (
  create_table_details dbms_cloud_oci_nosql_create_table_details_t,
  opc_retry_token varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_create_table_response_t;

Parameters

Parameter	Description
`create_table_details`	(required) Specifications for the new table.
`opc_retry_token`	(optional) A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_INDEX Function

Delete an index from the table identified by tableNameOrId.

Syntax

FUNCTION delete_index (
  table_name_or_id varchar2,
  index_name varchar2,
  compartment_id varchar2 DEFAULT NULL,
  is_if_exists number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_delete_index_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`index_name`	(required) The name of a table's index.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`is_if_exists`	(optional) Set as true to select \"if exists\" behavior.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_REPLICA Function

Delete the specified replica table in the remote region.

Syntax

FUNCTION delete_replica (
  table_name_or_id varchar2,
  l_region varchar2,
  compartment_id varchar2 DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_delete_replica_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`l_region`	(required) A customer-facing region identifier
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_ROW Function

Delete a single row from the table, by primary key.

Syntax

FUNCTION delete_row (
  table_name_or_id varchar2,
  key dbms_cloud_oci_nosql_varchar2_tbl,
  compartment_id varchar2 DEFAULT NULL,
  is_get_return_row number DEFAULT NULL,
  timeout_in_ms number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_delete_row_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`key`	(required) An array of strings, each of the format \"column-name:value\", representing the primary key of the row.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`is_get_return_row`	(optional) If true, and the operation fails due to an option setting (ifVersion et al), then the existing row will be returned.
`timeout_in_ms`	(optional) Timeout setting for this operation.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_TABLE Function

Delete a table by tableNameOrId.

Syntax

FUNCTION delete_table (
  table_name_or_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  is_if_exists number DEFAULT NULL,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_delete_table_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`is_if_exists`	(optional) Set as true to select \"if exists\" behavior.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

DELETE_WORK_REQUEST Function

Cancel a work request operation with the given ID.

Syntax

FUNCTION delete_work_request (
  work_request_id varchar2,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_delete_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_INDEX Function

Get information about a single index.

Syntax

FUNCTION get_index (
  table_name_or_id varchar2,
  index_name varchar2,
  compartment_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_get_index_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`index_name`	(required) The name of a table's index.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_ROW Function

Get a single row from the table by primary key.

Syntax

FUNCTION get_row (
  table_name_or_id varchar2,
  key dbms_cloud_oci_nosql_varchar2_tbl,
  compartment_id varchar2 DEFAULT NULL,
  consistency varchar2 DEFAULT NULL,
  timeout_in_ms number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_get_row_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`key`	(required) An array of strings, each of the format \"column-name:value\", representing the primary key of the row.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`consistency`	(optional) Consistency requirement for a read operation. Allowed values are: 'EVENTUAL', 'ABSOLUTE'
`timeout_in_ms`	(optional) Timeout setting for this operation.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_TABLE Function

Get table info by identifier.

Syntax

FUNCTION get_table (
  table_name_or_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_get_table_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

GET_WORK_REQUEST Function

Get the status of the work request with the given ID.

Syntax

FUNCTION get_work_request (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_get_work_request_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_INDEXES Function

Get a list of indexes on a table.

Syntax

FUNCTION list_indexes (
  table_name_or_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  name varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_indexes_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`name`	(optional) A shell-globbing-style (*?[]) filter for names.
`lifecycle_state`	(optional) Filter list by the lifecycle state of the item. Allowed values are: 'ALL', 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'name'
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TABLE_USAGE Function

Get table usage info.

Syntax

FUNCTION list_table_usage (
  table_name_or_id varchar2,
  compartment_id varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  time_start timestamp with time zone DEFAULT NULL,
  time_end timestamp with time zone DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_table_usage_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`compartment_id`	(optional) The ID of a table's compartment. When a table is identified by name, the compartmentId is often needed to provide context for interpreting the name.
`opc_request_id`	(optional) The client request ID for tracing.
`time_start`	(optional) The start time to use for the request. If no time range is set for this request, the most recent complete usage record is returned.
`time_end`	(optional) The end time to use for the request.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_TABLES Function

Get a list of tables in a compartment.

Syntax

FUNCTION list_tables (
  compartment_id varchar2,
  name varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  sort_order varchar2 DEFAULT NULL,
  sort_by varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  lifecycle_state varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_tables_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of a table's compartment.
`name`	(optional) A shell-globbing-style (*?[]) filter for names.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`sort_order`	(optional) The sort order to use, either 'ASC' or 'DESC'. Allowed values are: 'ASC', 'DESC'
`sort_by`	(optional) The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for name is ascending. If no value is specified timeCreated is default. Allowed values are: 'timeCreated', 'name'
`opc_request_id`	(optional) The client request ID for tracing.
`lifecycle_state`	(optional) Filter list by the lifecycle state of the item. Allowed values are: 'ALL', 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_ERRORS Function

Return a (paginated) list of errors for a given work request.

Syntax

FUNCTION list_work_request_errors (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_work_request_errors_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUEST_LOGS Function

Return a (paginated) list of logs for a given work request.

Syntax

FUNCTION list_work_request_logs (
  work_request_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_work_request_logs_response_t;

Parameters

Parameter	Description
`work_request_id`	(required) The ID of the asynchronous request.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

LIST_WORK_REQUESTS Function

List the work requests in a compartment.

Syntax

FUNCTION list_work_requests (
  compartment_id varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  limit number DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_list_work_requests_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of a table's compartment.
`opc_request_id`	(optional) The client request ID for tracing.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`limit`	(optional) The maximum number of items to return.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

PREPARE_STATEMENT Function

Prepare a SQL statement for use in a query with variable substitution.

Syntax

FUNCTION prepare_statement (
  compartment_id varchar2,
  statement varchar2,
  is_get_query_plan number DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_prepare_statement_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of a table's compartment.
`statement`	(required) A NoSQL SQL statement.
`is_get_query_plan`	(optional) Include a query execution plan in the result.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

QUERY Function

Execute a SQL query.

Syntax

FUNCTION query (
  query_details dbms_cloud_oci_nosql_query_details_t,
  limit number DEFAULT NULL,
  page varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_query_response_t;

Parameters

Parameter	Description
`query_details`	(required) SQL query statement and ancillary information.
`limit`	(optional) The maximum number of items to return.
`page`	(optional) The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

SUMMARIZE_STATEMENT Function

Check the syntax and return a brief summary of a SQL statement.

Syntax

FUNCTION summarize_statement (
  compartment_id varchar2,
  statement varchar2,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_summarize_statement_response_t;

Parameters

Parameter	Description
`compartment_id`	(required) The ID of a table's compartment.
`statement`	(required) A NoSQL SQL statement.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_ROW Function

Write a single row into the table.

Syntax

FUNCTION update_row (
  table_name_or_id varchar2,
  update_row_details dbms_cloud_oci_nosql_update_row_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_update_row_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`update_row_details`	(required) Specifications for the putting of a table row.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

UPDATE_TABLE Function

Alter the table identified by tableNameOrId, changing schema, limits, or tags

Syntax

FUNCTION update_table (
  table_name_or_id varchar2,
  update_table_details dbms_cloud_oci_nosql_update_table_details_t,
  if_match varchar2 DEFAULT NULL,
  opc_request_id varchar2 DEFAULT NULL,
  region varchar2 DEFAULT NULL, 
  endpoint varchar2 DEFAULT NULL,
  credential_name varchar2 DEFAULT NULL
) RETURN dbms_cloud_oci_ns_nosql_update_table_response_t;

Parameters

Parameter	Description
`table_name_or_id`	(required) A table name within the compartment, or a table OCID.
`update_table_details`	(required) Specifications for the alteration.
`if_match`	(optional) For optimistic concurrency control. In the PUT or DELETE call for a resource, set the `if-match` parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`opc_request_id`	(optional) The client request ID for tracing.
`region`	(optional) OCI region id. e.g us-phoenix-1 for US West (Phoenix).
`endpoint`	(optional) The endpoint of the service to call using this function. e.g https://nosql.{region}.oci.{secondLevelDomain}.If both endpoint and region are given, then endpoint takes precedence.
`credential_name`	(optional) The name of the credential for authenticating with the corresponding cloud native API.

Oracle Cloud Infrastructure Documentation

CHANGE_TABLE_COMPARTMENT Function

CREATE_INDEX Function

CREATE_REPLICA Function

CREATE_TABLE Function

DELETE_INDEX Function

DELETE_REPLICA Function

DELETE_ROW Function

DELETE_TABLE Function

DELETE_WORK_REQUEST Function

GET_INDEX Function

GET_ROW Function

GET_TABLE Function

GET_WORK_REQUEST Function

LIST_INDEXES Function

LIST_TABLE_USAGE Function

LIST_TABLES Function

LIST_WORK_REQUEST_ERRORS Function

LIST_WORK_REQUEST_LOGS Function

LIST_WORK_REQUESTS Function

PREPARE_STATEMENT Function

QUERY Function

SUMMARIZE_STATEMENT Function

UPDATE_ROW Function

UPDATE_TABLE Function