Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt

Use this file to discover all available pages before exploring further.

The Google sheets plugin syncs data locally. Use corsair.googlesheets.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.
New to Corsair? See database operations, data synchronization, and multi-tenancy.

​
Rows

Path: googlesheets.db.rows.search 
const rows = await corsair.googlesheets.db.rows.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
rowIdstringequals, contains, startsWith, endsWith, in
spreadsheetIdstringequals, contains, startsWith, endsWith, in
sheetNamestringequals, contains, startsWith, endsWith, in
rangestringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

​
Sheets

Path: googlesheets.db.sheets.search 
const rows = await corsair.googlesheets.db.sheets.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
sheetIdstringequals, contains, startsWith, endsWith, in
spreadsheetIdstringequals, contains, startsWith, endsWith, in
titlestringequals, contains, startsWith, endsWith, in
indexnumberequals, gt, gte, lt, lte, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.

​
Spreadsheets

Path: googlesheets.db.spreadsheets.search 
const rows = await corsair.googlesheets.db.spreadsheets.search({
    data: { /* filters below */ },
    limit: 100,
    offset: 0,
});

​
Searchable filters

FieldTypeOperators
entity_idstringequals, contains, startsWith, endsWith, in
spreadsheetIdstringequals, contains, startsWith, endsWith, in
titlestringequals, contains, startsWith, endsWith, in
spreadsheetUrlstringequals, contains, startsWith, endsWith, in
createdAtdateequals, before, after, between
Every .search() also accepts limit and offset for pagination. .list() is available on the same path without the .search suffix in code — see database operations.