PolarisCatalogSpecification

class PolarisCatalogSpecification(val catalogType: CatalogType.Type = Type.POLARIS, val serverUri: String, val catalogName: String, val clientId: String, val clientSecret: String, val namespace: String) : CatalogType

Polaris catalog specifications.

Provides configuration details required to connect to Apache Polaris catalog service and manage Iceberg table metadata.

Constructors

Link copied to clipboard
constructor(catalogType: CatalogType.Type = Type.POLARIS, serverUri: String, catalogName: String, clientId: String, clientSecret: String, namespace: String)

Properties

Link copied to clipboard
@get:JsonPropertyDescription(value = "The name of the catalog in Polaris. This corresponds to the catalog name created via the Polaris Management API.")
val catalogName: String

The Polaris catalog name.

Link copied to clipboard
open override val catalogType: CatalogType.Type
Link copied to clipboard
@get:JsonPropertyDescription(value = "The OAuth Client ID for authenticating with the Polaris server.")
val clientId: String

OAuth Client ID for Polaris authentication.

Link copied to clipboard
@get:JsonPropertyDescription(value = "The OAuth Client Secret for authenticating with the Polaris server.")
val clientSecret: String

OAuth Client Secret for Polaris authentication.

Link copied to clipboard
@get:JsonPropertyDescription(value = "The Polaris namespace to be used in the Table identifier. This will ONLY be used if the `Destination Namespace` setting for the connection is set to `Destination-defined` or `Source-defined`")
val namespace: String

The namespace to be used when building the Table identifier

Link copied to clipboard
@get:JsonPropertyDescription(value = "The base URL of the Polaris server used to connect to the Polaris catalog.")
val serverUri: String

The URI of the Polaris server.