org.apache.paimon.spark.procedure.ProcedureBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of paimon-spark-common Show documentation

There is a newer version: 0.9.0

/*
 * 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.paimon.spark.procedure;

import org.apache.spark.sql.connector.catalog.Identifier;
import org.apache.spark.sql.connector.catalog.TableCatalog;

/** A builder of {@link Procedure} that builds a stored procedure. */
public interface ProcedureBuilder {

    /**
     * Returns a {@link ProcedureBuilder procedure builder} via given table catalog.
     *
     * @param tableCatalog The table catalog.
     * @return The procedure builder with given catalog.
     */
    ProcedureBuilder withTableCatalog(TableCatalog tableCatalog);

    /**
     * Builds a {@link Procedure stored procedure} via given {@link Identifier identifier}.
     *
     * @return The stored procedure of given identifier.
     */
    Procedure build();
}