com.facebook.presto.jdbc.internal.spi.function.FunctionNamespaceManager Maven / Gradle / Ivy
/*
* 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 com.facebook.presto.jdbc.internal.spi.function;
import com.facebook.presto.jdbc.internal.common.Page;
import com.facebook.presto.jdbc.internal.common.QualifiedObjectName;
import com.facebook.presto.jdbc.internal.common.block.BlockEncodingSerde;
import com.facebook.presto.jdbc.internal.common.function.SqlFunctionResult;
import com.facebook.presto.jdbc.internal.common.type.TypeManager;
import com.facebook.presto.jdbc.internal.common.type.TypeSignature;
import com.facebook.presto.jdbc.internal.common.type.UserDefinedType;
import com.facebook.presto.jdbc.internal.spi.api.Experimental;
import java.util.Collection;
import java.util.List;
import java.util.Optional;
import java.util.concurrent.CompletableFuture;
@Experimental
public interface FunctionNamespaceManager
{
/**
* BlockEncodingSerde might be needed to serialize/deserialize Presto pages when running external functions.
*/
void setBlockEncodingSerde(BlockEncodingSerde blockEncodingSerde);
/**
* Start a transaction.
*/
FunctionNamespaceTransactionHandle beginTransaction();
/**
* Commit the transaction. Will be called at most once and will not be called if
* {@link #abort(FunctionNamespaceTransactionHandle)} is called.
*/
void commit(FunctionNamespaceTransactionHandle transactionHandle);
/**
* Rollback the transaction. Will be called at most once and will not be called if
* {@link #commit(FunctionNamespaceTransactionHandle)} is called.
*/
void abort(FunctionNamespaceTransactionHandle transactionHandle);
/**
* Create or replace the specified function.
* TODO: Support transaction
*/
void createFunction(SqlInvokedFunction function, boolean replace);
/**
* Alter the specified function.
* TODO: Support transaction
*/
void alterFunction(QualifiedObjectName functionName, Optional> parameterTypes, AlterRoutineCharacteristics alterRoutineCharacteristics);
/**
* Drop the specified function.
* TODO: Support transaction
*/
void dropFunction(QualifiedObjectName functionName, Optional> parameterTypes, boolean exists);
/**
* List all functions managed by the {@link FunctionNamespaceManager}.
* likePattern and escape are from `SHOW FUNCTIONS LIKE [likePattern] escape [escape]`.
* Backends supporting like pattern / escape matching can use this to prefilter functions, but Presto will filter again, so it is fine if the backend doesn't
* use these parameters.
* TODO: Support transaction
*/
Collection listFunctions(Optional likePattern, Optional escape);
/**
* Whether this function namespace manager would do function resolution or not.
*
* If returns false, engine function resolution logic will call {@link #getFunctions(Optional, QualifiedObjectName)}
* to get all candidates, and use engine logic to resolve to a specific function signature, then call {@link #getFunctionHandle(Optional, Signature)}
* to get the function handle.
*
* If returns true, the function resolution logic will be delegated to the function namespace manager, and the engine
* will call {@link #resolveFunction(Optional, QualifiedObjectName, List)} directly to get the function handle.
*
*/
default boolean canResolveFunction()
{
return false;
}
/**
* When {@link #canResolveFunction()} returns true, this function is called to resolve the function to a function handle.
* This is useful for plugins like Hive functions because the function resolution logic is defined with the function itself.
*/
default FunctionHandle resolveFunction(Optional extends FunctionNamespaceTransactionHandle> transactionHandle, QualifiedObjectName functionName, List parameterTypes)
{
throw new UnsupportedOperationException("Does not support resolving function");
}
Collection getFunctions(Optional extends FunctionNamespaceTransactionHandle> transactionHandle, QualifiedObjectName functionName);
FunctionHandle getFunctionHandle(Optional extends FunctionNamespaceTransactionHandle> transactionHandle, Signature signature);
FunctionMetadata getFunctionMetadata(FunctionHandle functionHandle);
ScalarFunctionImplementation getScalarFunctionImplementation(FunctionHandle functionHandle);
CompletableFuture executeFunction(String source, FunctionHandle functionHandle, Page input, List channels, TypeManager typeManager);
void addUserDefinedType(UserDefinedType userDefinedType);
Optional getUserDefinedType(QualifiedObjectName typeName);
default AggregationFunctionImplementation getAggregateFunctionImplementation(FunctionHandle functionHandle)
{
throw new UnsupportedOperationException("Does not support get aggregation function");
}
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy