Skip to main content

JSON DB API tutorials

Tutorials for the JSON DB API using the API Explorer user interface

Tutorial

Description

Manage a database using API Explorer

Manage databases, tables, indexes, records, queries, and cursors using API Explorer.

Create a table

Use Data Explorer's API Explorer Tab to create the athlete table.

Create an index

Use Data Explorer's API Explorer Tab to create indexes on the athlete table.

Insert records

Use Data Explorer's API Explorer Tab to insert records into the athlete table.

View records in a table

Use Data Explorer's Table Record Tab to see the inserted records. You can optionally edit and insert additional records.

View records using a SQL query

Use Data Explorer's SQL Query Tab to filter, sort, and view records.

View records using a SQL script

Use Data Explorer's SQL Script Tab to filter, sort, and view records as text you can easily copy and paste. You can also run any SQL statement, such as altering or dropping a table.

Get records by ID

Run a JSON DB action in Data Explorer's API Explorer Tab to retrieve athlete records by their ID field value. It returns records in the order you request as JSON documents.

Get records by table

Run a JSON DB action in Data Explorer's API Explorer Tab to quickly retrieve all records in the athlete table. It returns records in table order as JSON documents.

Get records by index

Run a JSON DB action in Data Explorer's API Explorer Tab to quickly retrieve athlete records in the athlete table. It returns records in index order as JSON documents.

Get records matching a partial key

Run a JSON DB action in Data Explorer's API Explorer Tab to quickly retrieve athlete records that match a partial name in the athlete table. It returns records in index order as JSON documents.

Get records in a key range

Run a JSON DB action in Data Explorer's API Explorer Tab to quickly retrieve athlete records in the athlete table that are between a starting and engine key. It returns records in index order as JSON documents.

Get filtered records in a key range

Run a JSON DB action in Data Explorer's API Explorer Tab to quickly retrieve a filtered set of athlete records in the athlete table between a starting and engine key. It returns records in index order as JSON documents.

Get first N records

Run a JSON DB action in Data Explorer's API Explorer Tab to retrieve the first N records from the athlete table. It returns records in order as JSON documents.

Use a cursor to get records by index

Run a JSON DB action in Data Explorer's API Explorer Tab to return a cursor that can retrieve athlete records in the athlete table in index order. A cursor can efficiently skip and fetch records forward and backward.

Use a cursor to skip and fetch records

Run a JSON DB action in Data Explorer's API Explorer Tab that uses a cursor to retrieve athlete records. Each of the "getRecords..." actions can return a cursor. A cursor can efficiently skip and fetch records forward and backward.

Use a cursor to tail inserted records

Run a JSON DB action in Data Explorer's API Explorer Tab that uses a cursor to retrieve athlete records from the end of the results. Each of the "getRecords..." actions can return a cursor. A cursor can quickly start at the end of a table and skip and fetch records backward and forward.

Close a cursor

Run a JSON DB action in Data Explorer's API Explorer Tab that closes a cursor to free server resources,