io.debezium.connector.jdbc.relational.TableDescriptor Maven / Gradle / Ivy

Go to download
/*
 * Copyright Debezium Authors.
 *
 * Licensed under the Apache Software License version 2.0, available at http://www.apache.org/licenses/LICENSE-2.0
 */
package io.debezium.connector.jdbc.relational;

import java.util.ArrayList;
import java.util.Collection;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.stream.Collectors;

import io.debezium.DebeziumException;
import io.debezium.annotation.Immutable;
import io.debezium.connector.jdbc.JdbcSinkConnectorConfig;
import io.debezium.metadata.CollectionId;

/**
 * Describes a relational table.
 *
 * @author Chris Cranford
 */
@Immutable
public class TableDescriptor {

    private final CollectionId id;
    private final String tableType;
    private final Map columns = new LinkedHashMap<>();
    private final List primaryKeyColumnNames;
    private final boolean autoGeneratedIdentityColumn;

    private TableDescriptor(CollectionId id, String tableType, List columns, List primaryKeyColumnNames) {
        this.id = id;
        this.tableType = tableType;
        this.primaryKeyColumnNames = primaryKeyColumnNames;
        columns.forEach(c -> this.columns.put(c.getColumnName(), c));
        this.autoGeneratedIdentityColumn = columns.stream().findFirst().filter(ColumnDescriptor::isAutoIncrement).isPresent();
    }

    public static Builder builder() {
        return new Builder();
    }

    public CollectionId getId() {
        return id;
    }

    public String getTableType() {
        return tableType;
    }

    public Collection getColumns() {
        return columns.values();
    }

    public ColumnDescriptor getColumnByName(String columnName) {
        final ColumnDescriptor column = columns.get(columnName);
        if (column == null) {
            throw new DebeziumException(String.format(
                    "Failed to find column '%s' in table '%s'. " +
                            "If you have not enabled '%s', this could be related to column/field case differences.",
                    columnName,
                    id.name(),
                    JdbcSinkConnectorConfig.QUOTE_IDENTIFIERS));
        }
        return column;
    }

    public boolean hasColumn(String columnName) {
        return columns.containsKey(columnName);
    }

    public List getPrimaryKeyColumnNames() {
        return primaryKeyColumnNames;
    }

    public Collection getPrimaryKeyColumns() {
        return columns.values().stream().filter(c -> primaryKeyColumnNames.contains(c.getColumnName())).collect(Collectors.toList());
    }

    public boolean hasAutoGeneratedIdentityColumn() {
        return autoGeneratedIdentityColumn;
    }

    public static class Builder {
        private String catalogName;
        private String schemaName;
        private String tableName;
        private String tableType;
        private final List columns = new ArrayList<>();
        private final List primaryKeyColumnNames = new ArrayList<>();

        private Builder() {
        }

        public Builder catalogName(String catalogName) {
            this.catalogName = catalogName;
            return this;
        }

        public Builder schemaName(String schemaName) {
            this.schemaName = schemaName;
            return this;
        }

        public Builder tableName(String tableName) {
            this.tableName = tableName;
            return this;
        }

        public Builder type(String tableType) {
            this.tableType = tableType;
            return this;
        }

        public Builder column(ColumnDescriptor column) {
            this.columns.add(column);
            return this;
        }

        public Builder columns(List columns) {
            this.columns.addAll(columns);
            return this;
        }

        public Builder keyColumn(ColumnDescriptor column) {
            return keyColumn(column.getColumnName());
        }

        public Builder keyColumn(String columnName) {
            this.primaryKeyColumnNames.add(columnName);
            return this;
        }

        public TableDescriptor build() {
            final CollectionId id = new CollectionId(catalogName, schemaName, tableName);
            return new TableDescriptor(id, tableType, columns, primaryKeyColumnNames);
        }
    }
}