Database

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

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

Catalog

Path: databricks.db.catalog.search

const rows = await corsair.databricks.db.catalog.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
`metastore_id`	`string`	equals, contains, startsWith, endsWith, in
`owner`	`string`	equals, contains, startsWith, endsWith, in
`comment`	`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.

Cluster

Path: databricks.db.cluster.search

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

Searchable filters

Field	Type	Operators
`entity_id`	`string`	equals, contains, startsWith, endsWith, in
`cluster_id`	`string`	equals, contains, startsWith, endsWith, in
`cluster_name`	`string`	equals, contains, startsWith, endsWith, in
`spark_version`	`string`	equals, contains, startsWith, endsWith, in
`node_type_id`	`string`	equals, contains, startsWith, endsWith, in
`state`	`string`	equals, contains, startsWith, endsWith, in
`num_workers`	`number`	equals, gt, gte, lt, lte, 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.

Job

Path: databricks.db.job.search

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

Searchable filters

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

Warehouse

Path: databricks.db.warehouse.search

const rows = await corsair.databricks.db.warehouse.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
`cluster_size`	`string`	equals, contains, startsWith, endsWith, in
`state`	`string`	equals, contains, startsWith, endsWith, in
`creator_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.

Overview

Plugins

Catalog

Searchable filters

Cluster

Searchable filters

Job

Searchable filters

Warehouse

Searchable filters

​Catalog

​Searchable filters

​Cluster

​Searchable filters

​Job

​Searchable filters

​Warehouse

​Searchable filters

Catalog

Searchable filters

Cluster

Searchable filters

Job

Searchable filters

Warehouse

Searchable filters