Oracle Cloud Infrastructure Documentation
Try Free Tier

NoSQL Common Types

DBMS_CLOUD_OCI_NOSQL_VARCHAR2_TBL Type

Nested table type of varchar2(32767).

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_varchar2_tbl FORCE IS TABLE OF (varchar2(32767)) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_CHANGE_TABLE_COMPARTMENT_DETAILS_T Type

Specification of both from and to compartments.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_change_table_compartment_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  from_compartment_id varchar2(32767),
  to_compartment_id varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_change_table_compartment_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_change_table_compartment_details_t (
    from_compartment_id varchar2,
    to_compartment_id varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

from_compartment_id

(optional) The OCID of the table's current compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and fromCompartmentId is supplied, the latter must match the identified table's current compartmentId.

to_compartment_id

(required) The OCID of the table's new compartment.

DBMS_CLOUD_OCI_NOSQL_COLUMN_T Type

A column of a table.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_column_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  l_type varchar2(32767),
  is_nullable number,
  default_value varchar2(32767),
  is_as_uuid number,
  is_generated number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_column_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_column_t (
    name varchar2,
    l_type varchar2,
    is_nullable number,
    default_value varchar2,
    is_as_uuid number,
    is_generated number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) The column name.

l_type

(optional) The column type.

is_nullable

(optional) The column nullable flag.

default_value

(optional) The column default value.

is_as_uuid

(optional) True if the STRING column was declared AS UUID.

is_generated

(optional) True if the STRING AS UUID column is also GENERATED BY DEFAULT.

DBMS_CLOUD_OCI_NOSQL_INDEX_KEY_T Type

Specifies a single key in a secondary index.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_key_t FORCE AUTHID CURRENT_USER IS OBJECT (
  column_name varchar2(32767),
  json_path varchar2(32767),
  json_field_type varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_key_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_key_t (
    column_name varchar2,
    json_path varchar2,
    json_field_type varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

column_name

(required) The name of a column to be included as an index key.

json_path

(optional) If the specified column is of type JSON, jsonPath contains a dotted path indicating the field within the JSON object that will be the index key.

json_field_type

(optional) If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath.

DBMS_CLOUD_OCI_NOSQL_INDEX_KEY_TBL Type

Nested table type of dbms_cloud_oci_nosql_index_key_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_key_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_index_key_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_CREATE_INDEX_DETAILS_T Type

Specifications for the new index.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_create_index_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  compartment_id varchar2(32767),
  keys dbms_cloud_oci_nosql_index_key_tbl,
  is_if_not_exists number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_index_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_index_details_t (
    name varchar2,
    compartment_id varchar2,
    keys dbms_cloud_oci_nosql_index_key_tbl,
    is_if_not_exists number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Index name.

compartment_id

(optional) The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.

keys

(required) A set of keys for a secondary index.

is_if_not_exists

(optional) If true, the operation completes successfully even when the index exists. Otherwise, an attempt to create an index that already exists will return an error.

DBMS_CLOUD_OCI_NOSQL_CREATE_REPLICA_DETAILS_T Type

Specifications for the new replica

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_create_replica_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  l_region varchar2(32767),
  max_read_units number,
  max_write_units number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_replica_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_replica_details_t (
    compartment_id varchar2,
    l_region varchar2,
    max_read_units number,
    max_write_units number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(optional) The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.

l_region

(required) Name of the remote region in standard OCI format, i.e. us-ashburn-1

max_read_units

(optional) Maximum sustained read throughput limit for the new replica table. If not specified, the local table's read limit is used.

max_write_units

(optional) Maximum sustained write throughput limit for the new replica table. If not specified, the local table's write limit is used.

DBMS_CLOUD_OCI_NOSQL_TABLE_LIMITS_T Type

Throughput and storage limits configuration of a table.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_limits_t FORCE AUTHID CURRENT_USER IS OBJECT (
  max_read_units number,
  max_write_units number,
  max_storage_in_g_bs number,
  capacity_mode varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_limits_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_limits_t (
    max_read_units number,
    max_write_units number,
    max_storage_in_g_bs number,
    capacity_mode varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

max_read_units

(required) Maximum sustained read throughput limit for the table.

max_write_units

(required) Maximum sustained write throughput limit for the table.

max_storage_in_g_bs

(required) Maximum size of storage used by the table.

capacity_mode

(optional) The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero.

Allowed values are: 'PROVISIONED', 'ON_DEMAND'

DBMS_CLOUD_OCI_NOSQL_CREATE_TABLE_DETAILS_T Type

Specifications for the new table.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_create_table_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  compartment_id varchar2(32767),
  ddl_statement varchar2(32767),
  table_limits dbms_cloud_oci_nosql_table_limits_t,
  is_auto_reclaimable number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_table_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_create_table_details_t (
    name varchar2,
    compartment_id varchar2,
    ddl_statement varchar2,
    table_limits dbms_cloud_oci_nosql_table_limits_t,
    is_auto_reclaimable number,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(required) Table name.

compartment_id

(required) Compartment Identifier.

ddl_statement

(required) Complete CREATE TABLE DDL statement.

table_limits

(optional)

is_auto_reclaimable

(optional) True if table can be reclaimed after an idle period.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_NOSQL_REQUEST_USAGE_T Type

The usage metrics for a request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_request_usage_t FORCE AUTHID CURRENT_USER IS OBJECT (
  read_units_consumed number,
  write_units_consumed number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_request_usage_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_request_usage_t (
    read_units_consumed number,
    write_units_consumed number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

read_units_consumed

(optional) Read Units consumed by this operation.

write_units_consumed

(optional) Write Units consumed by this operation.

DBMS_CLOUD_OCI_NOSQL_DELETE_ROW_RESULT_T Type

The result of a DeleteRow operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_delete_row_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  is_success number,
  existing_version varchar2(32767),
  existing_value json_element_t,
  usage dbms_cloud_oci_nosql_request_usage_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_delete_row_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_delete_row_result_t (
    is_success number,
    existing_version varchar2,
    existing_value json_element_t,
    usage dbms_cloud_oci_nosql_request_usage_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

is_success

(optional) Convey the success or failure of the operation.

existing_version

(optional) The version string associated with the existing row. Returned if the delete fails due to options setting in the request.

existing_value

(optional) The map of values from a row.

usage

(optional)

DBMS_CLOUD_OCI_NOSQL_ERROR_T Type

Error Information.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_error_t (
    code varchar2,
    message varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A short error code that defines the error, meant for programmatic parsing.

message

(required) A human-readable error string.

DBMS_CLOUD_OCI_NOSQL_IDENTITY_T Type

The identity properties of a table, if any.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_identity_t FORCE AUTHID CURRENT_USER IS OBJECT (
  column_name varchar2(32767),
  is_always number,
  is_null number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_identity_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_identity_t (
    column_name varchar2,
    is_always number,
    is_null number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

column_name

(optional) The name of the identity column.

is_always

(optional) True if the identity value is GENERATED ALWAYS.

is_null

(optional) True if the identity value is GENERATED BY DEFAULT ON NULL.

DBMS_CLOUD_OCI_NOSQL_INDEX_T Type

Information about an index.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  compartment_id varchar2(32767),
  table_name varchar2(32767),
  table_id varchar2(32767),
  keys dbms_cloud_oci_nosql_index_key_tbl,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_t (
    name varchar2,
    compartment_id varchar2,
    table_name varchar2,
    table_id varchar2,
    keys dbms_cloud_oci_nosql_index_key_tbl,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) Index name.

compartment_id

(optional) Compartment Identifier.

table_name

(optional) The name of the table to which this index belongs.

table_id

(optional) the OCID of the table to which this index belongs.

keys

(optional) A set of keys for a secondary index.

lifecycle_state

(optional) The state of an index.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED'

lifecycle_details

(optional) A message describing the current state in more detail.

DBMS_CLOUD_OCI_NOSQL_INDEX_SUMMARY_T Type

Information about an index.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  name varchar2(32767),
  keys dbms_cloud_oci_nosql_index_key_tbl,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_summary_t (
    name varchar2,
    keys dbms_cloud_oci_nosql_index_key_tbl,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

name

(optional) Index name.

keys

(optional) A set of keys for a secondary index.

lifecycle_state

(optional) The state of an index.

lifecycle_details

(optional) A message describing the current state in more detail.

DBMS_CLOUD_OCI_NOSQL_INDEX_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_nosql_index_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_index_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_INDEX_COLLECTION_T Type

Results of ListIndexes.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_index_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_index_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_index_collection_t (
    items dbms_cloud_oci_nosql_index_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of IndexSummary objects.

DBMS_CLOUD_OCI_NOSQL_PREPARED_STATEMENT_T Type

The result of query preparation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_prepared_statement_t FORCE AUTHID CURRENT_USER IS OBJECT (
  statement varchar2(32767),
  query_plan json_element_t,
  usage dbms_cloud_oci_nosql_request_usage_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_prepared_statement_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_prepared_statement_t (
    statement varchar2,
    query_plan json_element_t,
    usage dbms_cloud_oci_nosql_request_usage_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

statement

(optional) A base64-encoded, compiled and parameterized version of a SQL statement.

query_plan

(optional) A representation of the query plan as a schema-less JSON object.

usage

(optional)

DBMS_CLOUD_OCI_NOSQL_QUERY_DETAILS_T Type

All the information surrounding a query, including the query statement, limits, consistency, and so forth.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_query_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  statement varchar2(32767),
  is_prepared number,
  consistency varchar2(32767),
  max_read_in_k_bs number,
  variables json_element_t,
  timeout_in_ms number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_query_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_query_details_t (
    compartment_id varchar2,
    statement varchar2,
    is_prepared number,
    consistency varchar2,
    max_read_in_k_bs number,
    variables json_element_t,
    timeout_in_ms number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(required) Compartment OCID, to provide context for a table name in the given statement.

statement

(required) A NoSQL SQL query statement; or a Base64-encoded prepared statement.

is_prepared

(optional) If true, the statement is a prepared statement.

consistency

(optional) Consistency requirement for a read operation.

Allowed values are: 'EVENTUAL', 'ABSOLUTE'

max_read_in_k_bs

(optional) A limit on the total amount of data read during this operation, in KB.

variables

(optional) A map of prepared statement variables to values.

timeout_in_ms

(optional) Timeout setting for the query.

DBMS_CLOUD_OCI_NOSQL_JSON_ELEMENT_T_TBL Type

Nested table type of json_element_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_json_element_t_tbl FORCE IS TABLE OF (json_element_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_QUERY_RESULT_COLLECTION_T Type

The result of a query.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_query_result_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_json_element_t_tbl,
  usage dbms_cloud_oci_nosql_request_usage_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_query_result_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_query_result_collection_t (
    items dbms_cloud_oci_nosql_json_element_t_tbl,
    usage dbms_cloud_oci_nosql_request_usage_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) Array of objects representing query results.

usage

(optional)

DBMS_CLOUD_OCI_NOSQL_REPLICA_T Type

Information about a MR table replica

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_replica_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_region varchar2(32767),
  table_id varchar2(32767),
  max_write_units number,
  capacity_mode varchar2(32767),
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_replica_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_replica_t (
    l_region varchar2,
    table_id varchar2,
    max_write_units number,
    capacity_mode varchar2,
    lifecycle_state varchar2,
    lifecycle_details varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_region

(optional) A customer-facing region identifier

table_id

(optional) The OCID of the replica table

max_write_units

(optional) Maximum sustained write throughput limit of the replica table.

capacity_mode

(optional) The capacity mode of the replica.

Allowed values are: 'PROVISIONED', 'ON_DEMAND'

lifecycle_state

(optional) The state of the replica.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING'

lifecycle_details

(optional) A message describing the current state in more detail.

DBMS_CLOUD_OCI_NOSQL_ROW_T Type

The result of GetRow.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_row_t FORCE AUTHID CURRENT_USER IS OBJECT (
  value json_element_t,
  time_of_expiration timestamp with time zone,
  usage dbms_cloud_oci_nosql_request_usage_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_row_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_row_t (
    value json_element_t,
    time_of_expiration timestamp with time zone,
    usage dbms_cloud_oci_nosql_request_usage_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

value

(optional) The map of values from a row.

time_of_expiration

(optional) The expiration time of the row. A zero value indicates that the row does not expire. An RFC3339 formatted datetime string.

usage

(optional)

DBMS_CLOUD_OCI_NOSQL_COLUMN_TBL Type

Nested table type of dbms_cloud_oci_nosql_column_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_column_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_column_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_SCHEMA_T Type

The table schema information as a JSON object.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_schema_t FORCE AUTHID CURRENT_USER IS OBJECT (
  l_columns dbms_cloud_oci_nosql_column_tbl,
  primary_key dbms_cloud_oci_nosql_varchar2_tbl,
  shard_key dbms_cloud_oci_nosql_varchar2_tbl,
  ttl number,
  identity dbms_cloud_oci_nosql_identity_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_schema_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_schema_t (
    l_columns dbms_cloud_oci_nosql_column_tbl,
    primary_key dbms_cloud_oci_nosql_varchar2_tbl,
    shard_key dbms_cloud_oci_nosql_varchar2_tbl,
    ttl number,
    identity dbms_cloud_oci_nosql_identity_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

l_columns

(required) The columns of a table.

primary_key

(required) A list of column names that make up a key.

shard_key

(required) A list of column names that make up a key.

ttl

(required) The default Time-to-Live for the table, in days.

identity

(optional)

DBMS_CLOUD_OCI_NOSQL_STATEMENT_SUMMARY_T Type

Information derived from parsing a NoSQL SQL statement.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_statement_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation varchar2(32767),
  table_name varchar2(32767),
  index_name varchar2(32767),
  is_if_exists number,
  is_if_not_exists number,
  syntax_error varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_statement_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_statement_summary_t (
    operation varchar2,
    table_name varchar2,
    index_name varchar2,
    is_if_exists number,
    is_if_not_exists number,
    syntax_error varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation

(optional) The operation represented in the statement, e.g. CREATE_TABLE.

Allowed values are: 'CREATE_TABLE', 'ALTER_TABLE', 'DROP_TABLE', 'CREATE_INDEX', 'DROP_INDEX', 'SELECT', 'UPDATE', 'INSERT', 'DELETE'

table_name

(optional) The table name from the SQL statement.

index_name

(optional) The index name from the SQL statement, if present.

is_if_exists

(optional) True if the statement includes \"IF EXISTS.\"

is_if_not_exists

(optional) True if the statement includes \"IF NOT EXISTS.\"

syntax_error

(optional) If present, indicates a syntax error in the statement.

DBMS_CLOUD_OCI_NOSQL_REPLICA_TBL Type

Nested table type of dbms_cloud_oci_nosql_replica_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_replica_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_replica_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_TABLE_T Type

Complete metadata about a table.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  name varchar2(32767),
  compartment_id varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  table_limits dbms_cloud_oci_nosql_table_limits_t,
  lifecycle_state varchar2(32767),
  is_auto_reclaimable number,
  time_of_expiration timestamp with time zone,
  lifecycle_details varchar2(32767),
  schema dbms_cloud_oci_nosql_schema_t,
  ddl_statement varchar2(32767),
  schema_state varchar2(32767),
  is_multi_region number,
  local_replica_initialization_in_percent number,
  replicas dbms_cloud_oci_nosql_replica_tbl,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_t (
    id varchar2,
    name varchar2,
    compartment_id varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    table_limits dbms_cloud_oci_nosql_table_limits_t,
    lifecycle_state varchar2,
    is_auto_reclaimable number,
    time_of_expiration timestamp with time zone,
    lifecycle_details varchar2,
    schema dbms_cloud_oci_nosql_schema_t,
    ddl_statement varchar2,
    schema_state varchar2,
    is_multi_region number,
    local_replica_initialization_in_percent number,
    replicas dbms_cloud_oci_nosql_replica_tbl,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable.

name

(optional) Human-friendly table name, immutable.

compartment_id

(required) Compartment Identifier.

time_created

(optional) The time the the table was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

table_limits

(optional)

lifecycle_state

(optional) The state of a table.

Allowed values are: 'CREATING', 'UPDATING', 'ACTIVE', 'DELETING', 'DELETED', 'FAILED', 'INACTIVE'

is_auto_reclaimable

(optional) True if this table can be reclaimed after an idle period.

time_of_expiration

(optional) If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.

lifecycle_details

(optional) A message describing the current state in more detail.

schema

(optional)

ddl_statement

(optional) A DDL statement representing the schema.

schema_state

(optional) The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.

Allowed values are: 'MUTABLE', 'FROZEN'

is_multi_region

(optional) True if this table is currently a member of a replication set.

local_replica_initialization_in_percent

(optional) If this table is in a replication set, this value represents the progress of the initialization of the replica's data. A value of 100 indicates that initialization has completed.

replicas

(optional) An array of Replica listing this table's replicas, if any

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is `\"orcl-cloud\"`; and the only key in that namespace is `\"free-tier-retained\"`. Example: `{\"orcl-cloud\"\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_NOSQL_TABLE_SUMMARY_T Type

Summary of the table.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  id varchar2(32767),
  compartment_id varchar2(32767),
  name varchar2(32767),
  time_created timestamp with time zone,
  time_updated timestamp with time zone,
  table_limits dbms_cloud_oci_nosql_table_limits_t,
  lifecycle_state varchar2(32767),
  lifecycle_details varchar2(32767),
  is_auto_reclaimable number,
  time_of_expiration timestamp with time zone,
  schema_state varchar2(32767),
  is_multi_region number,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  system_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_summary_t (
    id varchar2,
    compartment_id varchar2,
    name varchar2,
    time_created timestamp with time zone,
    time_updated timestamp with time zone,
    table_limits dbms_cloud_oci_nosql_table_limits_t,
    lifecycle_state varchar2,
    lifecycle_details varchar2,
    is_auto_reclaimable number,
    time_of_expiration timestamp with time zone,
    schema_state varchar2,
    is_multi_region number,
    freeform_tags json_element_t,
    defined_tags json_element_t,
    system_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

id

(required) Unique identifier that is immutable on creation.

compartment_id

(required) Compartment Identifier.

name

(optional) Human-friendly table name, also immutable.

time_created

(optional) The time the the table was created. An RFC3339 formatted datetime string.

time_updated

(optional) The time the the table's metadata was last updated. An RFC3339 formatted datetime string.

table_limits

(optional)

lifecycle_state

(optional) The state of a table.

lifecycle_details

(optional) A message describing the current state in more detail.

is_auto_reclaimable

(optional) True if this table can be reclaimed after an idle period.

time_of_expiration

(optional) If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string.

schema_state

(optional) The current state of this table's schema. Available states are MUTABLE - The schema can be changed. The table is not eligible for replication. FROZEN - The schema is immutable. The table is eligible for replication.

Allowed values are: 'MUTABLE', 'FROZEN'

is_multi_region

(optional) True if this table is currently a member of a replication set.

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

system_tags

(optional) Read-only system tag. These predefined keys are scoped to namespaces. At present the only supported namespace is `\"orcl-cloud\"`; and the only key in that namespace is `\"free-tier-retained\"`. Example: `{\"orcl-cloud\"\": {\"free-tier-retained\": \"true\"}}`

DBMS_CLOUD_OCI_NOSQL_TABLE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_nosql_table_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_table_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_TABLE_COLLECTION_T Type

Results of ListTables.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_table_summary_tbl,
  max_auto_reclaimable_tables number,
  auto_reclaimable_tables number,
  on_demand_capacity_tables number,
  max_on_demand_capacity_tables number,
  available_replication_regions dbms_cloud_oci_nosql_varchar2_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_collection_t (
    items dbms_cloud_oci_nosql_table_summary_tbl,
    max_auto_reclaimable_tables number,
    auto_reclaimable_tables number,
    on_demand_capacity_tables number,
    max_on_demand_capacity_tables number,
    available_replication_regions dbms_cloud_oci_nosql_varchar2_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of TableSummary objects.

max_auto_reclaimable_tables

(optional) The maximum number of reclaimable tables allowed in the tenancy.

auto_reclaimable_tables

(optional) The current number of reclaimable tables in the tenancy.

on_demand_capacity_tables

(optional) The current number of on demand capacity tables in the tenancy.

max_on_demand_capacity_tables

(optional) The maximum number of on demand capacity tables allowed in the tenancy.

available_replication_regions

(optional) An array of regions that are available for replication.

DBMS_CLOUD_OCI_NOSQL_TABLE_USAGE_SUMMARY_T Type

TableUsageSummary represents a single usage record, or slice, that includes information about read and write throughput consumed during that period as well as the current information regarding storage capacity. In addition the count of throttling exceptions for the period is reported.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_usage_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  seconds_in_period number,
  read_units number,
  write_units number,
  storage_in_g_bs number,
  read_throttle_count number,
  write_throttle_count number,
  storage_throttle_count number,
  max_shard_size_usage_in_percent number,
  time_started timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_usage_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_usage_summary_t (
    seconds_in_period number,
    read_units number,
    write_units number,
    storage_in_g_bs number,
    read_throttle_count number,
    write_throttle_count number,
    storage_throttle_count number,
    max_shard_size_usage_in_percent number,
    time_started timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

seconds_in_period

(optional) The length of the sampling period.

read_units

(optional) Read throughput during the sampling period.

write_units

(optional) Write throughput during the sampling period.

storage_in_g_bs

(optional) The size of the table, in GB.

read_throttle_count

(optional) The number of times reads were throttled due to exceeding the read throughput limit.

write_throttle_count

(optional) The number of times writes were throttled due to exceeding the write throughput limit.

storage_throttle_count

(optional) The number of times writes were throttled because the table exceeded its size limit.

max_shard_size_usage_in_percent

(optional) The percentage of allowed per-shard usage for the table shard with the highest usage.

time_started

(optional) The time stamp of this usage record.

DBMS_CLOUD_OCI_NOSQL_TABLE_USAGE_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_nosql_table_usage_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_usage_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_table_usage_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_TABLE_USAGE_COLLECTION_T Type

Result of GetTableUsage.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_table_usage_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_table_usage_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_usage_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_table_usage_collection_t (
    items dbms_cloud_oci_nosql_table_usage_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of TableUsageSummary objects.

DBMS_CLOUD_OCI_NOSQL_UPDATE_ROW_DETAILS_T Type

Specifications for the putting of a table row.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_update_row_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  value json_element_t,
  l_option varchar2(32767),
  is_get_return_row number,
  timeout_in_ms number,
  ttl number,
  is_ttl_use_table_default number,
  identity_cache_size number,
  is_exact_match number,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_row_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_row_details_t (
    compartment_id varchar2,
    value json_element_t,
    l_option varchar2,
    is_get_return_row number,
    timeout_in_ms number,
    ttl number,
    is_ttl_use_table_default number,
    identity_cache_size number,
    is_exact_match number
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(optional) The OCID of the table's compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.

value

(required) The map of values from a row.

l_option

(optional) Specifies a condition for the put operation.

Allowed values are: 'IF_ABSENT', 'IF_PRESENT'

is_get_return_row

(optional) If true, and the put fails due to an option setting, then the existing row will be returned.

timeout_in_ms

(optional) Timeout setting for the put.

ttl

(optional) Time-to-live for the row, in days.

is_ttl_use_table_default

(optional) If true, set time-to-live for this row to the table's default.

identity_cache_size

(optional) Sets the number of generated identity values that are requested from the server during a put. If present and greater than 0, this value takes precedence over a default value for the table.

is_exact_match

(optional) If present and true, the presented row value must exactly match the table's schema. Otherwise, rows with missing non-key fields or extra fields can be written successfully.

DBMS_CLOUD_OCI_NOSQL_UPDATE_ROW_RESULT_T Type

The result of an UpdateRow operation.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_update_row_result_t FORCE AUTHID CURRENT_USER IS OBJECT (
  version varchar2(32767),
  existing_version varchar2(32767),
  existing_value json_element_t,
  generated_value varchar2(32767),
  usage dbms_cloud_oci_nosql_request_usage_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_row_result_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_row_result_t (
    version varchar2,
    existing_version varchar2,
    existing_value json_element_t,
    generated_value varchar2,
    usage dbms_cloud_oci_nosql_request_usage_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

version

(optional) An opaque version string associated with the row.

existing_version

(optional) The version string associated with the existing row. Returned if the put fails due to options setting in the request.

existing_value

(optional) The map of values from a row.

generated_value

(optional) The value generated if the operation created a new value for an identity column. If the table has no identity column, this value is null. If it has an identity column, and a value was generated for that column, it is non-null.

usage

(optional)

DBMS_CLOUD_OCI_NOSQL_UPDATE_TABLE_DETAILS_T Type

The information to be updated.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_update_table_details_t FORCE AUTHID CURRENT_USER IS OBJECT (
  compartment_id varchar2(32767),
  ddl_statement varchar2(32767),
  table_limits dbms_cloud_oci_nosql_table_limits_t,
  freeform_tags json_element_t,
  defined_tags json_element_t,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_table_details_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_update_table_details_t (
    compartment_id varchar2,
    ddl_statement varchar2,
    table_limits dbms_cloud_oci_nosql_table_limits_t,
    freeform_tags json_element_t,
    defined_tags json_element_t
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

compartment_id

(optional) The OCID of the table's current compartment. Required if the tableNameOrId path parameter is a table name. Optional if tableNameOrId is an OCID. If tableNameOrId is an OCID, and compartmentId is supplied, the latter must match the identified table's compartmentId.

ddl_statement

(optional) Complete ALTER TABLE DDL statement.

table_limits

(optional)

freeform_tags

(optional) Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{\"bar-key\": \"value\"}`

defined_tags

(optional) Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{\"foo-namespace\": {\"bar-key\": \"value\"}}`

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_RESOURCE_T Type

A resource created or operated on by a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_resource_t FORCE AUTHID CURRENT_USER IS OBJECT (
  entity_type varchar2(32767),
  action_type varchar2(32767),
  identifier varchar2(32767),
  entity_uri varchar2(32767),
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_resource_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_resource_t (
    entity_type varchar2,
    action_type varchar2,
    identifier varchar2,
    entity_uri varchar2
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

entity_type

(required) The resource type the work request affects.

action_type

(required) The way in which this resource is affected by the work tracked in the work request. A resource being created, updated, or deleted will remain in the IN_PROGRESS state until work is complete for that resource at which point it will transition to CREATED, UPDATED, or DELETED, respectively.

Allowed values are: 'CREATED', 'UPDATED', 'DELETED', 'IN_PROGRESS'

identifier

(required) The identifier of the resource the work request affects.

entity_uri

(optional) The URI path to access the resource metadata.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_RESOURCE_TBL Type

Nested table type of dbms_cloud_oci_nosql_work_request_resource_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_resource_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_work_request_resource_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_T Type

A description of workrequest status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_nosql_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_nosql_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_TABLE', 'UPDATE_TABLE', 'DELETE_TABLE'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_SUMMARY_T Type

A description of workrequest status.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_summary_t FORCE AUTHID CURRENT_USER IS OBJECT (
  operation_type varchar2(32767),
  status varchar2(32767),
  id varchar2(32767),
  compartment_id varchar2(32767),
  resources dbms_cloud_oci_nosql_work_request_resource_tbl,
  percent_complete number,
  time_accepted timestamp with time zone,
  time_started timestamp with time zone,
  time_finished timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_summary_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_summary_t (
    operation_type varchar2,
    status varchar2,
    id varchar2,
    compartment_id varchar2,
    resources dbms_cloud_oci_nosql_work_request_resource_tbl,
    percent_complete number,
    time_accepted timestamp with time zone,
    time_started timestamp with time zone,
    time_finished timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

operation_type

(required) Type of the work request.

Allowed values are: 'CREATE_TABLE', 'UPDATE_TABLE', 'DELETE_TABLE'

status

(required) Status of current work request.

Allowed values are: 'ACCEPTED', 'IN_PROGRESS', 'FAILED', 'SUCCEEDED', 'CANCELING', 'CANCELED'

id

(required) The id of the work request.

compartment_id

(required) The ocid of the compartment that contains the work request.

resources

(required) The resources affected by this work request.

percent_complete

(required) Percentage of the request completed.

time_accepted

(required) The date and time the request was created, as described in RFC 3339, section 14.29.

time_started

(optional) The date and time the request was started, as described in RFC 3339, section 14.29.

time_finished

(optional) The date and time the object was finished, as described in RFC 3339.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_SUMMARY_TBL Type

Nested table type of dbms_cloud_oci_nosql_work_request_summary_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_summary_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_work_request_summary_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_COLLECTION_T Type

Results of ListWorkRequests

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_work_request_summary_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_collection_t (
    items dbms_cloud_oci_nosql_work_request_summary_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of WorkRequestSummary objects.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_ERROR_T Type

An error encountered while executing a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_error_t FORCE AUTHID CURRENT_USER IS OBJECT (
  code varchar2(32767),
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_error_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_error_t (
    code varchar2,
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

code

(required) A machine-usable code for the error that occured. Error codes are listed on (https://docs.us-phoenix-1.oraclecloud.com/Content/API/References/apierrors.htm)

message

(required) A human readable description of the issue encountered.

l_timestamp

(required) The time the error occured. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_ERROR_TBL Type

Nested table type of dbms_cloud_oci_nosql_work_request_error_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_error_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_work_request_error_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_ERROR_COLLECTION_T Type

Results of ListWorkRequestErrors

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_error_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_work_request_error_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_error_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_error_collection_t (
    items dbms_cloud_oci_nosql_work_request_error_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of WorkRequestError objects.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_LOG_ENTRY_T Type

A log message from the execution of a work request.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_log_entry_t FORCE AUTHID CURRENT_USER IS OBJECT (
  message varchar2(32767),
  l_timestamp timestamp with time zone,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_log_entry_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_log_entry_t (
    message varchar2,
    l_timestamp timestamp with time zone
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

message

(required) Human-readable log message.

l_timestamp

(required) The time the log message was written. An RFC3339 formatted datetime string.

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_LOG_ENTRY_TBL Type

Nested table type of dbms_cloud_oci_nosql_work_request_log_entry_t.

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_log_entry_tbl FORCE IS TABLE OF (dbms_cloud_oci_nosql_work_request_log_entry_t) NOT PERSISTABLE;

DBMS_CLOUD_OCI_NOSQL_WORK_REQUEST_LOG_ENTRY_COLLECTION_T Type

Results of ListWorkRequestLogs

Syntax

CREATE OR REPLACE NONEDITIONABLE TYPE dbms_cloud_oci_nosql_work_request_log_entry_collection_t FORCE AUTHID CURRENT_USER IS OBJECT (
  items dbms_cloud_oci_nosql_work_request_log_entry_tbl,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_log_entry_collection_t
    RETURN SELF AS RESULT,
  CONSTRUCTOR FUNCTION dbms_cloud_oci_nosql_work_request_log_entry_collection_t (
    items dbms_cloud_oci_nosql_work_request_log_entry_tbl
  ) RETURN SELF AS RESULT
) NOT PERSISTABLE;

Fields

Field Description

items

(optional) A page of WorkRequestLogEntry objects.

Was this article helpful?