Database - Corsair

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

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

Audio Bibles

Path: apibible.db.audioBibles.search

const rows = await corsair.apibible.db.audioBibles.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
`dblId`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`nameLocal`	`string`	equals, contains, startsWith, endsWith, in
`abbreviation`	`string`	equals, contains, startsWith, endsWith, in
`abbreviationLocal`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in
`copyright`	`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.

Audio Chapters

Path: apibible.db.audioChapters.search

const rows = await corsair.apibible.db.audioChapters.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
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`bookId`	`string`	equals, contains, startsWith, endsWith, in
`number`	`string`	equals, contains, startsWith, endsWith, in
`reference`	`string`	equals, contains, startsWith, endsWith, in
`resourceUrl`	`string`	equals, contains, startsWith, endsWith, in
`expiresAt`	`string`	equals, contains, startsWith, endsWith, in
`copyright`	`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.

Bibles

Path: apibible.db.bibles.search

const rows = await corsair.apibible.db.bibles.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
`dblId`	`string`	equals, contains, startsWith, endsWith, in
`relatedDbl`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`nameLocal`	`string`	equals, contains, startsWith, endsWith, in
`abbreviation`	`string`	equals, contains, startsWith, endsWith, in
`abbreviationLocal`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`descriptionLocal`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`updatedAt`	`string`	equals, contains, startsWith, endsWith, in
`copyright`	`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.

Books

Path: apibible.db.books.search

const rows = await corsair.apibible.db.books.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
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`abbreviation`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`nameLong`	`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.

Chapters

Path: apibible.db.chapters.search

const rows = await corsair.apibible.db.chapters.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
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`bookId`	`string`	equals, contains, startsWith, endsWith, in
`number`	`string`	equals, contains, startsWith, endsWith, in
`reference`	`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.

Passages

Path: apibible.db.passages.search

const rows = await corsair.apibible.db.passages.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
`orgId`	`string`	equals, contains, startsWith, endsWith, in
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`bookId`	`string`	equals, contains, startsWith, endsWith, in
`reference`	`string`	equals, contains, startsWith, endsWith, in
`content`	`string`	equals, contains, startsWith, endsWith, in
`copyright`	`string`	equals, contains, startsWith, endsWith, in
`verseCount`	`number`	equals, gt, gte, lt, lte, 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.

Sections

Path: apibible.db.sections.search

const rows = await corsair.apibible.db.sections.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
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`bookId`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`firstVerseId`	`string`	equals, contains, startsWith, endsWith, in
`lastVerseId`	`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.

Verses

Path: apibible.db.verses.search

const rows = await corsair.apibible.db.verses.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
`orgId`	`string`	equals, contains, startsWith, endsWith, in
`bibleId`	`string`	equals, contains, startsWith, endsWith, in
`bookId`	`string`	equals, contains, startsWith, endsWith, in
`chapterId`	`string`	equals, contains, startsWith, endsWith, in
`reference`	`string`	equals, contains, startsWith, endsWith, in
`content`	`string`	equals, contains, startsWith, endsWith, in
`copyright`	`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.