org.apache.flink.cdc.common.event.TableId Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of flink-cdc-common Show documentation
The newest version!
/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.apache.flink.cdc.common.event;

import org.apache.flink.cdc.common.annotation.PublicEvolving;

import javax.annotation.Nullable;

import java.io.Serializable;
import java.util.Objects;

/**
 * The unique identifier used to represent the path of external table or external data collection,
 * all external system data collection could map to a dedicated {@code TableId}.
 *
 * 
 *   {@code TableId} contains at most three parts, it will be treated as namespace, schema name
 *       and table name.
 *   
{@code TableId} could contain two parts, it will be treated as schema name and table name.
 *   
{@code TableId} could contain only one part, it will be treated as table name.
 * 
 *
 * Connectors need to establish the mapping between {@code TableId} and external data collection
 * object path. For example,
 *
 * 

 *   The mapping relationship for Oracle is: (database, schema, table).
 *   
The mapping relationship for MySQL or Doris is: (database, table).
 *   
The mapping relationship for Kafka is: (topic).
 * 
 */
@PublicEvolving
public class TableId implements Serializable {

    @Nullable private final String namespace;
    @Nullable private final String schemaName;
    private final String tableName;

    private TableId(@Nullable String namespace, @Nullable String schemaName, String tableName) {
        this.namespace = namespace;
        this.schemaName = schemaName;
        this.tableName = Objects.requireNonNull(tableName);
    }

    /** The mapping relationship for external systems. e.g. Oracle (database, schema, table). */
    public static TableId tableId(String namespace, String schemaName, String tableName) {
        return new TableId(
                Objects.requireNonNull(namespace), Objects.requireNonNull(schemaName), tableName);
    }

    /** The mapping relationship for external systems. e.g. MySQL (database, table). */
    public static TableId tableId(String schemaName, String tableName) {
        return new TableId(null, Objects.requireNonNull(schemaName), tableName);
    }

    /** The mapping relationship for external systems. e.g. Kafka (topic). */
    public static TableId tableId(String tableName) {
        return new TableId(null, null, tableName);
    }

    public static TableId parse(String tableId) {
        String[] parts = Objects.requireNonNull(tableId).split("\\.");
        if (parts.length == 3) {
            return tableId(parts[0], parts[1], parts[2]);
        } else if (parts.length == 2) {
            return tableId(parts[0], parts[1]);
        } else if (parts.length == 1) {
            return tableId(parts[0]);
        }
        throw new IllegalArgumentException("Invalid tableId: " + tableId);
    }

    public String identifier() {
        if (namespace == null || namespace.isEmpty()) {
            if (schemaName == null || schemaName.isEmpty()) {
                return tableName;
            }
            return schemaName + "." + tableName;
        }
        return namespace + "." + schemaName + "." + tableName;
    }

    @Nullable
    public String getNamespace() {
        return namespace;
    }

    @Nullable
    public String getSchemaName() {
        return schemaName;
    }

    public String getTableName() {
        return tableName;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        TableId that = (TableId) o;
        return Objects.equals(namespace, that.namespace)
                && Objects.equals(schemaName, that.schemaName)
                && Objects.equals(tableName, that.tableName);
    }

    @Override
    public int hashCode() {
        return Objects.hash(namespace, schemaName, tableName);
    }

    @Override
    public String toString() {
        return identifier();
    }
}