Logo
OCI NoSQL Playground API Documentation

End-to-End Example

Number of APIs: 11


1. 1. Create a table - 1.1. Create a new table.

POST {{baseUrl}}/tables



2. 2. Desc the table created - 2.1. Get a list of tables in a compartment.

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



3. 2. Desc the table created - 2.2. Get table info by identifier.

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



4. 3. CRUD operations on the table created - 3.2. Get a single row from the table by primary key.

GET {{baseUrl}}/tables/:tableNameOrId/rows?compartmentId={{compartment_ocid}}&key=id:1&consistency=EVENTUAL&timeoutInMs=5000



5. 3. CRUD operations on the table created - 3.3. Delete a single row from the table, by primary key.

DELETE {{baseUrl}}/tables/:tableNameOrId/rows?compartmentId={{compartment_ocid}}&key=id:1&isGetReturnRow=false&timeoutInMs=5000



6. 3. CRUD operations on the table created - 3.4. Write a single row into the table.

PUT {{baseUrl}}/tables/:tableNameOrId/rows



7. 4. Query Operations on the table created - 4.1. Execute a SQL query.

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



8. 4. Query Operations on the table created - 4.2. Check the syntax and return a brief summary of a SQL statement.

GET {{baseUrl}}/query/summarize?compartmentId={{compartment_ocid}}&statement=SELECT * FROM postman_colls d where d.body.values.key =any $val



9. 5. Index Operations on the table created - 5.1. Create a new index.

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



10. 5. Index Operations on the table created - 5.2. Get a list of indexes on a table.

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

ENDPOINTS