Support UDF in plan generator #3040
+1,158
−487
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,67 @@ | ||||||
| /* | ||||||
| * UDF.java | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * | ||||||
| * This source file is part of the FoundationDB open source project | ||||||
| * | ||||||
| * Copyright 2015-2025 Apple Inc. and the FoundationDB project authors | ||||||
| * | ||||||
| * 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.apple.foundationdb.record.metadata; | ||||||
|
|
||||||
| import com.apple.foundationdb.record.PlanHashable; | ||||||
| import com.apple.foundationdb.record.PlanSerializationContext; | ||||||
| import com.apple.foundationdb.record.RecordMetaDataProto; | ||||||
| import com.apple.foundationdb.record.query.plan.cascades.MacroFunction; | ||||||
| import com.apple.foundationdb.record.query.plan.serialization.DefaultPlanSerializationRegistry; | ||||||
|
|
||||||
| import javax.annotation.Nonnull; | ||||||
|
|
||||||
| /** | ||||||
| * Defines a scalar User-defined-function. | ||||||
|
There was a problem hiding this comment. Please expand on the documentation. |
||||||
| */ | ||||||
| public class ScalarValuedFunction { | ||||||
|
There was a problem hiding this comment. Why don't we just make a trait-like interface called
|
||||||
| @Nonnull | ||||||
| private final MacroFunction macroFunction; | ||||||
|
|
||||||
| public ScalarValuedFunction(@Nonnull MacroFunction functionValue) { | ||||||
| this.macroFunction = functionValue; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public MacroFunction getMacroFunction() { | ||||||
| return macroFunction; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public String getFunctionName() { | ||||||
| return macroFunction.getFunctionName(); | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public RecordMetaDataProto.ScalarValuedFunction toProto() { | ||||||
| PlanSerializationContext serializationContext = new PlanSerializationContext(DefaultPlanSerializationRegistry.INSTANCE, | ||||||
| PlanHashable.CURRENT_FOR_CONTINUATION); | ||||||
| return RecordMetaDataProto.ScalarValuedFunction.newBuilder() | ||||||
| .setFunctionValue(macroFunction.toProto(serializationContext)) | ||||||
| .build(); | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public static ScalarValuedFunction fromProto(RecordMetaDataProto.ScalarValuedFunction proto) { | ||||||
| PlanSerializationContext serializationContext = new PlanSerializationContext(DefaultPlanSerializationRegistry.INSTANCE, | ||||||
| PlanHashable.CURRENT_FOR_CONTINUATION); | ||||||
| return new ScalarValuedFunction(MacroFunction.fromProto(serializationContext, proto.getFunctionValue())); | ||||||
| } | ||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are a few different comments further down in this PR around this. Let me just point out here that this structure is persisted and long-lived. In fact, modifying its contents and layout may be impossible or very hard once this is used. One thing I would like to avoid is to get ourselves into a dead end here.
We most likely want to support other functions-like objects than macros. For instance, we would like to use full SQL-bodied functions or table functions. This attribute here should potentially be able to contain all of these. Using my naming from a files down, this should be something named
SerializableFunction(because that's all you need here, i.e. a name, a bunch of parameter declarations with their types and a return type). Under the hood it can be any of the particular flavors I mentioned (of which we only have a simpleMacroFunctionas of yet).