org.apache.flink.table.operations.ddl.AlterTableAddConstraintOperation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of flink-table-api-java Show documentation

This module contains the Table/SQL API for writing table programs within the table ecosystem using the Java programming language.

There is a newer version: 2.0-preview1

Show 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.table.operations.ddl;

import org.apache.flink.table.catalog.ObjectIdentifier;
import org.apache.flink.table.operations.Operation;
import org.apache.flink.table.operations.OperationUtils;

import javax.annotation.Nullable;

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

/**
 * Operation of "ALTER TABLE ADD [CONSTRAINT constraintName] ..." clause.
 *
 * Note: only primary key is supported now.
 */
public class AlterTableAddConstraintOperation extends AlterTableOperation {
    private final String constraintName;
    private final String[] columnNames;

    public AlterTableAddConstraintOperation(
            ObjectIdentifier tableIdentifier,
            @Nullable String constraintName,
            String[] columnNames) {
        super(tableIdentifier);
        this.constraintName = constraintName;
        this.columnNames = columnNames;
    }

    public Optional getConstraintName() {
        return Optional.ofNullable(constraintName);
    }

    public String[] getColumnNames() {
        return columnNames;
    }

    @Override
    public String asSummaryString() {
        Map params = new LinkedHashMap<>();
        params.put("identifier", tableIdentifier);
        if (getConstraintName().isPresent()) {
            params.put("constraintName", this.constraintName);
        }
        params.put("columns", this.columnNames);

        return OperationUtils.formatWithChildren(
                "ALTER TABLE ADD CONSTRAINT",
                params,
                Collections.emptyList(),
                Operation::asSummaryString);
    }
}