Database - Corsair

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

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

Content Items

Path: agilitycms.db.contentItems.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`contentID`	`number`	equals, gt, gte, lt, lte, 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.

Content Models

Path: agilitycms.db.contentModels.search

const rows = await corsair.agilitycms.db.contentModels.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
`referenceName`	`string`	equals, contains, startsWith, endsWith, in
`displayName`	`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.

Page Modules

Path: agilitycms.db.pageModules.search

const rows = await corsair.agilitycms.db.pageModules.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
`referenceName`	`string`	equals, contains, startsWith, endsWith, in
`displayName`	`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.

Pages

Path: agilitycms.db.pages.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`pageID`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`path`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`menuText`	`string`	equals, contains, startsWith, endsWith, in
`pageType`	`string`	equals, contains, startsWith, endsWith, in
`templateName`	`string`	equals, contains, startsWith, endsWith, in
`redirectUrl`	`string`	equals, contains, startsWith, endsWith, in
`securePage`	`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.

Sitemap Nodes

Path: agilitycms.db.sitemapNodes.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`pageID`	`number`	equals, gt, gte, lt, lte, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`menuText`	`string`	equals, contains, startsWith, endsWith, in
`path`	`string`	equals, contains, startsWith, endsWith, in
`isFolder`	`boolean`	equals
`redirectUrl`	`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.

Sync Items

Path: agilitycms.db.syncItems.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`contentID`	`number`	equals, gt, gte, lt, lte, 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.

Sync Pages

Path: agilitycms.db.syncPages.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`pageID`	`number`	equals, gt, gte, lt, lte, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`path`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`templateName`	`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.