io.trino.spi.connector.ConnectorTableMetadata Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of trino-spi Show documentation
Trino - Service Provider Interface (SPI)
There is a newer version: 458
/*
 * Licensed 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 io.trino.spi.connector;

import io.trino.spi.Experimental;

import java.util.Collections;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Optional;

import static java.util.Collections.emptyMap;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.toUnmodifiableList;

public class ConnectorTableMetadata
{
    private final SchemaTableName table;
    private final Optional comment;
    private final List columns;
    private final Map properties;
    private final List checkConstraints;

    public ConnectorTableMetadata(SchemaTableName table, List columns)
    {
        this(table, columns, emptyMap());
    }

    public ConnectorTableMetadata(SchemaTableName table, List columns, Map properties)
    {
        this(table, columns, properties, Optional.empty(), List.of());
    }

    public ConnectorTableMetadata(SchemaTableName table, List columns, Map properties, Optional comment)
    {
        this(table, columns, properties, comment, List.of());
    }

    @Experimental(eta = "2023-03-31")
    public ConnectorTableMetadata(SchemaTableName table, List columns, Map properties, Optional comment, List checkConstraints)
    {
        requireNonNull(table, "table is null");
        requireNonNull(columns, "columns is null");
        requireNonNull(comment, "comment is null");
        requireNonNull(checkConstraints, "checkConstraints is null");

        this.table = table;
        this.columns = List.copyOf(columns);
        this.properties = Collections.unmodifiableMap(new LinkedHashMap<>(properties));
        this.comment = comment;
        this.checkConstraints = List.copyOf(checkConstraints);
    }

    public SchemaTableName getTable()
    {
        return table;
    }

    public List getColumns()
    {
        return columns;
    }

    public Map getProperties()
    {
        return properties;
    }

    public Optional getComment()
    {
        return comment;
    }

    /**
     * List of constraints data in a table is expected to satisfy.
     * Engine ensures rows written to a table meet these constraints.
     * A check constraint is satisfied when it evaluates to True or Unknown.
     *
     * @return List of string representation of a Trino SQL scalar expression that can refer to table columns by name and produces a result coercible to boolean
     */
    @Experimental(eta = "2023-03-31")
    public List getCheckConstraints()
    {
        return checkConstraints;
    }

    public ConnectorTableSchema getTableSchema()
    {
        return new ConnectorTableSchema(
                table,
                columns.stream()
                        .map(ColumnMetadata::getColumnSchema)
                        .collect(toUnmodifiableList()),
                checkConstraints);
    }

    @Override
    public String toString()
    {
        StringBuilder sb = new StringBuilder("ConnectorTableMetadata{");
        sb.append("table=").append(table);
        sb.append(", columns=").append(columns);
        sb.append(", properties=").append(properties);
        comment.ifPresent(value -> sb.append(", comment='").append(value).append("'"));
        sb.append(", checkConstraints=").append(checkConstraints);
        sb.append('}');
        return sb.toString();
    }
}