Database - Corsair

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

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

Api Keys

Path: neon.db.apiKeys.search

const rows = await corsair.neon.db.apiKeys.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
`name`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`last_used_at`	`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.

Branches

Path: neon.db.branches.search

const rows = await corsair.neon.db.branches.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
`project_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`parent_id`	`string`	equals, contains, startsWith, endsWith, in
`default`	`boolean`	equals
`current_state`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`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.

Compute Endpoints

Path: neon.db.computeEndpoints.search

const rows = await corsair.neon.db.computeEndpoints.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
`project_id`	`string`	equals, contains, startsWith, endsWith, in
`branch_id`	`string`	equals, contains, startsWith, endsWith, in
`host`	`string`	equals, contains, startsWith, endsWith, in
`type`	`string`	equals, contains, startsWith, endsWith, in
`current_state`	`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.

Databases

Path: neon.db.databases.search

const rows = await corsair.neon.db.databases.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
`branch_id`	`string`	equals, contains, startsWith, endsWith, in
`name`	`string`	equals, contains, startsWith, endsWith, in
`owner_name`	`string`	equals, contains, startsWith, endsWith, in
`created_at`	`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.

Organizations

Path: neon.db.organizations.search

const rows = await corsair.neon.db.organizations.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
`handle`	`string`	equals, contains, startsWith, endsWith, in
`plan`	`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: neon.db.projects.search

const rows = await corsair.neon.db.projects.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
`org_id`	`string`	equals, contains, startsWith, endsWith, in
`region_id`	`string`	equals, contains, startsWith, endsWith, in
`pg_version`	`number`	equals, gt, gte, lt, lte, in
`created_at`	`string`	equals, contains, startsWith, endsWith, in
`updated_at`	`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.

Roles

Path: neon.db.roles.search

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

Searchable filters

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

Snapshots

Path: neon.db.snapshots.search

const rows = await corsair.neon.db.snapshots.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
`created_at`	`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.