Logo
OCI NoSQL Playground API Documentation

NoSQL Database API

Number of APIs: 22


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.


1. query - Execute a SQL query.

POST {{baseUrl}}/query?limit=1000



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

GET {{baseUrl}}/query/prepare?compartmentId={{compartment_ocid}}&statement=SELECT * FROM DUAL



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

GET {{baseUrl}}/query/summarize?compartmentId={{compartment_ocid}}&statement=SELECT * FROM DUAL



4. tables-{tableNameOrId}-indexes-{indexName} - Delete an index.

DELETE {{baseUrl}}/tables/:tableNameOrId/indexes/:indexName?compartmentId={{compartment_ocid}}&isIfExists=false



5. tables-{tableNameOrId}-indexes-{indexName} - Get information about a single index.

GET {{baseUrl}}/tables/:tableNameOrId/indexes/:indexName?compartmentId={{compartment_ocid}}



6. tables - Get a list of tables in a compartment.

GET {{baseUrl}}/tables?compartmentId={{compartment_ocid}}&name=*&limit=1000&sortOrder=DESC&sortBy=timeCreated&lifecycleState=ALL



7. tables-{tableNameOrId} - Get table info by identifier.

GET {{baseUrl}}/tables/:tableNameOrId?compartmentId={{compartment_ocid}}



8. tables-{tableNameOrId}-indexes - Create a new index.

POST {{baseUrl}}/tables/:tableNameOrId/indexes



9. tables - Create a new table.

POST {{baseUrl}}/tables



10. tables-{tableNameOrId}-rows - Get a single row from the table by primary key.

GET {{baseUrl}}/tables/:tableNameOrId/rows?compartmentId={{compartment_ocid}}&key=veniam velit elit pariatur&key=sint in&consistency=EVENTUAL&timeoutInMs=5000


ENDPOINTS