Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

formatting explain with stable aliases #3015

Merged
merged 10 commits into from
Jan 9, 2025
Merged

formatting explain with stable aliases #3015

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
85c54ad
numerous refactorings from describe and explain
normen662 Dec 31, 2024
8959844
rewriting the explain visitor
normen662 Dec 31, 2024
4d855cb
able to render plan explains
normen662 Jan 1, 2025
5e7f8fc
explain levels
normen662 Jan 2, 2025
2854ca4
unit tests work
normen662 Jan 6, 2025
5f1e42f
touch ups
normen662 Jan 7, 2025
e49c3ef
added documentation
normen662 Jan 8, 2025
01f1689
addressing Alec's comments
normen662 Jan 8, 2025
a677078
more renamings
normen662 Jan 8, 2025
0917e96
addressing yhatem's comments
normen662 Jan 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions ...c/main/java/com/apple/foundationdb/record/provider/foundationdb/IndexScanComparisons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@
import com.apple.foundationdb.record.query.plan.ScanComparisons;
import com.apple.foundationdb.record.query.plan.cascades.AliasMap;
import com.apple.foundationdb.record.query.plan.cascades.CorrelationIdentifier;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokens;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.explain.Attribute;
import com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap;
import com.google.auto.service.AutoService;
Expand Down Expand Up @@ -113,9 +115,9 @@ public boolean isUnique(@Nonnull Index index) {

@Nonnull
@Override
public String getScanDetails() {
public ExplainTokensWithPrecedence explain() {
@Nullable final TupleRange tupleRange = scanComparisons.toTupleRangeWithoutContext();
return tupleRange == null ? scanComparisons.toString() : tupleRange.toString();
return tupleRange == null ? scanComparisons.explain() : ExplainTokensWithPrecedence.of(new ExplainTokens().addToString(tupleRange));
}

@Override
Expand Down
3 changes: 2 additions & 1 deletion ...rc/main/java/com/apple/foundationdb/record/provider/foundationdb/IndexScanParameters.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,7 @@
import com.apple.foundationdb.record.metadata.Index;
import com.apple.foundationdb.record.planprotos.PIndexScanParameters;
import com.apple.foundationdb.record.query.plan.cascades.Correlated;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.explain.Attribute;
import com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap;
import com.apple.foundationdb.record.query.plan.serialization.PlanSerialization;
Expand Down Expand Up @@ -75,7 +76,7 @@ public interface IndexScanParameters extends PlanHashable, Correlated<IndexScanP
* @return the scan details
*/
@Nonnull
String getScanDetails();
ExplainTokensWithPrecedence explain();

/**
* Get details for graph visualization, including the scan type.
Expand Down
35 changes: 22 additions & 13 deletions ...apple/foundationdb/record/provider/foundationdb/MultidimensionalIndexScanComparisons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,8 @@
import com.apple.foundationdb.record.query.plan.ScanComparisons;
import com.apple.foundationdb.record.query.plan.cascades.AliasMap;
import com.apple.foundationdb.record.query.plan.cascades.CorrelationIdentifier;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokens;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.explain.Attribute;
import com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap;
import com.google.auto.service.AutoService;
Expand All @@ -47,7 +49,6 @@
import java.util.List;
import java.util.Objects;
import java.util.Set;
import java.util.stream.Collectors;

/**
* {@link ScanComparisons} for use in a multidimensional index scan.
Expand Down Expand Up @@ -116,22 +117,30 @@ public boolean isUnique(@Nonnull Index index) {

@Nonnull
@Override
public String getScanDetails() {
@Nullable TupleRange tupleRange = prefixScanComparisons.toTupleRangeWithoutContext();
final String prefix = tupleRange == null ? prefixScanComparisons.toString() : tupleRange.toString();
public ExplainTokensWithPrecedence explain() {
@Nullable var tupleRange = prefixScanComparisons.toTupleRangeWithoutContext();
final var prefix = tupleRange == null
? prefixScanComparisons.explain().getExplainTokens()
: new ExplainTokens().addToString(tupleRange);

final var dimensions =
new ExplainTokens().addSequence(() -> new ExplainTokens().addCommaAndWhiteSpace(),
() -> dimensionsScanComparisons.stream()
.map(dimensionScanComparisons -> {
@Nullable var dimensionTupleRange = dimensionScanComparisons.toTupleRangeWithoutContext();
return dimensionTupleRange == null
? dimensionScanComparisons.explain().getExplainTokens()
: new ExplainTokens().addToString(dimensionTupleRange);
}).iterator());

final String dimensions =
dimensionsScanComparisons.stream()
.map(dimensionScanComparisons -> {
@Nullable final TupleRange dimensionTupleRange = dimensionScanComparisons.toTupleRangeWithoutContext();
return dimensionTupleRange == null ? dimensionScanComparisons.toString() : dimensionTupleRange.toString();
})
.collect(Collectors.joining(","));

tupleRange = suffixScanComparisons.toTupleRangeWithoutContext();
final String suffix = tupleRange == null ? suffixScanComparisons.toString() : tupleRange.toString();
final var suffix = tupleRange == null
? suffixScanComparisons.explain().getExplainTokens()
: new ExplainTokens().addToString(tupleRange);

return prefix + ":{" + dimensions + "}:" + suffix;
return ExplainTokensWithPrecedence.of(prefix.addOptionalWhitespace().addToString(":{").addOptionalWhitespace()
.addNested(dimensions).addOptionalWhitespace().addToString("}:").addOptionalWhitespace().addNested(suffix));
}

@Override
Expand Down
6 changes: 4 additions & 2 deletions ...pple/foundationdb/record/provider/foundationdb/leaderboard/TimeWindowScanComparisons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,7 @@
import com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase;
import com.apple.foundationdb.record.provider.foundationdb.IndexScanComparisons;
import com.apple.foundationdb.record.query.plan.ScanComparisons;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.explain.Attribute;
import com.google.auto.service.AutoService;
import com.google.common.collect.ImmutableList;
Expand Down Expand Up @@ -71,8 +72,9 @@ public int planHash(@Nonnull final PlanHashMode mode) {

@Nonnull
@Override
public String getScanDetails() {
return super.getScanDetails() + "@" + timeWindow;
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(
super.explain().getExplainTokens().addToString("@").addToString(timeWindow));
}

@Override
Expand Down
108 changes: 93 additions & 15 deletions ...layer-core/src/main/java/com/apple/foundationdb/record/query/expressions/Comparisons.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,13 +57,16 @@
import com.apple.foundationdb.record.query.plan.cascades.BooleanWithConstraint;
import com.apple.foundationdb.record.query.plan.cascades.Correlated;
import com.apple.foundationdb.record.query.plan.cascades.CorrelationIdentifier;
import com.apple.foundationdb.record.query.plan.explain.DefaultExplainFormatter;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokens;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.UsesValueEquivalence;
import com.apple.foundationdb.record.query.plan.cascades.ValueEquivalence;
import com.apple.foundationdb.record.query.plan.cascades.WithValue;
import com.apple.foundationdb.record.query.plan.cascades.values.LikeOperatorValue;
import com.apple.foundationdb.record.query.plan.cascades.values.LiteralValue;
import com.apple.foundationdb.record.query.plan.cascades.values.QuantifiedObjectValue;
import com.apple.foundationdb.record.query.plan.cascades.values.MessageHelpers;
import com.apple.foundationdb.record.query.plan.cascades.values.QuantifiedObjectValue;
import com.apple.foundationdb.record.query.plan.cascades.values.Value;
import com.apple.foundationdb.record.query.plan.cascades.values.translation.TranslationMap;
import com.apple.foundationdb.record.query.plan.plans.QueryResult;
Expand Down Expand Up @@ -878,6 +881,9 @@ static Comparison fromComparisonProto(@Nonnull final PlanSerializationContext se
@Nonnull final PComparison comparisonProto) {
return (Comparison)PlanSerialization.dispatchFromProtoContainer(serializationContext, comparisonProto);
}

@Nonnull
ExplainTokensWithPrecedence explain();
}

public static String toPrintable(@Nullable Object value) {
Expand Down Expand Up @@ -995,7 +1001,14 @@ public String typelessString() {

@Override
public String toString() {
return type + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Override
Expand Down Expand Up @@ -1295,7 +1308,14 @@ public String typelessString() {

@Override
public String toString() {
return type + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Nonnull
Expand Down Expand Up @@ -1597,7 +1617,14 @@ public String typelessString() {

@Override
public String toString() {
return type + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addNested(comparandValue.explain().getExplainTokens()));
}

@Override
Expand Down Expand Up @@ -1820,7 +1847,14 @@ public String typelessString() {

@Override
public String toString() {
return type + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Override
Expand Down Expand Up @@ -1981,7 +2015,13 @@ public String typelessString() {

@Override
public String toString() {
return type.toString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name()));
}

@Override
Expand Down Expand Up @@ -2103,7 +2143,14 @@ public String typelessString() {

@Override
public String toString() {
return Type.EQUALS + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(Type.EQUALS.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Override
Expand Down Expand Up @@ -2325,10 +2372,16 @@ public String typelessString() {
}
}

@Nonnull
@Override
public String toString() {
return type.name() + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Override
Expand Down Expand Up @@ -2466,8 +2519,10 @@ public int hashCode() {

@Nonnull
@Override
public String toString() {
return getType().name() + "(" + maxDistance + ") " + typelessString();
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(getType().name())
.addOptionalWhitespace().addOpeningParen().addOptionalWhitespace().addToString(maxDistance)
.addOptionalWhitespace().addClosingParen().addWhitespace().addIdentifier(typelessString()));
}
}

Expand Down Expand Up @@ -2580,8 +2635,18 @@ public int hashCode() {

@Nonnull
@Override
public String toString() {
return getType().name() + "(" + (strict ? "strictly" : "approximately") + ") " + typelessString();
public ExplainTokensWithPrecedence explain() {
final var resultExplainTokens =
new ExplainTokens().addKeyword(getType().name())
.addOptionalWhitespace().addOpeningParen().addOpeningParen();
if (strict) {
resultExplainTokens.addKeyword("STRICTLY");
} else {
resultExplainTokens.addKeyword("APPROXIMATELY");
}
resultExplainTokens.addOptionalWhitespace().addClosingParen().addWhitespace()
.addIdentifier(typelessString());
return ExplainTokensWithPrecedence.of(resultExplainTokens);
}
}

Expand Down Expand Up @@ -2716,7 +2781,13 @@ public boolean equals(final Object o) {

@Override
public String toString() {
return inner.toString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return inner.explain();
}

@Nonnull
Expand Down Expand Up @@ -2901,7 +2972,14 @@ public String typelessString() {

@Override
public String toString() {
return getType() + " " + typelessString();
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword(type.name())
.addWhitespace().addIdentifier(typelessString()));
}

@Nonnull
Expand Down
12 changes: 11 additions & 1 deletion ...rc/main/java/com/apple/foundationdb/record/query/expressions/RecordTypeKeyComparison.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,9 @@
import com.apple.foundationdb.record.provider.foundationdb.FDBRecord;
import com.apple.foundationdb.record.provider.foundationdb.FDBRecordStoreBase;
import com.apple.foundationdb.record.query.plan.ScanComparisons;
import com.apple.foundationdb.record.query.plan.explain.DefaultExplainFormatter;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokens;
import com.apple.foundationdb.record.query.plan.explain.ExplainTokensWithPrecedence;
import com.apple.foundationdb.record.query.plan.cascades.GraphExpansion;
import com.apple.foundationdb.record.query.plan.cascades.Quantifier;
import com.apple.foundationdb.record.query.plan.cascades.values.QuantifiedObjectValue;
Expand Down Expand Up @@ -236,7 +239,14 @@ public int queryHash(@Nonnull final QueryHashKind hashKind) {

@Override
public String toString() {
return "IS " + recordTypeName;
return explain().getExplainTokens().render(DefaultExplainFormatter.forDebugging()).toString();
}

@Nonnull
@Override
public ExplainTokensWithPrecedence explain() {
return ExplainTokensWithPrecedence.of(new ExplainTokens().addKeyword("IS")
.addWhitespace().addIdentifier(typelessString()));
}

@Override
Expand Down
Loading