io.trino.spi.procedure.Procedure 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)
The newest version!
/*
 * 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.procedure;

import io.trino.spi.connector.ConnectorAccessControl;
import io.trino.spi.connector.ConnectorSession;
import io.trino.spi.type.Type;
import jakarta.annotation.Nullable;

import java.lang.invoke.MethodHandle;
import java.util.HashSet;
import java.util.List;
import java.util.Set;

import static java.lang.String.format;
import static java.util.Locale.ENGLISH;
import static java.util.Objects.requireNonNull;
import static java.util.stream.Collectors.joining;

public class Procedure
{
    private final String schema;
    private final String name;
    private final List arguments;
    private final boolean requireNamedArguments;
    private final MethodHandle methodHandle;

    public Procedure(String schema, String name, List arguments, MethodHandle methodHandle)
    {
        this(schema, name, arguments, methodHandle, false);
    }

    public Procedure(String schema, String name, List arguments, MethodHandle methodHandle, boolean requireNamedArguments)
    {
        this.schema = checkNotNullOrEmpty(schema, "schema").toLowerCase(ENGLISH);
        this.name = checkNotNullOrEmpty(name, "name").toLowerCase(ENGLISH);
        this.arguments = List.copyOf(requireNonNull(arguments, "arguments is null"));
        this.methodHandle = requireNonNull(methodHandle, "methodHandle is null");
        this.requireNamedArguments = requireNamedArguments;

        Set names = new HashSet<>();
        for (Argument argument : arguments) {
            checkArgument(names.add(argument.getName()), format("Duplicate argument name: '%s'", argument.getName()));
        }

        for (int index = 1; index < arguments.size(); index++) {
            if (arguments.get(index - 1).isOptional() && arguments.get(index).isRequired()) {
                throw new IllegalArgumentException("Optional arguments should follow required ones");
            }
        }

        checkArgument(!methodHandle.isVarargsCollector(), "Method must have fixed arity");
        checkArgument(methodHandle.type().returnType() == void.class, "Method must return void");

        long parameterCount = methodHandle.type().parameterList().stream()
                .filter(type -> !ConnectorSession.class.equals(type))
                .filter(type -> !ConnectorAccessControl.class.equals(type))
                .count();

        checkArgument(parameterCount == arguments.size(), "Method parameter count must match arguments");
    }

    public String getSchema()
    {
        return schema;
    }

    public String getName()
    {
        return name;
    }

    public List getArguments()
    {
        return arguments;
    }

    public MethodHandle getMethodHandle()
    {
        return methodHandle;
    }

    public boolean requiresNamedArguments()
    {
        return requireNamedArguments;
    }

    @Override
    public String toString()
    {
        return schema + '.' + name +
                '(' +
                arguments.stream()
                        .map(Object::toString)
                        .collect(joining(", ")) +
                ')';
    }

    public static class Argument
    {
        private final String name;
        private final Type type;
        private final boolean required;
        private final Object defaultValue;

        public Argument(String name, Type type)
        {
            this(name, type, true, null);
        }

        public Argument(String name, Type type, boolean required, @Nullable Object defaultValue)
        {
            this(name, false, type, required, defaultValue);
        }

        /**
         * @deprecated Available for transition period only. After the transition period non-uppercase names will always be allowed.
         */
        @Deprecated
        public Argument(String name, boolean allowNonUppercaseName, Type type, boolean required, @Nullable Object defaultValue)
        {
            this.name = checkNotNullOrEmpty(name, "name");
            if (!allowNonUppercaseName && !name.equals(name.toUpperCase(ENGLISH))) {
                throw new IllegalArgumentException("Argument name not uppercase. Previously argument names were matched incorrectly. " +
                        "This is now fixed and for backwards compatibility of CALL statements, the argument must be declared in uppercase. " +
                        "You can pass allowNonUppercaseName boolean flag if you want to register non-uppercase argument name.");
            }
            this.type = requireNonNull(type, "type is null");
            this.required = required;
            this.defaultValue = defaultValue;
        }

        public String getName()
        {
            return name;
        }

        public Type getType()
        {
            return type;
        }

        public boolean isRequired()
        {
            return required;
        }

        public boolean isOptional()
        {
            return !required;
        }

        /**
         * Argument default value in type's stack representation.
         */
        public Object getDefaultValue()
        {
            return defaultValue;
        }

        @Override
        public String toString()
        {
            return name + " " + type;
        }
    }

    private static String checkNotNullOrEmpty(String value, String name)
    {
        requireNonNull(value, name + " is null");
        checkArgument(!value.isEmpty(), name + " is empty");
        return value;
    }

    private static void checkArgument(boolean assertion, String message)
    {
        if (!assertion) {
            throw new IllegalArgumentException(message);
        }
    }
}