List Basin Catalogs

client.BasinCatalog.List(ctx, query) (*BasinCatalogListResponse, error)

GET/accounts/{account_id}/basin-catalog

Returns a list of R2 buckets that have been enabled as Apache Iceberg catalogs for the specified account. Each catalog represents an R2 bucket configured to store Iceberg metadata and data files.

Security

API Token

The preferred authorization scheme for interacting with the Cloudflare API. Create a token.

Example:Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

Example:X-Auth-Email: user@example.com

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

Example:X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194

Accepted Permissions (at least one required)

Workers R2 Data Catalog WriteWorkers R2 Data Catalog Read

ParametersExpand Collapse

query BasinCatalogListParams

AccountID param.Field[string]

Use this to identify the account.

ReturnsExpand Collapse

type BasinCatalogListResponse struct{…}

Contains the list of catalogs.

Warehouses []BasinCatalogListResponseWarehouse

Lists catalogs in the account.

ID string

Use this to uniquely identify the catalog.

formatuuid

Bucket string

Specifies the associated R2 bucket name.

Name string

Specifies the catalog name (generated from account and bucket name).

Status BasinCatalogListResponseWarehousesStatus

Indicates the status of the catalog.

One of the following:

const BasinCatalogListResponseWarehousesStatusActive BasinCatalogListResponseWarehousesStatus = "active"

const BasinCatalogListResponseWarehousesStatusInactive BasinCatalogListResponseWarehousesStatus = "inactive"

CredentialStatus BasinCatalogListResponseWarehousesCredentialStatusOptional

Shows the credential configuration status.

One of the following:

const BasinCatalogListResponseWarehousesCredentialStatusPresent BasinCatalogListResponseWarehousesCredentialStatus = "present"

const BasinCatalogListResponseWarehousesCredentialStatusAbsent BasinCatalogListResponseWarehousesCredentialStatus = "absent"

MaintenanceConfig BasinCatalogListResponseWarehousesMaintenanceConfigOptional

Configures maintenance for the catalog.

Compaction BasinCatalogListResponseWarehousesMaintenanceConfigCompactionOptional

Configures compaction for catalog maintenance.

State BasinCatalogListResponseWarehousesMaintenanceConfigCompactionState

Specifies the state of maintenance operations.

One of the following:

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionStateEnabled BasinCatalogListResponseWarehousesMaintenanceConfigCompactionState = "enabled"

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionStateDisabled BasinCatalogListResponseWarehousesMaintenanceConfigCompactionState = "disabled"

TargetSizeMB BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB

Sets the target file size for compaction in megabytes. Defaults to “128”.

One of the following:

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB64 BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "64"

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB128 BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "128"

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB256 BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "256"

const BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB512 BasinCatalogListResponseWarehousesMaintenanceConfigCompactionTargetSizeMB = "512"

Interval stringOptional

Scheduling interval between normal table maintenance runs.

SnapshotExpiration BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationOptional

Configures snapshot expiration settings.

MaxSnapshotAge string

Specifies the maximum age for snapshots. The system deletes snapshots older than this age. Format: where unit is d (days), h (hours), m (minutes), or s (seconds). Examples: “7d” (7 days), “48h” (48 hours), “2880m” (2,880 minutes). Defaults to “7d”.

MinSnapshotsToKeep int64

Specifies the minimum number of snapshots to retain. Defaults to 100.

formatint64

minimum1

State BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState

Specifies the state of maintenance operations.

One of the following:

const BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationStateEnabled BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState = "enabled"

const BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationStateDisabled BasinCatalogListResponseWarehousesMaintenanceConfigSnapshotExpirationState = "disabled"

List Basin Catalogs

package main

import (
  "context"
  "fmt"

  "github.com/cloudflare/cloudflare-go"
  "github.com/cloudflare/cloudflare-go/basin_catalog"
  "github.com/cloudflare/cloudflare-go/option"
)

func main() {
  client := cloudflare.NewClient(
    option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
  )
  basinCatalogs, err := client.BasinCatalog.List(context.TODO(), basin_catalog.BasinCatalogListParams{
    AccountID: cloudflare.F("0123456789abcdef0123456789abcdef"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", basinCatalogs.Warehouses)
}

{
  "errors": [],
  "messages": [],
  "result": {
    "warehouses": [
      {
        "bucket": "analytics-bucket",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "maintenance_config": {
          "compaction": {
            "state": "enabled",
            "target_size_mb": "128"
          },
          "snapshot_expiration": {
            "max_snapshot_age": "7d",
            "min_snapshots_to_keep": 100,
            "state": "enabled"
          }
        },
        "name": "account123_analytics-bucket",
        "status": "active"
      },
      {
        "bucket": "logs-bucket",
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "maintenance_config": {
          "compaction": {
            "state": "disabled",
            "target_size_mb": "128"
          },
          "snapshot_expiration": {
            "max_snapshot_age": "7d",
            "min_snapshots_to_keep": 100,
            "state": "disabled"
          }
        },
        "name": "account123_logs-bucket",
        "status": "inactive"
      }
    ]
  },
  "success": true
}

Returns Examples

{
  "errors": [],
  "messages": [],
  "result": {
    "warehouses": [
      {
        "bucket": "analytics-bucket",
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "maintenance_config": {
          "compaction": {
            "state": "enabled",
            "target_size_mb": "128"
          },
          "snapshot_expiration": {
            "max_snapshot_age": "7d",
            "min_snapshots_to_keep": 100,
            "state": "enabled"
          }
        },
        "name": "account123_analytics-bucket",
        "status": "active"
      },
      {
        "bucket": "logs-bucket",
        "id": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
        "maintenance_config": {
          "compaction": {
            "state": "disabled",
            "target_size_mb": "128"
          },
          "snapshot_expiration": {
            "max_snapshot_age": "7d",
            "min_snapshots_to_keep": 100,
            "state": "disabled"
          }
        },
        "name": "account123_logs-bucket",
        "status": "inactive"
      }
    ]
  },
  "success": true
}