Interface CatalogPrefixParser

All Known Implementing Classes:
DefaultCatalogPrefixParser

public interface CatalogPrefixParser
An extension point for converting Iceberg REST API "prefix" values to Polaris Catalog names.
  • Method Summary

    Modifier and Type
    Method
    Description
    catalogNameToPrefix(org.apache.polaris.core.context.RealmContext realm, String catalogName)
    Produces the "prefix" according to the Iceberg REST Catalog API specification for the given Polaris catalog name in the specified realm.
    prefixToCatalogName(org.apache.polaris.core.context.RealmContext realm, String prefix)
    Produces the name of a Polaris catalog from the given Iceberg Catalog REST API "prefix" for the specified realm.
  • Method Details

    • prefixToCatalogName

      String prefixToCatalogName(org.apache.polaris.core.context.RealmContext realm, String prefix)
      Produces the name of a Polaris catalog from the given Iceberg Catalog REST API "prefix" for the specified realm.
      Parameters:
      realm - identifies the realm where the API request is to be served.
      prefix - the "prefix" according to the Iceberg REST Catalog API specification.
      Returns:
      Polaris Catalog name
    • catalogNameToPrefix

      String catalogNameToPrefix(org.apache.polaris.core.context.RealmContext realm, String catalogName)
      Produces the "prefix" according to the Iceberg REST Catalog API specification for the given Polaris catalog name in the specified realm.
      Parameters:
      realm - identifies the realm owning the catalog
      catalogName - name of a Polaris catalog.
      Returns:
      the "prefix" for the Iceberg REST client to be used for requests to the given catalog.