Database

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

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

Files

Path: box.db.files.search

const rows = await corsair.box.db.files.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
`size`	`number`	equals, gt, gte, lt, lte, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`etag`	`string`	equals, contains, startsWith, endsWith, in
`sha1`	`string`	equals, contains, startsWith, endsWith, in
`sequence_id`	`string`	equals, contains, startsWith, endsWith, in
`extension`	`string`	equals, contains, startsWith, endsWith, in
`is_package`	`boolean`	equals
`content_created_at`	`string`	equals, contains, startsWith, endsWith, in
`content_modified_at`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`modified_at`	`string`	equals, contains, startsWith, endsWith, in
`trashed_at`	`string`	equals, contains, startsWith, endsWith, in
`purged_at`	`string`	equals, contains, startsWith, endsWith, in
`item_status`	`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: box.db.folders.search

const rows = await corsair.box.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
`description`	`string`	equals, contains, startsWith, endsWith, in
`etag`	`string`	equals, contains, startsWith, endsWith, in
`sequence_id`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`modified_at`	`string`	equals, contains, startsWith, endsWith, in
`trashed_at`	`string`	equals, contains, startsWith, endsWith, in
`purged_at`	`string`	equals, contains, startsWith, endsWith, in
`content_created_at`	`string`	equals, contains, startsWith, endsWith, in
`content_modified_at`	`string`	equals, contains, startsWith, endsWith, in
`is_externally_owned`	`boolean`	equals
`has_collaborations`	`boolean`	equals
`item_status`	`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.

Overview

Plugins

Files

Searchable filters

Folders

Searchable filters

​Files

​Searchable filters

​Folders

​Searchable filters

Files

Searchable filters

Folders

Searchable filters