Page History

@PublicEvolving
public interface Catalog {
    
    /**
     * Returns a factory for creating instances from catalog objects.
     *
     * <p>This method enables bypassing the discovery process. Implementers can directly pass
     * internal catalog-specific objects to their own factory. For example, a custom {@link
     * CatalogTable} can be processed by a custom {@link DynamicTableFactory}.
     *
     * <p>If this catalog support to create dynamic table, you should also override this method to
     * provide {@link DynamicTableFactory} which help planner to find {@link DynamicTableSource} and
     * {@link DynamicTableSink} correctly during compile optimization phase. If you don't override
     * this method, you must specify the physical connector identifier that this catalog represents
     * storage when create dynamic table. Otherwise, the planner can't find the {@link
     * DynamicTableFactory}.
     *
     * <p>Because all factories are interfaces, the returned {@link Factory} instance can implement
     * multiple supported extension points. An {@code instanceof} check is performed by the caller
     * that checks whether a required factory is implemented; otherwise the discovery process is
     * used.
     */
    default Optional<Factory> getFactory() {
        return Optional.empty();
    }
}

/**
 * This interface represents the meta information of current dynamic table background refresh
 * pipeline. The refresh mode maybe continuous or full. The format of the meta information in the
 * two modes is not consistent, so user need to implementation this interface according to .
 *
 * <p>This meta information will be serialized to bytes by {@link RefreshHandlerSerializer}, then
 * store to Catalog for suspend or drop {@link CatalogDynamicTable}.
 *
 * <p>In continuous mode, the format of the meta information maybe { "clusterType": "yarn",
 * "clusterId": "xxx", "jobId": "yyyy" }.
 *
 * <p>In full mode, the meta information format maybe { "endpoint": "xxx", "workflowId": "yyy" }.
 * Due to you may use different workflow scheduler plugin in this mode, you should implement this
 * interface according to your plugin.
 */
@PublicEvolving
public interface RefreshHandler {

    /** Returns a string that summarizes this refresh handler meta information. */
    String asSummaryString();
}

/**
 * A validated {@link CatalogDynamicTable} that is backed by the original metadata coming from the
 * {@link Catalog} but resolved by the framework.
 *
 * <p>Note: This will be converted to {@link ResolvedCatalogTable} by framework during planner
 * optimize query phase.
 */
@PublicEvolving
public class ResolvedCatalogDynamicTable
        implements ResolvedCatalogBaseTable<CatalogDynamicTable>, CatalogDynamicTable {

    private final CatalogDynamicTable origin;

    private final ResolvedSchema resolvedSchema;

    public ResolvedCatalogDynamicTable(CatalogDynamicTable origin, ResolvedSchema resolvedSchema) {
        this.origin =
                Preconditions.checkNotNull(
                        origin, "Original catalog dynamic table must not be null.");
        this.resolvedSchema =
                Preconditions.checkNotNull(resolvedSchema, "Resolved schema must not be null.");
    }

    @Override
    public Map<String, String> getOptions() {
        return origin.getOptions();
    }

    @Override
    public String getComment() {
        return origin.getComment();
    }

    @Override
    public CatalogBaseTable copy() {
        return new ResolvedCatalogDynamicTable((CatalogDynamicTable) origin.copy(), resolvedSchema);
    }

    @Override
    public Optional<String> getDescription() {
        return origin.getDescription(

/**
 * A validated {@link CatalogDynamicTable} that is backed by the original metadata coming from the
 * {@link Catalog} but resolved by the framework.
 *
 * <p>Note: This will be converted to {@link ResolvedCatalogTable} by framework during planner
 * optimize query phase.
 */
@PublicEvolving
public class ResolvedCatalogDynamicTable
        implements ResolvedCatalogBaseTable<CatalogDynamicTable>, CatalogDynamicTable {

    private final CatalogDynamicTable origin;

    private final ResolvedSchema resolvedSchema;

    public ResolvedCatalogDynamicTable(CatalogDynamicTable origin, ResolvedSchema resolvedSchema) {
        this.origin =
                Preconditions.checkNotNull(
                        origin, "Original catalog dynamic table must not be null.");
        this.resolvedSchema =
                Preconditions.checkNotNull(resolvedSchema, "Resolved schema must not be null.");
    }

    @Override
    public Map<String, String> getOptionsOptional<String> getDetailedDescription() {
        return origin.getOptionsgetDetailedDescription();
    }

    @Override
    public Stringboolean getCommentisPartitioned() {
        return origin.getCommentisPartitioned();
    }

    @Override
    public CatalogBaseTableList<String> copygetPartitionKeys() {
        return new ResolvedCatalogDynamicTable((CatalogDynamicTable) origin.copygetPartitionKeys(), resolvedSchema);
    }

    @Override
    public Optional<String>ResolvedCatalogDynamicTable getDescription(copy(Map<String, String> options) {
        return  new ResolvedCatalogDynamicTable(origin.getDescriptioncopy(options), resolvedSchema);
    }

    @Override
    public Optional<String>Optional<Long> getDetailedDescriptiongetSnapshot() {
        return originOptional.getDetailedDescriptionempty();
    }

    @Override
    public booleanCatalogDynamicTable isPartitionedgetOrigin() {
        return origin.isPartitioned();
    }

    @Override
    public List<String>ResolvedSchema getPartitionKeysgetResolvedSchema() {
        return origin.getPartitionKeys()resolvedSchema;
    }

    @Override
    public ResolvedCatalogDynamicTableString copy(Map<String, String> optionsgetDefinitionQuery() {
        return new ResolvedCatalogDynamicTable(origin.copygetDefinitionQuery(options), resolvedSchema);
    }

    @Override
    public CatalogDynamicTableDuration getOrigingetFreshness() {
        return origin.getFreshness();
    }

    @Override
    public ResolvedSchemaLogicalRefreshMode getResolvedSchemagetLogicalRefreshMode() {
        return resolvedSchemaorigin.getLogicalRefreshMode();
    }

    @Override
    public StringRefreshMode getDefinitionQuerygetRefreshMode() {
        return origin.getDefinitionQuerygetRefreshMode();
    }

    @Override
    public DurationRefreshStatus getFreshnessgetRefreshStatus() {
        return origin.getFreshnessgetRefreshStatus();
    }

    @Override
    public RefreshModeOptional<String> getRefreshModegetRefreshHandlerDescription() {
        return origin.getRefreshModegetRefreshHandlerDescription();
    }

    @Nullable
    @Override
    public RefreshHandlerbyte[] getRefreshHandlergetSerializableRefreshHandler() {
        return origin.getRefreshHandlergetSerializableRefreshHandler();
    }
}