Move a cursor and get records

Prerequisites:

The following lists contain techniques, examples, and capabilities of cursors.

Various ways to combine "fetchRecords", "skipRecords", and "startFrom" to move the cursor:

To fetch forwards, assign a positive integer number to "fetchRecords".
To fetch backwards, assign a negative integer number to "fetchRecords".
To skip forwards, assign a positive integer number to "skipRecords".
To skip backwards, assign a negative integer number to "skipRecords".
To move a cursor to the beginning of the recordset, set the "startFrom" property to "beforeFirstRecord".
To move a cursor to the end of the recordset, set the "startFrom" property to "afterLastRecord".

Examples:

To return the next two records:
```
"fetchRecords": 2
```
To return the previous three records:
```
"fetchRecords": -31
```
To skip the next two records and fetch 1 record:
```
"skipRecords": 2, 
"fetchRecords": 1
```
To skip the previous record before the next 3 previous records:
```
"skipRecords": -1 , 
"fetchRecords": -3
```

To fetch the first 3 records in the recordset:

"startFrom": "beforeFirstRecord", 
"fetchRecords": 3

To fetch the last 3 records in the recordset:

"startFrom": "afterLastRecord", 
"skipRecords": -3, 
"fetchRecords": 3

Cursors that only move forward:

"getRecordsFromTable" allows the cursor to move through every record in the table from beginning to end.
"getRecordsUsingSQL" allows the cursor to move through every record returned by the SQL query from beginning to end.

Bidirectional cursors:

"getRecordsByIndex" allows the cursor to move through every record in the index.
"getRecordsStartingAtKey" allows the cursor to move through every record in the index starting with the closest match to the key.
"getRecordsByPartialKeyRange" allows the cursor to move through every record in the index that matches the partial key.
"getRecordsInKeyRange" allows the cursor to move through every record in the index within the specified key range.

Paste this code into the API Request editor.

{
    "api": "db",
    "action": "getRecordsFromCursor",
    "params": {
        "cursorId": "clickApplyDefaultsToReplaceThisWithTheLastCreatedCursor",
        "startFrom": "beforeFirstRecord",
        "skipRecords": 1,
        "fetchRecords": 1
    },
    "authToken": "clickApplyDefaultsToReplaceThisWithValidAuthToken"
}

Click Apply defaults to JSON request () to set the "authToken" to a valid value.
Note
Clicking the Apply defaults to JSON request icon populates the "cursorId" with the most recent value returns by getRecords action.
Click Send request ().
Continue to click Send request to move through the records.
Note
The same code fetches different records each time it is run because each call moves the cursor position.
To fetch records from different locations in the recordset, change the values of "startFrom", "skipRecords", and "fetchRecords".
Verify the action completed successfully.
Note
- "errorCode" with a value of 0 indicates success. "errorCode" with a non-zero value indicates a failure. See Errors and contact FairCom for more information about an error.
- The API Explorer automatically recognizes the "cursorId" in a response and remembers it so when you select the "getRecordsFromCursor" from the JSON Actions dropdown menu, API Explorer automatically populates the action with the latest "cursorId" value to simply using cursors.
- The "cursorId" property is secure because it is a very large crypto-random number — for example, "cursorId": "w0gs3RZz8eD5Qtf0VuQ9V86tsd85IdlvMwUocQwK0U548ew5RlXpNIP0tyaVVX0w".

Move a cursor and get records

Note

Note

Note