IcebergCatalogSpecifications

Interface defining the specifications for configuring an Iceberg catalog.

This includes general warehouse information as well as details about the primary branch and the specific type of catalog (e.g., Nessie or Glue). Implementations of this interface should provide the necessary configuration to connect to and use an Iceberg catalog in different environments.

Properties

Link copied to clipboard
@get:JsonPropertyDescription(value = "Specifies the type of Iceberg catalog (e.g., NESSIE, GLUE, REST, POLARIS) and its associated configuration.")
abstract val catalogType: CatalogType

The catalog type.

Link copied to clipboard
@get:JsonPropertyDescription(value = "The primary or default branch name in the catalog. Most query engines will use "main" by default. See <a href="https://iceberg.apache.org/docs/latest/branching/">Iceberg documentation</a> for more information.")
abstract val mainBranchName: String

The name of the main branch in the Nessie repository (or the equivalent main branch in other catalog types).

Link copied to clipboard

The warehouse location.

Functions

Link copied to clipboard

Converts the current specifications into a common Iceberg catalog configuration object.