R2 Data Catalog

R2DataCatalog

Methods

list(, ):
get/accounts/{account_id}/r2-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.

get(, , ):
get/accounts/{account_id}/r2-catalog/{bucket_name}

Retrieve detailed information about a specific R2 catalog by bucket name. Returns catalog status, maintenance configuration, and credential status.

enable(, , ):
post/accounts/{account_id}/r2-catalog/{bucket_name}/enable

Enable an R2 bucket as an Apache Iceberg catalog. This operation creates the necessary catalog infrastructure and activates the bucket for storing Iceberg metadata and data files.

disable(, , ): void
post/accounts/{account_id}/r2-catalog/{bucket_name}/disable

Disable an R2 bucket as a catalog. This operation deactivates the catalog but preserves existing metadata and data files. The catalog can be re-enabled later.

R2 Data Catalog

Credentials

R2DataCatalog.Credentials

Methods

create(, , ): | null
post/accounts/{account_id}/r2-catalog/{bucket_name}/credential

Store authentication credentials for a catalog. These credentials are used to authenticate with R2 storage when performing catalog operations.

R2 Data Catalog

Maintenance Configs

R2DataCatalog.MaintenanceConfigs

Methods

get(, , ):
get/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

Retrieve the maintenance configuration for a specific catalog, including compaction settings and credential status.

update(, , ):
post/accounts/{account_id}/r2-catalog/{bucket_name}/maintenance-configs

Update the maintenance configuration for a catalog. This allows you to enable or disable compaction and adjust target file sizes for optimization.

R2 Data Catalog

Namespaces

R2DataCatalog.Namespaces

Methods

list(, , ):
get/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces

Returns a list of namespaces in the specified R2 catalog. Supports hierarchical filtering and pagination for efficient traversal of large namespace hierarchies.

R2DataCatalog.Namespaces.Tables

Methods

list(, , , ):
get/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables

Returns a list of tables in the specified namespace within an R2 catalog. Supports pagination for efficient traversal of large table collections.

R2DataCatalog.Namespaces.Tables.MaintenanceConfigs

Methods

get(, , , , ):
get/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs

Retrieve the maintenance configuration for a specific table, including compaction settings.

update(, , , , ):
post/accounts/{account_id}/r2-catalog/{bucket_name}/namespaces/{namespace}/tables/{table_name}/maintenance-configs

Update the maintenance configuration for a specific table. This allows you to enable or disable compaction and adjust target file sizes for optimization.