org.apache.flink.table.operations.ddl.CreateFunctionOperation 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.

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

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

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

/**
 * Operation to describe a CREATE FUNCTION statement for catalog function.
 */
public class CreateFunctionOperation implements CreateOperation {
	private final ObjectIdentifier functionIdentifier;
	private CatalogFunction catalogFunction;
	private boolean ignoreIfExists;
	private boolean isTemporary;

	public CreateFunctionOperation(
		ObjectIdentifier functionIdentifier,
		CatalogFunction catalogFunction,
		boolean ignoreIfExists,
		boolean isTemporary) {
		this.functionIdentifier = functionIdentifier;
		this.catalogFunction = catalogFunction;
		this.ignoreIfExists = ignoreIfExists;
		this.isTemporary = isTemporary;
	}

	public CatalogFunction getCatalogFunction() {
		return this.catalogFunction;
	}

	public ObjectIdentifier getFunctionIdentifier() {
		return this.functionIdentifier;
	}

	public boolean isIgnoreIfExists() {
		return this.ignoreIfExists;
	}

	public boolean isTemporary() {
		return isTemporary;
	}

	@Override
	public String asSummaryString() {
		Map params = new LinkedHashMap<>();
		params.put("catalogFunction", catalogFunction.getDetailedDescription());
		params.put("identifier", functionIdentifier);
		params.put("ignoreIfExists", ignoreIfExists);
		params.put("isTemporary", isTemporary);

		return OperationUtils.formatWithChildren(
			"CREATE CATALOG FUNCTION",
			params,
			Collections.emptyList(),
			Operation::asSummaryString);
	}

	public String getFunctionName() {
		return this.functionIdentifier.getObjectName();
	}
}