Basin Catalog
List Basin Catalogs
Get Basin Catalog details
Enable R2 bucket as a catalog
Disable Basin Catalog
Delete Basin Catalog metadata
ModelsExpand Collapse
BasinCatalogListResponse object { warehouses } Contains the list of catalogs.
Contains the list of catalogs.
warehouses: array of object { id, bucket, name, 5 more } Lists catalogs in the account.
Lists catalogs in the account.
Specifies the Iceberg REST catalog URI that clients use to connect to the catalog.
Specifies the data-locality jurisdiction of the catalog. The first enable sets it, and it cannot change. Currently always default.
maintenance_config: optional object { compaction, interval, snapshot_expiration } Configures maintenance for the catalog.
Configures maintenance for the catalog.
compaction: optional object { state, target_size_mb } Configures compaction for catalog maintenance.
Configures compaction for catalog maintenance.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state } Configures snapshot expiration settings.
Configures snapshot expiration settings.
Specifies the maximum age for snapshots. The system deletes snapshots older than this age.
Format:
BasinCatalogGetResponse object { id, bucket, name, 5 more } Contains catalog information.
Contains catalog information.
Specifies the Iceberg REST catalog URI that clients use to connect to the catalog.
Specifies the data-locality jurisdiction of the catalog. The first enable sets it, and it cannot change. Currently always default.
maintenance_config: optional object { compaction, interval, snapshot_expiration } Configures maintenance for the catalog.
Configures maintenance for the catalog.
compaction: optional object { state, target_size_mb } Configures compaction for catalog maintenance.
Configures compaction for catalog maintenance.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state } Configures snapshot expiration settings.
Configures snapshot expiration settings.
Specifies the maximum age for snapshots. The system deletes snapshots older than this age.
Format:
Basin CatalogMaintenance Configs
Get catalog maintenance configuration
Update catalog maintenance configuration
ModelsExpand Collapse
MaintenanceConfigGetResponse object { credential_status, maintenance_config } Contains maintenance configuration and credential status.
Contains maintenance configuration and credential status.
maintenance_config: object { compaction, interval, snapshot_expiration } Configures maintenance for the catalog.
Configures maintenance for the catalog.
compaction: optional object { state, target_size_mb } Configures compaction for catalog maintenance.
Configures compaction for catalog maintenance.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state } Configures snapshot expiration settings.
Configures snapshot expiration settings.
Specifies the maximum age for snapshots. The system deletes snapshots older than this age.
Format:
MaintenanceConfigUpdateResponse object { compaction, interval, snapshot_expiration } Configures maintenance for the catalog.
Configures maintenance for the catalog.
compaction: optional object { state, target_size_mb } Configures compaction for catalog maintenance.
Configures compaction for catalog maintenance.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state } Configures snapshot expiration settings.
Configures snapshot expiration settings.
Specifies the maximum age for snapshots. The system deletes snapshots older than this age.
Format:
Basin CatalogCredentials
Store catalog credentials
Basin CatalogNamespaces
List namespaces in catalog
ModelsExpand Collapse
NamespaceListResponse object { namespaces, details, namespace_uuids, next_page_token } Contains the list of namespaces with optional pagination.
Contains the list of namespaces with optional pagination.
details: optional array of object { namespace, namespace_uuid, created_at, updated_at } Contains detailed metadata for each namespace when return_details is true.
Each object includes the namespace, UUID, and timestamps.
Contains detailed metadata for each namespace when return_details is true. Each object includes the namespace, UUID, and timestamps.
Basin CatalogNamespacesTables
List tables in namespace
ModelsExpand Collapse
TableListResponse object { identifiers, details, next_page_token, table_uuids } Contains the list of tables with optional pagination.
Contains the list of tables with optional pagination.
details: optional array of object { identifier, table_uuid, created_at, 3 more } Contains detailed metadata for each table when return_details is true.
Each object includes identifier, UUID, timestamps, and locations.
Contains detailed metadata for each table when return_details is true. Each object includes identifier, UUID, timestamps, and locations.
Basin CatalogNamespacesTablesMaintenance Configs
Get table maintenance configuration
Update table maintenance configuration
ModelsExpand Collapse
MaintenanceConfigGetResponse object { maintenance_config } Contains table maintenance configuration.
Contains table maintenance configuration.
maintenance_config: object { compaction, interval, snapshot_expiration } Configures maintenance for the table.
Configures maintenance for the table.
compaction: optional object { state, target_size_mb, next_eligible_at, next_eligible_reason } Configures compaction settings for table optimization.
Configures compaction settings for table optimization.
target_size_mb: "64" or "128" or "256" or "512"Sets the target file size for compaction in megabytes. Defaults to “128”.
Sets the target file size for compaction in megabytes. Defaults to “128”.
Earliest time when the scheduler can claim this operation. Null when disabled.
next_eligible_reason: optional "disabled" or "held_after_user_error" or "running" or 2 moreWhy the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
Why the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state, 2 more }
Specifies the minimum number of snapshots to retain. Defaults to 100.
Earliest time when the scheduler can claim this operation. Null when disabled.
next_eligible_reason: optional "disabled" or "held_after_user_error" or "running" or 2 moreWhy the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
Why the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
MaintenanceConfigUpdateResponse object { compaction, interval, snapshot_expiration } Configures maintenance for the table.
Configures maintenance for the table.
compaction: optional object { state, target_size_mb, next_eligible_at, next_eligible_reason } Configures compaction settings for table optimization.
Configures compaction settings for table optimization.
target_size_mb: "64" or "128" or "256" or "512"Sets the target file size for compaction in megabytes. Defaults to “128”.
Sets the target file size for compaction in megabytes. Defaults to “128”.
Earliest time when the scheduler can claim this operation. Null when disabled.
next_eligible_reason: optional "disabled" or "held_after_user_error" or "running" or 2 moreWhy the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
Why the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
snapshot_expiration: optional object { max_snapshot_age, min_snapshots_to_keep, state, 2 more }
Specifies the minimum number of snapshots to retain. Defaults to 100.
Earliest time when the scheduler can claim this operation. Null when disabled.
next_eligible_reason: optional "disabled" or "held_after_user_error" or "running" or 2 moreWhy the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.
Why the operation is not eligible to run before next_eligible_at. Returned by the per-table GET only, and absent from the update response. held_after_user_error means a customer-caused failure holds the lease until it expires.