Temporary tables

docs/ReleaseNotes.md

@@ -28,7 +28,7 @@ Starting with version [3.4.455.0](#344550), the semantics of `UnnestedRecordType
 * **Performance** Improvement 4 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Performance** Improvement 5 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Feature** Add more lucene exception handling tests [(Issue #2939)](https://github.com/FoundationDB/fdb-record-layer/issues/2939)
-* **Feature** Feature 2 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
+* **Feature** Table queues [(Issue #2962)](https://github.com/FoundationDB/fdb-record-layer/pull/2962)
 * **Feature** Feature 3 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Feature** Feature 4 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)
 * **Feature** Feature 5 [(Issue #NNN)](https://github.com/FoundationDB/fdb-record-layer/issues/NNN)

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

@@ -44,17 +44,18 @@ public class Bindings {
     /**
      * Bindings slots used internally by plan operators.
      */
-    public enum Internal {
+    public enum BindingType {
         IN("__in_"),
         RANK("__rank_"),
         CORRELATION("__corr_"),
-        CONSTANT("__const_");
+        CONSTANT("__const_"),
+        TABLE_QUEUE("__tq_");
 
         public static final String PREFIX = "__";
         private final String value;
 
 
-        Internal(String value) {
+        BindingType(String value) {
             this.value = value;
         }
 
@@ -87,14 +88,16 @@ public PBindingKind toProto(@Nonnull final PlanSerializationContext serializatio
                     return PBindingKind.CONSTANT;
                 case CORRELATION:
                     return PBindingKind.CORRELATION;
+                case TABLE_QUEUE:
+                    return PBindingKind.TABLE_QUEUE; // TEMP_TABLE
                 default:
                     throw new RecordCoreException("unknown binding mapping. did you forget to map it?");
             }
         }
 
         @Nonnull
         @SuppressWarnings("unused")
-        public static Internal fromProto(@Nonnull final PlanSerializationContext serializationContext, @Nonnull final PBindingKind bindingKindProto) {
+        public static BindingType fromProto(@Nonnull final PlanSerializationContext serializationContext, @Nonnull final PBindingKind bindingKindProto) {
             switch (bindingKindProto) {
                 case IN:
                     return IN;
@@ -104,6 +107,8 @@ public static Internal fromProto(@Nonnull final PlanSerializationContext seriali
                     return CONSTANT;
                 case CORRELATION:
                     return CORRELATION;
+                case TABLE_QUEUE:
+                    return TABLE_QUEUE;
                 default:
                     throw new RecordCoreException("unknown binding mapping. did you forget to map it?");
             }

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

@@ -127,11 +127,13 @@ public Object getBinding(@Nonnull String name) {
     /**
      * Get the value bound to a single parameter.
      *
+     * @param type the type of the parameter
      * @param alias the correlation identifier
+     *
      * @return the value bound to the given parameter
      */
-    public Object getBinding(@Nonnull CorrelationIdentifier alias) {
-        return bindings.get(Bindings.Internal.CORRELATION.bindingName(alias.getId()));
+    public Object getBinding(@Nonnull Bindings.BindingType type, @Nonnull CorrelationIdentifier alias) {
+        return bindings.get(type.bindingName(alias.getId()));
     }
 
     /**
@@ -144,7 +146,7 @@ public Object getBinding(@Nonnull CorrelationIdentifier alias) {
     @SuppressWarnings("unchecked")
     @Nullable
     public Object dereferenceConstant(@Nonnull final CorrelationIdentifier alias, @Nonnull final String constantId) {
-        final var constantsMap = (Map<String, ?>)bindings.get(Bindings.Internal.CONSTANT.bindingName(alias.getId()));
+        final var constantsMap = (Map<String, ?>)bindings.get(Bindings.BindingType.CONSTANT.bindingName(alias.getId()));
         if (constantsMap == null) {
             throw new RecordCoreException("could not find constant in the evaluation context")
                     .addLogInfo(LogMessageKeys.KEY, "'" + alias.getId() + "' - '" + constantId + "'");
@@ -201,11 +203,13 @@ public EvaluationContext withBinding(@Nonnull String bindingName, @Nullable Obje
      * context included all bindings except that it will bind an additional
      * parameter to an additional value.
      *
+     * @param type the type of the binding.
      * @param alias the alias determining the binding name to add
      * @param value the value to bind the name to
+     *
      * @return a new <code>EvaluationContext</code> with the new binding
      */
-    public EvaluationContext withBinding(@Nonnull CorrelationIdentifier alias, @Nullable Object value) {
-        return childBuilder().setBinding(Bindings.Internal.CORRELATION.bindingName(alias.getId()), value).build(typeRepository);
+    public EvaluationContext withBinding(final Bindings.BindingType type, @Nonnull CorrelationIdentifier alias, @Nullable Object value) {
+        return childBuilder().setBinding(type.bindingName(alias.getId()), value).build(typeRepository);
     }
 }

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

@@ -96,11 +96,11 @@ public EvaluationContextBuilder setBinding(@Nonnull String name, @Nullable Objec
      * @return this <code>EvaluationContextBuilder</code>
      */
     public EvaluationContextBuilder setBinding(@Nonnull CorrelationIdentifier alias, @Nullable Object value) {
-        return setBinding(Bindings.Internal.CORRELATION.bindingName(alias.getId()), value);
+        return setBinding(Bindings.BindingType.CORRELATION.bindingName(alias.getId()), value);
     }
 
     public EvaluationContextBuilder setConstant(@Nonnull CorrelationIdentifier alias, @Nullable Object value) {
-        return setBinding(Bindings.Internal.CONSTANT.bindingName(alias.getId()), value);
+        return setBinding(Bindings.BindingType.CONSTANT.bindingName(alias.getId()), value);
     }
 
     /**

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/cursors/aggregate/StreamGrouping.java

@@ -20,6 +20,7 @@
 
 package com.apple.foundationdb.record.cursors.aggregate;
 
+import com.apple.foundationdb.record.Bindings;
 import com.apple.foundationdb.record.EvaluationContext;
 import com.apple.foundationdb.record.RecordCursorResult;
 import com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase;
@@ -183,13 +184,13 @@ private void finalizeGroup(Object nextGroup) {
     }
 
     private void accumulate(@Nullable Object currentObject) {
-        EvaluationContext nestedContext = context.withBinding(alias, currentObject);
+        EvaluationContext nestedContext = context.withBinding(Bindings.BindingType.CORRELATION, alias, currentObject);
         final Object partial = aggregateValue.evalToPartial(store, nestedContext);
         accumulator.accumulate(partial);
     }
 
     private Object evalGroupingKey(@Nullable final Object currentObject) {
-        final EvaluationContext nestedContext = context.withBinding(alias, currentObject);
+        final EvaluationContext nestedContext = context.withBinding(Bindings.BindingType.CORRELATION, alias, currentObject);
         return Objects.requireNonNull(groupingKeyValue).eval(store, nestedContext);
     }
 

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

@@ -74,7 +74,7 @@ public <M extends Message> boolean shouldIndexThisRecord(@Nonnull FDBRecordStore
         CorrelationIdentifier objectQuantifier = Quantifier.current();
         QueryPredicate queryPredicate = getQueryPredicate(store.getRecordMetaData(), savedRecord.getRecordType(), objectQuantifier);
 
-        String bindingName = Bindings.Internal.CORRELATION.bindingName(objectQuantifier.getId());
+        String bindingName = Bindings.BindingType.CORRELATION.bindingName(objectQuantifier.getId());
         Bindings bindings = Bindings.newBuilder().set(bindingName, QueryResult.ofComputed(savedRecord.getRecord())).build();
 
         return Boolean.TRUE.equals(queryPredicate.eval(store, EvaluationContext.forBindings(bindings)));

fdb-record-layer-core/src/main/java/com/apple/foundationdb/record/query/expressions/Comparisons.java

@@ -1150,19 +1150,19 @@ public abstract static class ParameterComparisonBase implements ComparisonWithPa
         @Nonnull
         protected final String parameter;
         @Nullable
-        protected final Bindings.Internal internal;
+        protected final Bindings.BindingType bindingType;
         @Nonnull
         protected final ParameterRelationshipGraph parameterRelationshipGraph;
         @Nonnull
         protected final Supplier<Integer> hashCodeSupplier;
 
         protected ParameterComparisonBase(@Nonnull Type type, @Nonnull String parameter,
-                                          @Nullable Bindings.Internal internal,
+                                          @Nullable Bindings.BindingType bindingType,
                                           @Nonnull ParameterRelationshipGraph parameterRelationshipGraph) {
-            checkInternalBinding(parameter, internal);
+            checkInternalBinding(parameter, bindingType);
             this.type = type;
             this.parameter = parameter;
-            this.internal = internal;
+            this.bindingType = bindingType;
             if (type.isUnary()) {
                 throw new RecordCoreException("Unary comparison type " + type + " cannot be bound to a parameter");
             }
@@ -1183,15 +1183,15 @@ public Type getType() {
         }
 
         public boolean isCorrelation() {
-            return internal == Bindings.Internal.CORRELATION;
+            return bindingType == Bindings.BindingType.CORRELATION;
         }
 
         @Override
         public boolean isCorrelatedTo(@Nonnull final CorrelationIdentifier alias) {
             if (!isCorrelation()) {
                 return false;
             }
-            return Bindings.Internal.CORRELATION.identifier(getParameter()).equals(alias.getId());
+            return Bindings.BindingType.CORRELATION.identifier(getParameter()).equals(alias.getId());
         }
 
         @Nullable
@@ -1212,7 +1212,7 @@ public Object getComparand(@Nullable FDBRecordStoreBase<?> store, @Nullable Eval
         @SuppressWarnings("PMD.CompareObjectsWithEquals")
         public Comparison translateCorrelations(@Nonnull final TranslationMap translationMap) {
             if (isCorrelation()) {
-                final var alias = CorrelationIdentifier.of(Bindings.Internal.CORRELATION.identifier(parameter));
+                final var alias = CorrelationIdentifier.of(Bindings.BindingType.CORRELATION.identifier(parameter));
                 final var quantifiedObjectValue = QuantifiedObjectValue.of(alias,
                         com.apple.foundationdb.record.query.plan.cascades.typing.Type.any());
 
@@ -1309,7 +1309,7 @@ public CorrelationIdentifier getAlias() {
             if (!isCorrelation()) {
                 throw new IllegalStateException("caller should check for type of binding before calling this method");
             }
-            return CorrelationIdentifier.of(Bindings.Internal.CORRELATION.identifier(parameter));
+            return CorrelationIdentifier.of(Bindings.BindingType.CORRELATION.identifier(parameter));
         }
 
         @Override
@@ -1359,10 +1359,10 @@ public int queryHash(@Nonnull final QueryHashKind hashKind) {
         }
 
         @Nonnull
-        private static String checkInternalBinding(@Nonnull String parameter, @Nullable Bindings.Internal internal) {
-            if (internal == null && Bindings.Internal.isInternal(parameter)) {
+        private static String checkInternalBinding(@Nonnull String parameter, @Nullable Bindings.BindingType bindingType) {
+            if (bindingType == null && Bindings.BindingType.isInternal(parameter)) {
                 throw new RecordCoreException(
-                        "Parameter is internal, parameters cannot start with \"" + Bindings.Internal.PREFIX + "\"");
+                        "Parameter is internal, parameters cannot start with \"" + Bindings.BindingType.PREFIX + "\"");
             }
             return parameter;
         }
@@ -1373,17 +1373,17 @@ private static String checkInternalBinding(@Nonnull String parameter, @Nullable
      */
     public static class ParameterComparison extends ParameterComparisonBase {
         protected ParameterComparison(@Nonnull Type type, @Nonnull String parameter,
-                                      @Nullable Bindings.Internal internal,
+                                      @Nullable Bindings.BindingType bindingType,
                                       @Nonnull ParameterRelationshipGraph parameterRelationshipGraph) {
-            super(type, parameter, internal, parameterRelationshipGraph);
+            super(type, parameter, bindingType, parameterRelationshipGraph);
         }
 
         public ParameterComparison(@Nonnull Type type, @Nonnull String parameter) {
             this(type, parameter, null, ParameterRelationshipGraph.unbound());
         }
 
-        public ParameterComparison(@Nonnull Type type, @Nonnull String parameter, @Nullable Bindings.Internal internal) {
-            this(type, parameter, internal, ParameterRelationshipGraph.unbound());
+        public ParameterComparison(@Nonnull Type type, @Nonnull String parameter, @Nullable Bindings.BindingType bindingType) {
+            this(type, parameter, bindingType, ParameterRelationshipGraph.unbound());
         }
 
         @Nonnull
@@ -1392,23 +1392,23 @@ public Comparison withType(@Nonnull final Type newType) {
             if (type == newType) {
                 return this;
             }
-            return new ParameterComparison(newType, parameter, internal, parameterRelationshipGraph);
+            return new ParameterComparison(newType, parameter, bindingType, parameterRelationshipGraph);
         }
 
         @Nonnull
         @Override
         protected ParameterComparisonBase withTranslatedCorrelation(@Nonnull CorrelationIdentifier translatedAlias) {
             return new ParameterComparison(type,
-                                           Bindings.Internal.CORRELATION.bindingName(translatedAlias.getId()),
-                                           Bindings.Internal.CORRELATION,
+                                           Bindings.BindingType.CORRELATION.bindingName(translatedAlias.getId()),
+                                           Bindings.BindingType.CORRELATION,
                                            parameterRelationshipGraph);
         }
 
         @Nonnull
         @Override
         public Comparison withParameterRelationshipMap(@Nonnull final ParameterRelationshipGraph parameterRelationshipGraph) {
             Verify.verify(this.parameterRelationshipGraph.isUnbound());
-            return new ParameterComparison(type, parameter, internal, parameterRelationshipGraph);
+            return new ParameterComparison(type, parameter, bindingType, parameterRelationshipGraph);
         }
 
         @Nonnull
@@ -1418,8 +1418,8 @@ public PParameterComparison toProto(@Nonnull final PlanSerializationContext seri
                     .setType(type.toProto(serializationContext))
                     .setParameter(parameter);
 
-            if (internal != null) {
-                builder.setInternal(internal.toProto(serializationContext));
+            if (bindingType != null) {
+                builder.setInternal(bindingType.toProto(serializationContext));
             }
             return builder.build();
         }
@@ -1433,15 +1433,15 @@ public PComparison toComparisonProto(@Nonnull final PlanSerializationContext ser
         @Nonnull
         public static ParameterComparison fromProto(@Nonnull final PlanSerializationContext serializationContext,
                                                     @Nonnull final PParameterComparison parameterComparisonProto) {
-            final Bindings.Internal internal;
+            final Bindings.BindingType bindingType;
             if (parameterComparisonProto.hasInternal()) {
-                internal = Bindings.Internal.fromProto(serializationContext, Objects.requireNonNull(parameterComparisonProto.getInternal()));
+                bindingType = Bindings.BindingType.fromProto(serializationContext, Objects.requireNonNull(parameterComparisonProto.getInternal()));
             } else {
-                internal = null;
+                bindingType = null;
             }
             return new ParameterComparison(Type.fromProto(serializationContext, Objects.requireNonNull(parameterComparisonProto.getType())),
                     Objects.requireNonNull(parameterComparisonProto.getParameter()),
-                    internal);
+                    bindingType);
         }
 
         /**