io.delta.flink.internal.table.DeltaCatalogBaseTable Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of delta-flink Show documentation

delta-flink

There is a newer version: 3.2.1

package io.delta.flink.internal.table;

import java.util.Map;
import javax.annotation.Nonnull;

import org.apache.flink.table.catalog.CatalogBaseTable;
import org.apache.flink.table.catalog.ObjectPath;
import org.apache.flink.table.factories.FactoryUtil;
import static org.apache.flink.util.Preconditions.checkNotNull;

/**
 * Data object used by Delta Catalog implementation API that wraps Flink's {@link ObjectPath}
 * represented by databaseName.tableName and {@link CatalogBaseTable} containing table properties
 * and schema from DDL.
 */
public class DeltaCatalogBaseTable {

    /**
     * A database name and table name combo in catalog's metastore.
     */
    @Nonnull
    private final ObjectPath tableCatalogPath;

    /**
     * A catalog table identified by {@link #tableCatalogPath}
     */
    @Nonnull
    private final CatalogBaseTable catalogTable;

    private final boolean isDeltaTable;

    public DeltaCatalogBaseTable(ObjectPath tableCatalogPath, CatalogBaseTable catalogTable) {
        checkNotNull(tableCatalogPath, "Object path cannot be null for DeltaCatalogBaseTable.");
        checkNotNull(catalogTable, "Catalog table cannot be null for DeltaCatalogBaseTable.");
        this.tableCatalogPath = tableCatalogPath;
        this.catalogTable = catalogTable;

        String connectorType = catalogTable.getOptions().get(FactoryUtil.CONNECTOR.key());
        this.isDeltaTable =
            DeltaDynamicTableFactory.DELTA_CONNECTOR_IDENTIFIER.equals(connectorType);
    }

    public ObjectPath getTableCatalogPath() {
        return tableCatalogPath;
    }

    public CatalogBaseTable getCatalogTable() {
        return catalogTable;
    }

    public boolean isDeltaTable() {
        return isDeltaTable;
    }

    public Map getOptions() {
        return catalogTable.getOptions();
    }

    public String getDatabaseName() {
        return tableCatalogPath.getDatabaseName();
    }
}