Database - Corsair

The Coda plugin syncs data locally. Use corsair.coda.db.<entity>.search({ data, limit?, offset? }) with the filters listed per entity.

New to Corsair? See database operations, data synchronization, and multi-tenancy.

Columns

Path: coda.db.columns.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`display`	`boolean`	equals
`calculated`	`boolean`	equals
`formula`	`string`	equals, contains, startsWith, endsWith, in
`defaultValue`	`string`	equals, contains, startsWith, endsWith, in

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.

Controls

Path: coda.db.controls.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`controlType`	`string`	equals, contains, startsWith, endsWith, in

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.

Documents

Path: coda.db.documents.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`browserLink`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`owner`	`string`	equals, contains, startsWith, endsWith, in
`ownerName`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in
`workspaceId`	`string`	equals, contains, startsWith, endsWith, in
`folderId`	`string`	equals, contains, startsWith, endsWith, in

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.

Folders

Path: coda.db.folders.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`browserLink`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`iconColor`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`canEdit`	`boolean`	equals

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.

Formulas

Path: coda.db.formulas.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in

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.

Packs

Path: coda.db.packs.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`number`	equals, gt, gte, lt, lte, in
`logoUrl`	`string`	equals, contains, startsWith, endsWith, in
`coverUrl`	`string`	equals, contains, startsWith, endsWith, in
`workspaceId`	`string`	equals, contains, startsWith, endsWith, in
`certified`	`boolean`	equals
`certifiedAgent`	`boolean`	equals
`sourceCodeVisibility`	`string`	equals, contains, startsWith, endsWith, in
`verifiedVersion`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`shortDescription`	`string`	equals, contains, startsWith, endsWith, in
`agentShortDescription`	`string`	equals, contains, startsWith, endsWith, in
`agentDescription`	`string`	equals, contains, startsWith, endsWith, in
`supportEmail`	`string`	equals, contains, startsWith, endsWith, in
`termsOfServiceUrl`	`string`	equals, contains, startsWith, endsWith, in
`privacyPolicyUrl`	`string`	equals, contains, startsWith, endsWith, in
`featuredDocStatus`	`string`	equals, contains, startsWith, endsWith, in

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.

Pages

Path: coda.db.pages.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`browserLink`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`subtitle`	`string`	equals, contains, startsWith, endsWith, in
`contentType`	`string`	equals, contains, startsWith, endsWith, in
`isHidden`	`boolean`	equals
`isEffectivelyHidden`	`boolean`	equals
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in

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.

Rows

Path: coda.db.rows.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`index`	`number`	equals, gt, gte, lt, lte, in
`browserLink`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in

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.

Tables

Path: coda.db.tables.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`id`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`tableType`	`string`	equals, contains, startsWith, endsWith, in
`href`	`string`	equals, contains, startsWith, endsWith, in
`browserLink`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`rowCount`	`number`	equals, gt, gte, lt, lte, in
`layout`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in

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.