Database - Corsair

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

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

Actor Builds

Path: apify.db.actorBuilds.search

const rows = await corsair.apify.db.actorBuilds.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
`actId`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`buildNumber`	`string`	equals, contains, startsWith, endsWith, in
`startedAt`	`date`	equals, before, after, between
`finishedAt`	`date`	equals, 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.

Actor Outputs

Path: apify.db.actorOutputs.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`datasetId`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`date`	equals, 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.

Actor Runs

Path: apify.db.actorRuns.search

const rows = await corsair.apify.db.actorRuns.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
`runId`	`string`	equals, contains, startsWith, endsWith, in
`status`	`string`	equals, contains, startsWith, endsWith, in
`actorId`	`string`	equals, contains, startsWith, endsWith, in
`actorName`	`string`	equals, contains, startsWith, endsWith, in
`datasetId`	`string`	equals, contains, startsWith, endsWith, in
`startedAt`	`date`	equals, before, after, between
`finishedAt`	`date`	equals, 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.

Actors

Path: apify.db.actors.search

const rows = await corsair.apify.db.actors.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`username`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`description`	`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.

Actor Tasks

Path: apify.db.actorTasks.search

const rows = await corsair.apify.db.actorTasks.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
`actId`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.

Datasets

Path: apify.db.datasets.search

const rows = await corsair.apify.db.datasets.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`itemCount`	`number`	equals, gt, gte, lt, lte, in
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.

Key Value Stores

Path: apify.db.keyValueStores.search

const rows = await corsair.apify.db.keyValueStores.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`recordCount`	`number`	equals, gt, gte, lt, lte, in
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.

Request Queues

Path: apify.db.requestQueues.search

const rows = await corsair.apify.db.requestQueues.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`totalRequestCount`	`number`	equals, gt, gte, lt, lte, in
`handledRequestCount`	`number`	equals, gt, gte, lt, lte, in
`pendingRequestCount`	`number`	equals, gt, gte, lt, lte, in
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.

Schedules

Path: apify.db.schedules.search

const rows = await corsair.apify.db.schedules.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`userId`	`string`	equals, contains, startsWith, endsWith, in
`isEnabled`	`boolean`	equals
`cronExpression`	`string`	equals, contains, startsWith, endsWith, in
`timezone`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.

Users

Path: apify.db.users.search

const rows = await corsair.apify.db.users.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
`username`	`string`	equals, contains, startsWith, endsWith, in
`email`	`string`	equals, contains, startsWith, endsWith, in
`createdAt`	`date`	equals, 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.

Webhooks

Path: apify.db.webhooks.search

const rows = await corsair.apify.db.webhooks.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
`userId`	`string`	equals, contains, startsWith, endsWith, in
`requestUrl`	`string`	equals, contains, startsWith, endsWith, in
`isAdHoc`	`boolean`	equals
`createdAt`	`date`	equals, before, after, between
`modifiedAt`	`date`	equals, 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.