Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $
You can buy this project and download/modify it how often you want.
io.trino.metadata.FunctionResolver 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 io.trino.metadata;
import com.google.common.collect.ImmutableList;
import com.google.common.collect.ImmutableMap;
import com.google.common.collect.ImmutableSet;
import com.google.common.collect.Sets;
import io.trino.Session;
import io.trino.execution.warnings.WarningCollector;
import io.trino.metadata.FunctionBinder.CatalogFunctionBinding;
import io.trino.security.AccessControl;
import io.trino.security.SecurityContext;
import io.trino.spi.TrinoException;
import io.trino.spi.TrinoWarning;
import io.trino.spi.connector.CatalogHandle;
import io.trino.spi.connector.CatalogSchemaName;
import io.trino.spi.function.CatalogSchemaFunctionName;
import io.trino.spi.function.FunctionDependencyDeclaration;
import io.trino.spi.function.FunctionDependencyDeclaration.CastDependency;
import io.trino.spi.function.FunctionDependencyDeclaration.FunctionDependency;
import io.trino.spi.function.FunctionDependencyDeclaration.OperatorDependency;
import io.trino.spi.function.FunctionId;
import io.trino.spi.function.FunctionKind;
import io.trino.spi.function.FunctionMetadata;
import io.trino.spi.type.Type;
import io.trino.spi.type.TypeManager;
import io.trino.spi.type.TypeSignature;
import io.trino.sql.analyzer.TypeSignatureProvider;
import io.trino.sql.tree.QualifiedName;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Optional;
import java.util.Set;
import java.util.function.Function;
import static com.google.common.collect.ImmutableList.toImmutableList;
import static com.google.common.collect.ImmutableMap.toImmutableMap;
import static io.trino.metadata.FunctionBinder.functionNotFound;
import static io.trino.metadata.GlobalFunctionCatalog.isBuiltinFunctionName;
import static io.trino.metadata.LanguageFunctionManager.isInlineFunction;
import static io.trino.metadata.LanguageFunctionManager.isTrinoSqlLanguageFunction;
import static io.trino.metadata.SignatureBinder.applyBoundVariables;
import static io.trino.spi.StandardErrorCode.FUNCTION_NOT_FOUND;
import static io.trino.spi.StandardErrorCode.MISSING_CATALOG_NAME;
import static io.trino.spi.connector.StandardWarningCode.DEPRECATED_FUNCTION;
import static io.trino.spi.function.FunctionKind.AGGREGATE;
import static io.trino.spi.function.FunctionKind.WINDOW;
import static io.trino.spi.security.AccessDeniedException.denyExecuteFunction;
import static io.trino.sql.analyzer.TypeSignatureProvider.fromTypeSignatures;
import static java.util.Objects.requireNonNull;
public class FunctionResolver
{
private final Metadata metadata;
private final TypeManager typeManager;
private final LanguageFunctionManager languageFunctionManager;
private final WarningCollector warningCollector;
private final FunctionBinder functionBinder;
public FunctionResolver(
Metadata metadata,
TypeManager typeManager,
LanguageFunctionManager languageFunctionManager,
WarningCollector warningCollector)
{
this.metadata = requireNonNull(metadata, "metadata is null");
this.typeManager = requireNonNull(typeManager, "typeManager is null");
this.languageFunctionManager = requireNonNull(languageFunctionManager, "languageFunctionManager is null");
this.warningCollector = requireNonNull(warningCollector, "warningCollector is null");
this.functionBinder = new FunctionBinder(metadata, typeManager);
}
/**
* Is the named function an aggregation function?
* This does not need type parameters because overloads between aggregation and other function types are not allowed.
*/
public boolean isAggregationFunction(Session session, QualifiedName name, AccessControl accessControl)
{
return isFunctionKind(session, name, AGGREGATE, accessControl);
}
public boolean isWindowFunction(Session session, QualifiedName name, AccessControl accessControl)
{
return isFunctionKind(session, name, WINDOW, accessControl);
}
private boolean isFunctionKind(Session session, QualifiedName name, FunctionKind functionKind, AccessControl accessControl)
{
for (CatalogSchemaFunctionName catalogSchemaFunctionName : toPath(session, name, accessControl)) {
Collection candidates = metadata.getFunctions(session, catalogSchemaFunctionName);
if (!candidates.isEmpty()) {
return candidates.stream()
.map(CatalogFunctionMetadata::functionMetadata)
.map(FunctionMetadata::getKind)
.anyMatch(functionKind::equals);
}
}
return false;
}
public ResolvedFunction resolveFunction(Session session, QualifiedName name, List parameterTypes, AccessControl accessControl)
{
CatalogFunctionBinding catalogFunctionBinding = bindFunction(
session,
name,
parameterTypes,
catalogSchemaFunctionName -> metadata.getFunctions(session, catalogSchemaFunctionName),
accessControl);
FunctionMetadata functionMetadata = catalogFunctionBinding.boundFunctionMetadata();
if (functionMetadata.isDeprecated()) {
warningCollector.add(new TrinoWarning(DEPRECATED_FUNCTION, "Use of deprecated function: %s: %s".formatted(name, functionMetadata.getDescription())));
}
return resolve(session, catalogFunctionBinding, accessControl);
}
private ResolvedFunction resolve(Session session, CatalogFunctionBinding functionBinding, AccessControl accessControl)
{
if (isTrinoSqlLanguageFunction(functionBinding.functionBinding().getFunctionId())) {
FunctionId resolvedFunctionId = languageFunctionManager.analyzeAndPlan(
session,
functionBinding.functionBinding().getFunctionId(),
accessControl);
return new ResolvedFunction(
functionBinding.functionBinding().getBoundSignature(),
functionBinding.catalogHandle(),
resolvedFunctionId,
functionBinding.boundFunctionMetadata().getKind(),
functionBinding.boundFunctionMetadata().isDeterministic(),
functionBinding.boundFunctionMetadata().getFunctionNullability(),
ImmutableMap.of(),
ImmutableSet.of());
}
FunctionDependencyDeclaration dependencies = metadata.getFunctionDependencies(
session,
functionBinding.catalogHandle(),
functionBinding.functionBinding().getFunctionId(),
functionBinding.functionBinding().getBoundSignature());
return resolveFunctionBinding(
metadata,
typeManager,
functionBinder,
functionBinding.catalogHandle(),
functionBinding.functionBinding(),
functionBinding.boundFunctionMetadata(),
dependencies,
catalogSchemaFunctionName -> metadata.getFunctions(session, catalogSchemaFunctionName),
catalogFunctionBinding -> resolve(session, catalogFunctionBinding, accessControl));
}
private CatalogFunctionBinding bindFunction(
Session session,
QualifiedName name,
List parameterTypes,
Function> candidateLoader,
AccessControl accessControl)
{
ImmutableList.Builder allCandidates = ImmutableList.builder();
List fullPath = toPath(session, name, accessControl);
List authorizedPath = fullPath.stream()
.filter(catalogSchemaFunctionName -> canExecuteFunction(session, accessControl, catalogSchemaFunctionName))
.collect(toImmutableList());
for (CatalogSchemaFunctionName catalogSchemaFunctionName : authorizedPath) {
Collection candidates = candidateLoader.apply(catalogSchemaFunctionName);
Optional match = functionBinder.tryBindFunction(parameterTypes, candidates);
if (match.isPresent()) {
return match.get();
}
allCandidates.addAll(candidates);
}
Set unauthorizedPath = Sets.difference(ImmutableSet.copyOf(fullPath), ImmutableSet.copyOf(authorizedPath));
if (unauthorizedPath.stream().anyMatch(functionName -> !candidateLoader.apply(functionName).isEmpty())) {
denyExecuteFunction(name.toString());
}
List candidates = allCandidates.build();
throw functionNotFound(name.toString(), parameterTypes, candidates);
}
static ResolvedFunction resolveFunctionBinding(
Metadata metadata,
TypeManager typeManager,
FunctionBinder functionBinder,
CatalogHandle catalogHandle,
FunctionBinding functionBinding,
FunctionMetadata functionMetadata,
FunctionDependencyDeclaration dependencies,
Function> candidateLoader,
Function resolver)
{
Map dependentTypes = dependencies.getTypeDependencies().stream()
.map(typeSignature -> applyBoundVariables(typeSignature, functionBinding))
.collect(toImmutableMap(Function.identity(), typeManager::getType, (left, right) -> left));
ImmutableSet.Builder functions = ImmutableSet.builder();
for (FunctionDependency functionDependency : dependencies.getFunctionDependencies()) {
try {
CatalogSchemaFunctionName name = functionDependency.getName();
CatalogFunctionBinding catalogFunctionBinding = functionBinder.bindFunction(
fromTypeSignatures(applyBoundVariables(functionDependency.getArgumentTypes(), functionBinding)),
candidateLoader.apply(name),
name.toString());
functions.add(resolver.apply(catalogFunctionBinding));
}
catch (TrinoException e) {
if (!functionDependency.isOptional()) {
throw e;
}
}
}
for (OperatorDependency operatorDependency : dependencies.getOperatorDependencies()) {
try {
List argumentTypes = applyBoundVariables(operatorDependency.getArgumentTypes(), functionBinding).stream()
.map(typeManager::getType)
.collect(toImmutableList());
functions.add(metadata.resolveOperator(operatorDependency.getOperatorType(), argumentTypes));
}
catch (TrinoException e) {
if (!operatorDependency.isOptional()) {
throw e;
}
}
}
for (CastDependency castDependency : dependencies.getCastDependencies()) {
try {
Type fromType = typeManager.getType(applyBoundVariables(castDependency.getFromType(), functionBinding));
Type toType = typeManager.getType(applyBoundVariables(castDependency.getToType(), functionBinding));
functions.add(metadata.getCoercion(fromType, toType));
}
catch (TrinoException e) {
if (!castDependency.isOptional()) {
throw e;
}
}
}
return new ResolvedFunction(
functionBinding.getBoundSignature(),
catalogHandle,
functionBinding.getFunctionId(),
functionMetadata.getKind(),
functionMetadata.isDeterministic(),
functionMetadata.getFunctionNullability(),
dependentTypes,
functions.build());
}
// this is visible for the table function resolution, which should be merged into this class
public static List toPath(Session session, QualifiedName name, AccessControl accessControl)
{
List parts = name.getParts();
if (parts.size() > 3) {
throw new TrinoException(FUNCTION_NOT_FOUND, "Invalid function name: " + name);
}
if (parts.size() == 3) {
return ImmutableList.of(new CatalogSchemaFunctionName(parts.get(0), parts.get(1), parts.get(2)));
}
if (parts.size() == 2) {
String currentCatalog = session.getCatalog()
.orElseThrow(() -> new TrinoException(MISSING_CATALOG_NAME, "Session default catalog must be set to resolve a partial function name: " + name));
return ImmutableList.of(new CatalogSchemaFunctionName(currentCatalog, parts.get(0), parts.get(1)));
}
ImmutableList.Builder names = ImmutableList.builder();
// add resolved path items
for (CatalogSchemaName element : session.getPath().getPath()) {
names.add(new CatalogSchemaFunctionName(element.getCatalogName(), element.getSchemaName(), parts.get(0)));
}
return names.build();
}
private static boolean canExecuteFunction(Session session, AccessControl accessControl, CatalogSchemaFunctionName functionName)
{
if (isInlineFunction(functionName) || isBuiltinFunctionName(functionName)) {
return true;
}
return accessControl.canExecuteFunction(
SecurityContext.of(session),
new QualifiedObjectName(functionName.getCatalogName(), functionName.getSchemaName(), functionName.getFunctionName()));
}
}
