comments

Author: pengpeng-lu

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/RecordMetaData.java

@@ -50,7 +50,6 @@
 import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Set;
 import java.util.TreeMap;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.stream.Collectors;
@@ -86,7 +85,7 @@ public class RecordMetaData implements RecordMetaDataProvider {
     @Nonnull
     private final Map<Object, SyntheticRecordType<?>> recordTypeKeyToSyntheticTypeMap;
     @Nonnull
-    private final Set<UserDefinedFunction> userDefinedFunctions;
+    private final Map<String, UserDefinedFunction> userDefinedFunctionMap;
     @Nonnull
     private final Map<String, Index> indexes;
     @Nonnull
@@ -117,7 +116,7 @@ protected RecordMetaData(@Nonnull RecordMetaData orig) {
                 Collections.unmodifiableMap(orig.indexes),
                 Collections.unmodifiableMap(orig.universalIndexes),
                 Collections.unmodifiableList(orig.formerIndexes),
-                Collections.unmodifiableSet(orig.userDefinedFunctions),
+                Collections.unmodifiableMap(orig.userDefinedFunctionMap),
                 orig.splitLongRecords,
                 orig.storeRecordVersions,
                 orig.version,
@@ -137,7 +136,7 @@ protected RecordMetaData(@Nonnull Descriptors.FileDescriptor recordsDescriptor,
                              @Nonnull Map<String, Index> indexes,
                              @Nonnull Map<String, Index> universalIndexes,
                              @Nonnull List<FormerIndex> formerIndexes,
-                             @Nonnull Set<UserDefinedFunction> userDefinedFunctions,
+                             @Nonnull Map<String, UserDefinedFunction> userDefinedFunctionMap,
                              boolean splitLongRecords,
                              boolean storeRecordVersions,
                              int version,
@@ -154,7 +153,7 @@ protected RecordMetaData(@Nonnull Descriptors.FileDescriptor recordsDescriptor,
         this.indexes = indexes;
         this.universalIndexes = universalIndexes;
         this.formerIndexes = formerIndexes;
-        this.userDefinedFunctions = userDefinedFunctions;
+        this.userDefinedFunctionMap = userDefinedFunctionMap;
         this.splitLongRecords = splitLongRecords;
         this.storeRecordVersions = storeRecordVersions;
         this.version = version;
@@ -702,7 +701,7 @@ public RecordMetaDataProto.MetaData toProto(@Nullable Descriptors.FileDescriptor
 
         PlanSerializationContext serializationContext = new PlanSerializationContext(DefaultPlanSerializationRegistry.INSTANCE,
                 PlanHashable.CURRENT_FOR_CONTINUATION);
-        builder.addAllUserDefinedFunctions(userDefinedFunctions.stream().map(func -> func.toProto(serializationContext)).collect(Collectors.toList()));
+        builder.addAllUserDefinedFunctions(userDefinedFunctionMap.values().stream().map(func -> func.toProto(serializationContext)).collect(Collectors.toList()));
         builder.setSplitLongRecords(splitLongRecords);
         builder.setStoreRecordVersions(storeRecordVersions);
         builder.setVersion(version);

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/RecordMetaDataBuilder.java

@@ -112,7 +112,7 @@ public class RecordMetaDataBuilder implements RecordMetaDataProvider {
     @Nonnull
     private final Map<String, SyntheticRecordTypeBuilder<?>> syntheticRecordTypes;
     @Nonnull
-    private final Set<UserDefinedFunction> userDefinedFunctions;
+    private final Map<String, UserDefinedFunction> userDefinedFunctionMap;
     @Nonnull
     private final Map<String, Index> indexes;
     @Nonnull
@@ -148,7 +148,7 @@ public class RecordMetaDataBuilder implements RecordMetaDataProvider {
         indexMaintainerRegistry = IndexMaintainerRegistryImpl.instance();
         evolutionValidator = MetaDataEvolutionValidator.getDefaultInstance();
         syntheticRecordTypes = new HashMap<>();
-        userDefinedFunctions = new HashSet<>();
+        userDefinedFunctionMap = new HashMap<>();
     }
 
     private void processSchemaOptions(boolean processExtensionOptions) {
@@ -232,7 +232,7 @@ private void loadProtoExceptRecords(@Nonnull RecordMetaDataProto.MetaData metaDa
         for (RecordMetaDataProto.UserDefinedFunction function: metaDataProto.getUserDefinedFunctionsList()) {
             UserDefinedFunction func = UserDefinedFunction.fromProto(serializationContext, function);
             if (func != null) {
-                userDefinedFunctions.add(func);
+                userDefinedFunctionMap.put(func.getFunctionName(), func);
             }
         }
         if (metaDataProto.hasSplitLongRecords()) {
@@ -1193,11 +1193,11 @@ public void addFormerIndex(@Nonnull FormerIndex formerIndex) {
     }
 
     public void addUserDefinedFunction(@Nonnull UserDefinedFunction userDefinedFunction) {
-        userDefinedFunctions.add(userDefinedFunction);
+        userDefinedFunctionMap.put(userDefinedFunction.getFunctionName(), userDefinedFunction);
     }
 
     public void addUserDefinedFunctions(@Nonnull Iterable<? extends UserDefinedFunction> functions) {
-        functions.forEach(this.userDefinedFunctions::add);
+        functions.forEach(this::addUserDefinedFunction);
     }
 
     public boolean isSplitLongRecords() {
@@ -1441,7 +1441,7 @@ public RecordMetaData build(boolean validate) {
         Map<Object, SyntheticRecordType<?>> recordTypeKeyToSyntheticRecordTypeMap = Maps.newHashMapWithExpectedSize(syntheticRecordTypes.size());
         RecordMetaData metaData = new RecordMetaData(recordsDescriptor, getUnionDescriptor(), unionFields,
                 builtRecordTypes, builtSyntheticRecordTypes, recordTypeKeyToSyntheticRecordTypeMap,
-                indexes, universalIndexes, formerIndexes, userDefinedFunctions,
+                indexes, universalIndexes, formerIndexes, userDefinedFunctionMap,
                 splitLongRecords, storeRecordVersions, version, subspaceKeyCounter, usesSubspaceKeyCounter, recordCountKey, localFileDescriptor != null);
         for (RecordTypeBuilder recordTypeBuilder : recordTypes.values()) {
             KeyExpression primaryKey = recordTypeBuilder.getPrimaryKey();

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/query/plan/cascades/CatalogedFunction.java

@@ -20,6 +20,7 @@
 
 package com.apple.foundationdb.record.query.plan.cascades;
 
+import com.apple.foundationdb.annotation.API;
 import com.apple.foundationdb.record.query.plan.cascades.typing.Type;
 import com.apple.foundationdb.record.query.plan.cascades.typing.Typed;
 import com.google.common.base.Verify;
@@ -30,20 +31,26 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+/**
+ * Main interface for defining all functions that can be evaluated against a number of arguments.
+ * Two major sub interfaces inherit this interface: {@link BuiltInFunction} and {@link UserDefinedFunction}
+ * {@link BuiltInFunction} represents all functions that are built-in, and stored in code, while {@link UserDefinedFunction} represents all functions defined by users, and stored in {@link com.apple.foundationdb.record.RecordMetaDataProto.MetaData}
+ */
+@API(API.Status.EXPERIMENTAL)
 public abstract class CatalogedFunction {
     @Nonnull
-    final String functionName;
+    protected final String functionName;
 
     @Nonnull
-    final List<Type> parameterTypes;
+    protected final List<Type> parameterTypes;
 
     /**
      * The type of the function's variadic parameters (if any).
      */
     @Nullable
-    final Type variadicSuffixType;
+    private final Type variadicSuffixType;
 
-    public CatalogedFunction(@Nonnull final String functionName, @Nonnull final List<Type> parameterTypes, @Nullable final Type variadicSuffixType) {
+    protected CatalogedFunction(@Nonnull final String functionName, @Nonnull final List<Type> parameterTypes, @Nullable final Type variadicSuffixType) {
         this.functionName = functionName;
         this.parameterTypes = ImmutableList.copyOf(parameterTypes);
         this.variadicSuffixType = variadicSuffixType;

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/query/plan/cascades/MacroFunction.java

@@ -38,10 +38,9 @@
  * MacroFunction that expands a body (referring to parameters) into a {@link Value} (through encapsulation) call site.
  */
 public class MacroFunction extends UserDefinedFunction {
-    private static final long serialVersionUID = 1L;
-
     @Nonnull
     private final Value bodyValue;
+    @Nonnull
     private final List<CorrelationIdentifier> parameterIdentifiers;
 
     public MacroFunction(@Nonnull final String functionName, @Nonnull final List<QuantifiedObjectValue> parameters, @Nonnull final Value bodyValue) {

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/query/plan/cascades/UserDefinedFunction.java

@@ -20,6 +20,7 @@
 
 package com.apple.foundationdb.record.query.plan.cascades;
 
+import com.apple.foundationdb.annotation.API;
 import com.apple.foundationdb.record.PlanSerializationContext;
 import com.apple.foundationdb.record.RecordMetaDataProto;
 import com.apple.foundationdb.record.query.plan.cascades.typing.Type;
@@ -29,8 +30,10 @@
 import java.util.List;
 
 /**
- * User defined functions that are serialized in MetaData.
+ * Functions that are 1) can be evaluated against a number of arguments; 2) defined by users; 3) serialized to {@link com.apple.foundationdb.record.RecordMetaDataProto.MetaData}
+ * Right now we don't have namespacing rules to separate UserDefinedFunction and BuiltInFunction, so theoretically there could be a naming collision
  */
+@API(API.Status.EXPERIMENTAL)
 public abstract class UserDefinedFunction extends CatalogedFunction {
 
     public UserDefinedFunction(@Nonnull final String functionName, @Nonnull final List<Type> parameterTypes) {
@@ -42,7 +45,7 @@ public static UserDefinedFunction fromProto(@Nonnull PlanSerializationContext se
         if (proto.hasMacroFunction()) {
             return MacroFunction.fromProto(serializationContext, proto);
         } else {
-            return null;
+            throw new RuntimeException("Invalid UserDefinedFunction protobuf.");
         }
     }