openapi: 3.2.0 info: description: 'The control plane API for NoSQL Database Cloud Service HTTPS provides endpoints to perform NDCS operations, including creation and deletion of tables and indexes; population and access of data in tables; and access of table usage metrics. ' title: Database Nosql API version: '20190828' x-provenance: method: harvested first_party: true publisher: Oracle source: https://docs.oracle.com/en-us/iaas/api/specs/12cc3142be3f1a80f0b5ac96581767826a55104bd1ae80465b4ebbbbde27be43.yaml harvested: '2026-08-04' note: Published by Oracle as the contract for the NoSQL Database API OCI service and stored verbatim; API Evangelist added only this provenance block. x-evidence: - url: https://docs.oracle.com/en-us/iaas/api/specs/index.json what: Oracle's own index of every OCI service specification - url: https://docs.oracle.com/en-us/iaas/api/specs/12cc3142be3f1a80f0b5ac96581767826a55104bd1ae80465b4ebbbbde27be43.yaml what: the harvested document for NoSQL Database API servers: - url: https://127.0.0.1/20190828 tags: - name: nosql paths: /query: post: description: Execute a SQL query. operationId: Query parameters: - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: 'QueryResultCollection comprises an array of results and usage information. ' headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/QueryResultCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Execute a SQL query. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/QueryResultCollection' requestBody: content: application/json: schema: $ref: '#/components/schemas/QueryDetails' description: SQL query statement and ancillary information. required: true /query/prepare: get: description: 'Prepare a SQL statement for use in a query with variable substitution. ' operationId: PrepareStatement parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - description: A NoSQL SQL statement. in: query name: statement required: true schema: type: string - description: Include a query execution plan in the result. in: query name: isGetQueryPlan required: false schema: type: boolean default: false - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: PreparedStatement headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/PreparedStatement' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: 'Prepare a SQL statement for use in a query with variable substitution. ' tags: - nosql x-related-resource: '#/definitions/QueryResultCollection' /query/summarize: get: description: 'Check the syntax and return a brief summary of a SQL statement. ' operationId: SummarizeStatement parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - description: A NoSQL SQL statement. in: query name: statement required: true schema: type: string - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A summary of the SQL statement. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/StatementSummary' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Check the syntax and return a brief summary of a SQL statement. tags: - nosql x-related-resource: '#/definitions/QueryResultCollection' /tables: get: description: Get a list of tables in a compartment. operationId: ListTables parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/LifecycleStateQueryParam' responses: 200: description: A collection of TableSummary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TableCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of tables in a compartment. tags: - nosql x-related-resource: '#/definitions/Table' post: description: Create a new table. operationId: CreateTable parameters: - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The table will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a new table. tags: - nosql x-related-resource: '#/definitions/Table' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateTableDetails' description: Specifications for the new table. required: true /tables/{tableNameOrId}: delete: description: Delete a table by tableNameOrId. operationId: DeleteTable parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/IfExistsQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The table will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a table by tableNameOrId. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Table' get: description: Get table info by identifier. operationId: GetTable parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Table metadata. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Table' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get table info by identifier. tags: - nosql put: description: 'Alter the table identified by tableNameOrId, changing schema, limits, or tags ' operationId: UpdateTable parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The table will be updated. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Alter the table identified by tableNameOrId. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Table' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateTableDetails' description: Specifications for the alteration. required: true /tables/{tableNameOrId}/actions/changeCompartment: post: description: Change a table's compartment. operationId: ChangeTableCompartment parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The table's compartment will be changed. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Change a table's compartment. tags: - nosql x-related-resource: '#/definitions/Table' requestBody: content: application/json: schema: $ref: '#/components/schemas/ChangeTableCompartmentDetails' description: Specifications of the source and target compartments. required: true /tables/{tableNameOrId}/indexes: get: description: Get a list of indexes on a table. operationId: ListIndexes parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/NameQueryParam' - $ref: '#/components/parameters/LifecycleStateQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/SortOrderQueryParam' - $ref: '#/components/parameters/SortByQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: A collection of IndexSummary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/IndexCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a list of indexes on a table. tags: - nosql x-related-resource: '#/definitions/Index' post: description: Create a new index on the table identified by tableNameOrId. operationId: CreateIndex parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The index will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Create a new index. tags: - nosql x-related-resource: '#/definitions/Index' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateIndexDetails' description: Specifications for the new index. required: true /tables/{tableNameOrId}/indexes/{indexName}: delete: description: Delete an index from the table identified by tableNameOrId. operationId: DeleteIndex parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/IndexNamePathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/IfExistsQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The index will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete an index. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Index' get: description: Get information about a single index. operationId: GetIndex parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/IndexNamePathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Index metadata. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Index' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get information about a single index. tags: - nosql /tables/{tableNameOrId}/replicas: post: description: Add a replica for this table. The table's schema must be frozen prior to this operation. operationId: CreateReplica parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/RetryTokenHeader' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: The replica will be created. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 409: $ref: '#/components/responses/409' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Add a replica for this table. The table's schema must be frozen prior to this operation. tags: - nosql x-related-resource: '#/definitions/Table' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateReplicaDetails' description: Specifications for the new replica required: true /tables/{tableNameOrId}/replicas/{region}: delete: description: Delete the specified replica table in the remote region. operationId: DeleteReplica parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/RegionPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The replica will be deleted. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a replica. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Table' /tables/{tableNameOrId}/rows: delete: description: Delete a single row from the table, by primary key. operationId: DeleteRow parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/GetReturnRowQueryParam' - $ref: '#/components/parameters/TimeoutQueryParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Result of a delete operation. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/DeleteRowResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Delete a single row from the table, by primary key. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Row' get: description: Get a single row from the table by primary key. operationId: GetRow parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/KeyQueryParam' - $ref: '#/components/parameters/ConsistencyQueryParam' - $ref: '#/components/parameters/TimeoutQueryParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The requested row. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Row' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get a single row from the table by primary key. tags: - nosql x-related-resource: '#/definitions/Row' put: description: Write a single row into the table. operationId: UpdateRow parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: Result of a put operation. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/UpdateRowResult' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Write a single row into the table. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/Row' requestBody: content: application/json: schema: $ref: '#/components/schemas/UpdateRowDetails' description: Specifications for the putting of a table row. required: true /tables/{tableNameOrId}/usage: get: description: Get table usage info. operationId: ListTableUsage parameters: - $ref: '#/components/parameters/TableNameOrIdPathParam' - $ref: '#/components/parameters/CompartmentIdOptionalQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - description: '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. ' in: query name: timeStart required: false x-default-description: 'If timeStart is not given, the most recent usage record is returned. ' schema: type: string format: date-time - description: The end time to use for the request. in: query name: timeEnd required: false x-default-description: 'If timeEnd is not given, the current time is used as the end time. ' schema: type: string format: date-time - $ref: '#/components/parameters/PaginationLimitQueryParam' - $ref: '#/components/parameters/PaginationTokenQueryParam' responses: 200: description: A collection of TableUsageSummary. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/TableUsageCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get table usage info. tags: - nosql x-related-resource: '#/definitions/Table' /workRequests: get: description: List the work requests in a compartment. operationId: ListWorkRequests parameters: - $ref: '#/components/parameters/CompartmentIdQueryParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A collection of WorkRequest. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List the work requests in a compartment. tags: - nosql x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}: delete: description: Cancel a work request operation with the given ID. operationId: DeleteWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/IfMatchHeader' - $ref: '#/components/parameters/RequestIdHeader' responses: 202: description: Accepted the request. The work request will be canceled. headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' schema: type: string 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 412: $ref: '#/components/responses/412' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Cancel a work request operation with the given ID. tags: - nosql x-obmcs-client-retries-enabled: false x-related-resource: '#/definitions/WorkRequest' get: description: Get the status of the work request with the given ID. operationId: GetWorkRequest parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' responses: 200: description: The detail of the work request. headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string retry-after: description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again. ' schema: type: number format: float content: application/json: schema: $ref: '#/components/schemas/WorkRequest' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Get the status of the work request with the given ID. tags: - nosql x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/errors: get: description: 'Return a (paginated) list of errors for a given work request. ' operationId: ListWorkRequestErrors parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: A collection of WorkRequestError. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestErrorCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: List work request errors tags: - nosql x-related-resource: '#/definitions/WorkRequest' /workRequests/{workRequestId}/logs: get: description: 'Return a (paginated) list of logs for a given work request. ' operationId: ListWorkRequestLogs parameters: - $ref: '#/components/parameters/WorkRequestIdPathParam' - $ref: '#/components/parameters/RequestIdHeader' - $ref: '#/components/parameters/PaginationTokenQueryParam' - $ref: '#/components/parameters/PaginationLimitQueryParam' responses: 200: description: List of work request logs. headers: opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' schema: type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/WorkRequestLogEntryCollection' 400: $ref: '#/components/responses/400' 401: $ref: '#/components/responses/401' 404: $ref: '#/components/responses/404' 429: $ref: '#/components/responses/429' 500: $ref: '#/components/responses/500' default: $ref: '#/components/responses/default' summary: Lists work request logs tags: - nosql x-related-resource: '#/definitions/WorkRequest' components: parameters: GetReturnRowQueryParam: description: 'If true, and the operation fails due to an option setting (ifVersion et al), then the existing row will be returned. ' in: query name: isGetReturnRow required: false schema: type: boolean default: false NameQueryParam: description: A shell-globbing-style (*?[]) filter for names. in: query name: name required: false schema: type: string default: '*' maxLength: 256 minLength: 1 TimeoutQueryParam: description: Timeout setting for this operation. in: query name: timeoutInMs required: false schema: type: integer default: 5000 IndexNamePathParam: description: The name of a table's index. in: path name: indexName required: true schema: type: string RegionPathParam: description: A customer-facing region identifier in: path name: region required: true schema: type: string SortByQueryParam: description: '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. ' in: query name: sortBy required: false schema: type: string enum: - timeCreated - name default: timeCreated PaginationTokenQueryParam: description: 'The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call. ' in: query name: page x-default-description: 'null' schema: type: string maxLength: 1024 minLength: 1 CompartmentIdQueryParam: description: The ID of a table's compartment. in: query name: compartmentId required: true schema: type: string IfMatchHeader: description: '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. ' in: header name: if-match required: false schema: type: string format: base64 default: false IfExistsQueryParam: description: Set as true to select "if exists" behavior. in: query name: isIfExists required: false schema: type: boolean default: false PaginationLimitQueryParam: description: The maximum number of items to return. in: query name: limit schema: type: integer default: 1000 maximum: 1000 minimum: 1 ConsistencyQueryParam: description: Consistency requirement for a read operation. in: query name: consistency required: false schema: type: string enum: - EVENTUAL - ABSOLUTE default: EVENTUAL WorkRequestIdPathParam: description: The ID of the asynchronous request. in: path name: workRequestId required: true schema: type: string SortOrderQueryParam: description: The sort order to use, either 'ASC' or 'DESC'. in: query name: sortOrder required: false schema: type: string enum: - ASC - DESC default: DESC KeyQueryParam: description: 'An array of strings, each of the format "column-name:value", representing the primary key of the row. ' in: query name: key required: true style: form explode: true schema: type: array items: type: string RetryTokenHeader: description: '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. ' in: header name: opc-retry-token required: false schema: type: string maxLength: 64 minLength: 1 TableNameOrIdPathParam: description: A table name within the compartment, or a table OCID. in: path name: tableNameOrId required: true schema: type: string RequestIdHeader: description: The client request ID for tracing. in: header name: opc-request-id schema: type: string CompartmentIdOptionalQueryParam: description: '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. ' in: query name: compartmentId required: false x-default-description: 'null' schema: type: string LifecycleStateQueryParam: description: Filter list by the lifecycle state of the item. in: query name: lifecycleState required: false schema: type: string enum: - ALL - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE default: ALL schemas: Index: description: Information about an index. properties: compartmentId: description: Compartment Identifier. type: string keys: description: A set of keys for a secondary index. items: $ref: '#/components/schemas/IndexKey' type: array lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string lifecycleState: description: The state of an index. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED type: string name: description: Index name. type: string tableId: description: the OCID of the table to which this index belongs. type: string tableName: description: The name of the table to which this index belongs. type: string type: object CreateIndexDetails: description: Specifications for the new index. properties: compartmentId: description: '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. ' type: string isIfNotExists: description: '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. ' type: boolean keys: description: A set of keys for a secondary index. items: $ref: '#/components/schemas/IndexKey' type: array name: description: Index name. maxLength: 64 minLength: 1 type: string required: - name - keys type: object Identity: description: The identity properties of a table, if any. properties: columnName: description: The name of the identity column. type: string isAlways: description: True if the identity value is GENERATED ALWAYS. type: boolean isNull: description: True if the identity value is GENERATED BY DEFAULT ON NULL. type: boolean type: object RequestUsage: description: The usage metrics for a request. properties: readUnitsConsumed: description: Read Units consumed by this operation. type: integer writeUnitsConsumed: description: Write Units consumed by this operation. type: integer PreparedStatement: description: The result of query preparation. properties: queryPlan: description: 'A representation of the query plan as a schema-less JSON object. ' type: object statement: description: 'A base64-encoded, compiled and parameterized version of a SQL statement. ' format: base64 type: string usage: $ref: '#/components/schemas/RequestUsage' Error: description: Error Information. properties: code: description: 'A short error code that defines the error, meant for programmatic parsing. ' type: string message: description: A human-readable error string. type: string required: - code - message QueryResultCollection: description: The result of a query. properties: items: description: Array of objects representing query results. items: additionalProperties: type: object description: The map of values from a row. type: object type: array usage: $ref: '#/components/schemas/RequestUsage' TableLimits: description: Throughput and storage limits configuration of a table. properties: capacityMode: description: 'The capacity mode of the table. If capacityMode = ON_DEMAND, maxReadUnits and maxWriteUnits are not used, and both will have the value of zero. ' enum: - PROVISIONED - ON_DEMAND type: string maxReadUnits: description: Maximum sustained read throughput limit for the table. type: integer maxStorageInGBs: description: Maximum size of storage used by the table. type: integer maxWriteUnits: description: Maximum sustained write throughput limit for the table. type: integer required: - maxReadUnits - maxWriteUnits - maxStorageInGBs type: object WorkRequestCollection: description: Results of ListWorkRequests properties: items: description: A page of WorkRequestSummary objects. items: $ref: '#/components/schemas/WorkRequestSummary' type: array type: object TableUsageCollection: description: Result of GetTableUsage. properties: items: description: A page of TableUsageSummary objects. items: $ref: '#/components/schemas/TableUsageSummary' type: array type: object CreateTableDetails: description: Specifications for the new table. properties: compartmentId: description: Compartment Identifier. type: string ddlStatement: description: Complete CREATE TABLE DDL statement. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object isAutoReclaimable: description: True if table can be reclaimed after an idle period. type: boolean name: description: Table name. maxLength: 256 minLength: 1 type: string tableLimits: $ref: '#/components/schemas/TableLimits' required: - name - compartmentId - ddlStatement type: object DeleteRowResult: description: The result of a DeleteRow operation. properties: existingValue: additionalProperties: type: object description: The map of values from a row. type: object existingVersion: description: 'The version string associated with the existing row. Returned if the delete fails due to options setting in the request. ' format: base64 type: string isSuccess: description: Convey the success or failure of the operation. type: boolean usage: $ref: '#/components/schemas/RequestUsage' StatementSummary: description: Information derived from parsing a NoSQL SQL statement. properties: indexName: description: The index name from the SQL statement, if present. type: string isIfExists: description: True if the statement includes "IF EXISTS." type: boolean isIfNotExists: description: True if the statement includes "IF NOT EXISTS." type: boolean operation: description: 'The operation represented in the statement, e.g. CREATE_TABLE. ' enum: - CREATE_TABLE - ALTER_TABLE - DROP_TABLE - CREATE_INDEX - DROP_INDEX - SELECT - UPDATE - INSERT - DELETE type: string syntaxError: description: If present, indicates a syntax error in the statement. type: string tableName: description: The table name from the SQL statement. type: string IndexCollection: description: Results of ListIndexes. properties: items: description: A page of IndexSummary objects. items: $ref: '#/components/schemas/IndexSummary' type: array type: object TableUsageSummary: description: '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. ' properties: maxShardSizeUsageInPercent: description: 'The percentage of allowed per-shard usage for the table shard with the highest usage. ' type: integer readThrottleCount: description: 'The number of times reads were throttled due to exceeding the read throughput limit. ' type: integer readUnits: description: Read throughput during the sampling period. type: integer secondsInPeriod: description: The length of the sampling period. type: integer storageInGBs: description: The size of the table, in GB. type: integer storageThrottleCount: description: 'The number of times writes were throttled because the table exceeded its size limit. ' type: integer timeStarted: description: 'The time stamp of this usage record. ' format: date-time type: string writeThrottleCount: description: 'The number of times writes were throttled due to exceeding the write throughput limit. ' type: integer writeUnits: description: Write throughput during the sampling period. type: integer type: object IndexSummary: description: Information about an index. properties: keys: description: A set of keys for a secondary index. items: $ref: '#/components/schemas/IndexKey' type: array lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string lifecycleState: description: The state of an index. type: string x-obmcs-enumref: '#/definitions/Index/lifecycleState' name: description: Index name. type: string type: object Row: description: The result of GetRow. properties: timeOfExpiration: description: 'The expiration time of the row. A zero value indicates that the row does not expire. An RFC3339 formatted datetime string. ' format: date-time type: string usage: $ref: '#/components/schemas/RequestUsage' value: additionalProperties: type: object description: The map of values from a row. type: object Column: description: A column of a table. properties: defaultValue: description: The column default value. type: string isAsUuid: description: True if the STRING column was declared AS UUID. type: boolean isGenerated: description: 'True if the STRING AS UUID column is also GENERATED BY DEFAULT. ' type: boolean isNullable: description: The column nullable flag. type: boolean name: description: The column name. maxLength: 64 minLength: 1 type: string type: description: The column type. type: string type: object WorkRequestResource: description: A resource created or operated on by a work request. properties: actionType: description: '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. ' enum: - CREATED - UPDATED - DELETED - IN_PROGRESS type: string entityType: description: The resource type the work request affects. type: string entityUri: description: The URI path to access the resource metadata. type: string identifier: description: The identifier of the resource the work request affects. type: string required: - actionType - entityType - identifier UpdateRowResult: description: The result of an UpdateRow operation. properties: existingValue: additionalProperties: type: object description: The map of values from a row. type: object existingVersion: description: 'The version string associated with the existing row. Returned if the put fails due to options setting in the request. ' format: base64 type: string generatedValue: description: '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. ' type: string usage: $ref: '#/components/schemas/RequestUsage' version: description: An opaque version string associated with the row. format: base64 type: string TableCollection: description: Results of ListTables. properties: autoReclaimableTables: description: The current number of reclaimable tables in the tenancy. type: integer availableReplicationRegions: description: An array of regions that are available for replication. items: type: string type: array items: description: A page of TableSummary objects. items: $ref: '#/components/schemas/TableSummary' type: array maxAutoReclaimableTables: description: The maximum number of reclaimable tables allowed in the tenancy. type: integer maxOnDemandCapacityTables: description: The maximum number of on demand capacity tables allowed in the tenancy. type: integer onDemandCapacityTables: description: The current number of on demand capacity tables in the tenancy. type: integer type: object QueryDetails: description: 'All the information surrounding a query, including the query statement, limits, consistency, and so forth. ' properties: compartmentId: description: 'Compartment OCID, to provide context for a table name in the given statement. ' type: string consistency: default: EVENTUAL description: Consistency requirement for a read operation. enum: - EVENTUAL - ABSOLUTE type: string isPrepared: description: If true, the statement is a prepared statement. type: boolean maxReadInKBs: default: 0 description: 'A limit on the total amount of data read during this operation, in KB. ' type: integer statement: description: 'A NoSQL SQL query statement; or a Base64-encoded prepared statement. ' type: string timeoutInMs: default: 5000 description: Timeout setting for the query. type: integer variables: additionalProperties: type: object description: A map of prepared statement variables to values. type: object required: - compartmentId - statement WorkRequest: description: A description of workrequest status. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_TABLE - UPDATE_TABLE - DELETE_TABLE type: string percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted WorkRequestErrorCollection: description: Results of ListWorkRequestErrors properties: items: description: A page of WorkRequestError objects. items: $ref: '#/components/schemas/WorkRequestError' type: array type: object CreateReplicaDetails: description: Specifications for the new replica properties: compartmentId: description: '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. ' type: string maxReadUnits: description: 'Maximum sustained read throughput limit for the new replica table. If not specified, the local table''s read limit is used. ' type: integer maxWriteUnits: description: 'Maximum sustained write throughput limit for the new replica table. If not specified, the local table''s write limit is used. ' type: integer region: description: 'Name of the remote region in standard OCI format, i.e. us-ashburn-1 ' type: string required: - region type: object UpdateTableDetails: description: The information to be updated. properties: compartmentId: description: '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. ' type: string ddlStatement: description: Complete ALTER TABLE DDL statement. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object tableLimits: $ref: '#/components/schemas/TableLimits' type: object WorkRequestSummary: description: A description of workrequest status. properties: compartmentId: description: 'The ocid of the compartment that contains the work request. ' type: string id: description: The id of the work request. type: string operationType: description: Type of the work request. enum: - CREATE_TABLE - UPDATE_TABLE - DELETE_TABLE type: string percentComplete: description: Percentage of the request completed. format: float type: number resources: description: The resources affected by this work request. items: $ref: '#/components/schemas/WorkRequestResource' type: array status: description: Status of current work request. enum: - ACCEPTED - IN_PROGRESS - FAILED - SUCCEEDED - CANCELING - CANCELED type: string timeAccepted: description: 'The date and time the request was created, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string timeFinished: description: 'The date and time the object was finished, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339). ' format: date-time type: string timeStarted: description: 'The date and time the request was started, as described in [RFC 3339](https://tools.ietf.org/rfc/rfc3339), section 14.29. ' format: date-time type: string required: - operationType - status - id - compartmentId - resources - percentComplete - timeAccepted Replica: description: Information about a MR table replica properties: capacityMode: description: 'The capacity mode of the replica. ' enum: - PROVISIONED - ON_DEMAND type: string lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string lifecycleState: description: The state of the replica. enum: - CREATING - UPDATING - ACTIVE - DELETING type: string maxWriteUnits: description: 'Maximum sustained write throughput limit of the replica table. ' type: integer region: description: A customer-facing region identifier type: string tableId: description: The OCID of the replica table type: string Schema: description: The table schema information as a JSON object. properties: columns: description: The columns of a table. items: $ref: '#/components/schemas/Column' type: array identity: $ref: '#/components/schemas/Identity' primaryKey: description: A list of column names that make up a key. items: type: string type: array shardKey: description: A list of column names that make up a key. items: type: string type: array ttl: description: The default Time-to-Live for the table, in days. type: integer required: - columns - primaryKey - shardKey - ttl type: object WorkRequestError: description: An error encountered while executing a work request. properties: code: description: '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) ' type: string message: description: A human readable description of the issue encountered. type: string timestamp: description: The time the error occured. An RFC3339 formatted datetime string. format: date-time type: string required: - code - message - timestamp Table: description: Complete metadata about a table. properties: compartmentId: description: Compartment Identifier. type: string ddlStatement: description: A DDL statement representing the schema. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable. type: string isAutoReclaimable: description: True if this table can be reclaimed after an idle period. type: boolean isMultiRegion: description: True if this table is currently a member of a replication set. type: boolean lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string lifecycleState: description: The state of a table. enum: - CREATING - UPDATING - ACTIVE - DELETING - DELETED - FAILED - INACTIVE type: string localReplicaInitializationInPercent: description: '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. ' type: integer name: description: Human-friendly table name, immutable. type: string replicas: description: An array of Replica listing this table's replicas, if any items: $ref: '#/components/schemas/Replica' type: array schema: $ref: '#/components/schemas/Schema' schemaState: description: '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. ' enum: - MUTABLE - FROZEN type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. ' type: object description: '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"}}` ' type: object tableLimits: $ref: '#/components/schemas/TableLimits' timeCreated: description: 'The time the the table was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeOfExpiration: description: 'If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time the the table''s metadata was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string required: - id - compartmentId type: object UpdateRowDetails: description: Specifications for the putting of a table row. properties: compartmentId: description: '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. ' type: string identityCacheSize: description: '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. ' type: integer isExactMatch: description: '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. ' type: boolean isGetReturnRow: default: false description: 'If true, and the put fails due to an option setting, then the existing row will be returned. ' type: boolean isTtlUseTableDefault: default: true description: 'If true, set time-to-live for this row to the table''s default. ' type: boolean option: description: Specifies a condition for the put operation. enum: - IF_ABSENT - IF_PRESENT type: string timeoutInMs: default: 5000 description: Timeout setting for the put. type: integer ttl: description: Time-to-live for the row, in days. type: integer value: additionalProperties: type: object description: The map of values from a row. type: object required: - value TableSummary: description: Summary of the table. properties: compartmentId: description: Compartment Identifier. type: string definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object id: description: Unique identifier that is immutable on creation. type: string isAutoReclaimable: description: True if this table can be reclaimed after an idle period. type: boolean isMultiRegion: description: True if this table is currently a member of a replication set. type: boolean lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string lifecycleState: description: The state of a table. type: string x-obmcs-enumref: '#/definitions/Table/lifecycleState' name: description: Human-friendly table name, also immutable. type: string schemaState: description: '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. ' enum: - MUTABLE - FROZEN type: string systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. ' type: object description: '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"}}` ' type: object tableLimits: $ref: '#/components/schemas/TableLimits' timeCreated: description: 'The time the the table was created. An RFC3339 formatted datetime string. ' format: date-time type: string timeOfExpiration: description: 'If lifecycleState is INACTIVE, indicates when this table will be automatically removed. An RFC3339 formatted datetime string. ' format: date-time type: string timeUpdated: description: 'The time the the table''s metadata was last updated. An RFC3339 formatted datetime string. ' format: date-time type: string required: - id - compartmentId type: object IndexKey: description: Specifies a single key in a secondary index. properties: columnName: description: The name of a column to be included as an index key. type: string jsonFieldType: description: 'If the specified column is of type JSON, jsonFieldType contains the type of the field indicated by jsonPath. ' type: string jsonPath: description: '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. ' type: string required: - columnName type: object WorkRequestLogEntry: description: A log message from the execution of a work request. properties: message: description: Human-readable log message. type: string timestamp: description: The time the log message was written. An RFC3339 formatted datetime string. format: date-time type: string required: - message - timestamp ChangeTableCompartmentDetails: description: Specification of both from and to compartments. properties: fromCompartmentId: description: '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. ' type: string toCompartmentId: description: The OCID of the table's new compartment. type: string required: - toCompartmentId type: object WorkRequestLogEntryCollection: description: Results of ListWorkRequestLogs properties: items: description: A page of WorkRequestLogEntry objects. items: $ref: '#/components/schemas/WorkRequestLogEntry' type: array type: object responses: default: description: Unknown Error headers: opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' schema: type: string content: application/json: schema: $ref: '#/components/schemas/Error' x-anchors: x-headers: etag: description: 'For optimistic concurrency control. See `if-match`. ' type: string opc-next-page: description: 'For pagination of a list of items. When paging through a list, if this header appears in the response, then a partial list might have been returned. Include this value as the `page` parameter for the subsequent GET request to get the next batch of items. ' type: string opc-request-id: description: 'Unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. ' type: string opc-work-request-id: description: 'Unique Oracle-assigned identifier for the asynchronous request. You can use this to query status of the asynchronous operation. ' type: string retry-after: description: 'A decimal number representing the number of seconds the client should wait before polling this endpoint again. ' format: float type: number x-properties: definedTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing predefined tags'' keys and values scoped to a namespace. Example: `{"bar-key": "value"}` ' type: object description: 'Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}` ' type: object freeformTags: additionalProperties: type: string description: 'Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: `{"bar-key": "value"}` ' type: object keylist: description: A list of column names that make up a key. items: type: string type: array lifecycleDetails: description: 'A message describing the current state in more detail. ' type: string row-values: additionalProperties: type: object description: The map of values from a row. type: object systemTags: additionalProperties: additionalProperties: description: 'The value of the tag. Only string, integer and boolean types are supported. ' type: object description: 'Key-value pair representing system tags'' keys and values scoped to a namespace. ' type: object description: '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"}}` ' type: object x-obmcs-client-retries-enabled: true x-oracle-package: oracle.nosql.oci.controlplane