Database - Corsair

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

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

Contacts

Path: filevine.db.contacts.search

const rows = await corsair.filevine.db.contacts.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
`contactId`	`number`	equals, gt, gte, lt, lte, in
`firstName`	`string`	equals, contains, startsWith, endsWith, in
`lastName`	`string`	equals, contains, startsWith, endsWith, in
`fullName`	`string`	equals, contains, startsWith, endsWith, in
`organization`	`string`	equals, contains, startsWith, endsWith, in
`createdDate`	`string`	equals, contains, startsWith, endsWith, in
`modifiedDate`	`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.

Deadlines

Path: filevine.db.deadlines.search

const rows = await corsair.filevine.db.deadlines.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
`deadlineId`	`number`	equals, gt, gte, lt, lte, in
`projectId`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`dueDate`	`string`	equals, contains, startsWith, endsWith, in
`assigneeId`	`number`	equals, gt, gte, lt, lte, in
`createdDate`	`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: filevine.db.documents.search

const rows = await corsair.filevine.db.documents.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
`documentId`	`number`	equals, gt, gte, lt, lte, in
`projectId`	`number`	equals, gt, gte, lt, lte, in
`folderId`	`number`	equals, gt, gte, lt, lte, in
`filename`	`string`	equals, contains, startsWith, endsWith, in
`size`	`number`	equals, gt, gte, lt, lte, in
`contentType`	`string`	equals, contains, startsWith, endsWith, in
`sharedToPortal`	`boolean`	equals
`version`	`number`	equals, gt, gte, lt, lte, in
`uploadedBy`	`number`	equals, gt, gte, lt, lte, in
`createdDate`	`string`	equals, contains, startsWith, endsWith, in
`modifiedDate`	`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.

Notes

Path: filevine.db.notes.search

const rows = await corsair.filevine.db.notes.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
`noteId`	`number`	equals, gt, gte, lt, lte, in
`projectId`	`number`	equals, gt, gte, lt, lte, in
`body`	`string`	equals, contains, startsWith, endsWith, in
`pinned`	`boolean`	equals
`authorId`	`number`	equals, gt, gte, lt, lte, in
`createdDate`	`string`	equals, contains, startsWith, endsWith, in
`modifiedDate`	`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.

Projects

Path: filevine.db.projects.search

const rows = await corsair.filevine.db.projects.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
`projectId`	`number`	equals, gt, gte, lt, lte, in
`projectName`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`number`	`string`	equals, contains, startsWith, endsWith, in
`projectTypeId`	`number`	equals, gt, gte, lt, lte, in
`clientId`	`number`	equals, gt, gte, lt, lte, in
`phaseName`	`string`	equals, contains, startsWith, endsWith, in
`isArchived`	`boolean`	equals
`createdDate`	`string`	equals, contains, startsWith, endsWith, in
`modifiedDate`	`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.

Subscriptions

Path: filevine.db.subscriptions.search

const rows = await corsair.filevine.db.subscriptions.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
`subscriptionId`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`endpoint`	`string`	equals, contains, startsWith, endsWith, in
`signingKey`	`string`	equals, contains, startsWith, endsWith, in
`createdDate`	`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.

Tasks

Path: filevine.db.tasks.search

const rows = await corsair.filevine.db.tasks.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
`taskId`	`number`	equals, gt, gte, lt, lte, in
`projectId`	`number`	equals, gt, gte, lt, lte, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`body`	`string`	equals, contains, startsWith, endsWith, in
`dueDate`	`string`	equals, contains, startsWith, endsWith, in
`assigneeId`	`number`	equals, gt, gte, lt, lte, in
`completedDate`	`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.