Database - Corsair

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

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

Author

Path: semanticscholar.db.author.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`authorId`	`string`	equals, contains, startsWith, endsWith, in
`url`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`homepage`	`string`	equals, contains, startsWith, endsWith, in
`paperCount`	`number`	equals, gt, gte, lt, lte, in
`citationCount`	`number`	equals, gt, gte, lt, lte, in
`hIndex`	`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.

Author Summary

Path: semanticscholar.db.authorSummary.search

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

Searchable filters

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

Autocomplete Match

Path: semanticscholar.db.autocompleteMatch.search

const rows = await corsair.semanticscholar.db.autocompleteMatch.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
`title`	`string`	equals, contains, startsWith, endsWith, in
`authorsYear`	`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.

Citation

Path: semanticscholar.db.citation.search

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

Searchable filters

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

Dataset

Path: semanticscholar.db.dataset.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`description`	`string`	equals, contains, startsWith, endsWith, in
`README`	`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.

Dataset Diff

Path: semanticscholar.db.datasetDiff.search

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

Searchable filters

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

Dataset Release

Path: semanticscholar.db.datasetRelease.search

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

Searchable filters

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

Paper

Path: semanticscholar.db.paper.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`paperId`	`string`	equals, contains, startsWith, endsWith, in
`url`	`string`	equals, contains, startsWith, endsWith, in
`title`	`string`	equals, contains, startsWith, endsWith, in
`abstract`	`string`	equals, contains, startsWith, endsWith, in
`venue`	`string`	equals, contains, startsWith, endsWith, in
`year`	`number`	equals, gt, gte, lt, lte, in
`referenceCount`	`number`	equals, gt, gte, lt, lte, in
`citationCount`	`number`	equals, gt, gte, lt, lte, in
`influentialCitationCount`	`number`	equals, gt, gte, lt, lte, in
`isOpenAccess`	`boolean`	equals
`publicationDate`	`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.

Reference

Path: semanticscholar.db.reference.search

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

Searchable filters

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

Snippet

Path: semanticscholar.db.snippet.search

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

Searchable filters

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