org.apache.paimon.spark.procedure.Procedure 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.catalyst.InternalRow;
import org.apache.spark.sql.types.StructType;

/** An interface that defines an executable stored procedure. */
public interface Procedure {

    /** Returns the input parameters of stored procedure. */
    ProcedureParameter[] parameters();

    /** Returns the type of rows produced by stored procedure. */
    StructType outputType();

    /**
     * Executes the given stored procedure.
     *
     * @param args Input arguments.
     * @return The result of executing stored procedure with the given arguments.
     */
    InternalRow[] call(InternalRow args);

    /** Returns the description of stored procedure. */
    default String description() {
        return this.getClass().toString();
    }
}