Enhancement #3028: Add verbosity-level option to SQL EXPLAIN #3485
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 | ||||
|---|---|---|---|---|---|---|
|
|
@@ -24,6 +24,7 @@ | |||||
|
|
||||||
| import com.apple.foundationdb.record.ExecuteProperties; | ||||||
| import com.apple.foundationdb.record.PlanHashable; | ||||||
| import com.apple.foundationdb.record.query.plan.explain.ExplainLevel; | ||||||
| import com.apple.foundationdb.relational.util.SpotBugsSuppressWarnings; | ||||||
|
|
||||||
| import javax.annotation.Nonnull; | ||||||
|
|
@@ -44,6 +45,8 @@ public final class NormalizedQueryExecutionContext implements QueryExecutionCont | |||||
|
|
||||||
| private final boolean isForExplain; | ||||||
|
|
||||||
| private int explainLevel; | ||||||
|
|
||||||
| private final int parameterHash; | ||||||
|
|
||||||
| @Nonnull | ||||||
|
|
@@ -53,10 +56,12 @@ private NormalizedQueryExecutionContext(@Nonnull Literals literals, | |||||
| @Nullable byte[] continuation, | ||||||
| int parameterHash, | ||||||
| boolean isForExplain, | ||||||
| int explainLevel, | ||||||
| @Nonnull final PlanHashable.PlanHashMode planHashMode) { | ||||||
| this.literals = literals; | ||||||
| this.continuation = continuation; | ||||||
| this.isForExplain = isForExplain; | ||||||
| this.explainLevel = explainLevel; | ||||||
| this.parameterHash = parameterHash; | ||||||
| this.planHashMode = planHashMode; | ||||||
| } | ||||||
|
|
@@ -90,6 +95,11 @@ public boolean isForExplain() { | |||||
| return isForExplain; | ||||||
| } | ||||||
|
|
||||||
| @Override | ||||||
| public int getExplainLevel() { | ||||||
| return explainLevel; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| @Override | ||||||
| public PlanHashable.PlanHashMode getPlanHashMode() { | ||||||
|
|
@@ -107,6 +117,8 @@ public static final class Builder { | |||||
|
|
||||||
| private boolean isForExplain; | ||||||
|
|
||||||
| private int explainLevel; | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
|
|
||||||
| @Nullable | ||||||
| private byte[] continuation; | ||||||
|
|
||||||
|
|
@@ -120,6 +132,7 @@ private Builder() { | |||||
| this.isForExplain = false; | ||||||
| this.continuation = null; | ||||||
| this.planHashMode = null; | ||||||
| this.explainLevel = ExplainLevel.SOME_DETAILS; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
|
|
@@ -146,6 +159,12 @@ public Builder setForExplain(boolean isForExplain) { | |||||
| return this; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public Builder setExplainLevel(int level) { | ||||||
| this.explainLevel = level; | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| return this; | ||||||
| } | ||||||
|
|
||||||
| @Nonnull | ||||||
| public Builder setPlanHashMode(@Nonnull PlanHashable.PlanHashMode planHashMode) { | ||||||
| this.planHashMode = planHashMode; | ||||||
|
|
@@ -155,7 +174,7 @@ public Builder setPlanHashMode(@Nonnull PlanHashable.PlanHashMode planHashMode) | |||||
| @Nonnull | ||||||
| public NormalizedQueryExecutionContext build() { | ||||||
| return new NormalizedQueryExecutionContext(literalsBuilder.build(), continuation, | ||||||
| parameterHash, isForExplain, explainLevel, | ||||||
| Objects.requireNonNull(planHashMode)); | ||||||
| } | ||||||
| } | ||||||
|
|
||||||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -60,6 +60,8 @@ default EvaluationContext getEvaluationContext() { | |
|
|
||
| boolean isForExplain(); // todo (yhatem) remove. | ||
|
|
||
| int getExplainLevel(); | ||
|
|
||
| @Nonnull | ||
| PlanHashable.PlanHashMode getPlanHashMode(); | ||
| } | ||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -200,7 +200,7 @@ public PhysicalQueryPlan withExecutionContext(@Nonnull final QueryExecutionConte | |
| public String explain() { | ||
| final var executeProperties = queryExecutionContext.getExecutionPropertiesBuilder(); | ||
| List<String> explainComponents = new ArrayList<>(); | ||
| explainComponents.add(ExplainPlanVisitor.toStringForExternalExplain(recordQueryPlan, queryExecutionContext.getExplainLevel())); | ||
| if (executeProperties.getReturnedRowLimit() != ReadTransaction.ROW_LIMIT_UNLIMITED) { | ||
| explainComponents.add("(limit=" + executeProperties.getReturnedRowLimit() + ")"); | ||
| } | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -33,6 +33,7 @@ | |
| import com.apple.foundationdb.record.query.plan.cascades.values.FieldValue; | ||
| import com.apple.foundationdb.record.query.plan.cascades.values.LiteralValue; | ||
| import com.apple.foundationdb.record.query.plan.cascades.values.Value; | ||
| import com.apple.foundationdb.record.query.plan.explain.ExplainLevel; | ||
| import com.apple.foundationdb.record.util.pair.NonnullPair; | ||
| import com.apple.foundationdb.relational.api.exceptions.ErrorCode; | ||
| import com.apple.foundationdb.relational.generated.RelationalLexer; | ||
|
|
@@ -536,6 +537,13 @@ public Object visitExecuteContinuationStatement(@Nonnull RelationalParser.Execut | |
| @Override | ||
| public QueryPlan.LogicalQueryPlan visitFullDescribeStatement(@Nonnull RelationalParser.FullDescribeStatementContext ctx) { | ||
| getDelegate().getPlanGenerationContext().setForExplain(ctx.EXPLAIN() != null); | ||
| if (!ctx.describeObjectClause().getTokens(RelationalLexer.VERBOSE).isEmpty()) { | ||
| getDelegate().getPlanGenerationContext().setExplainLevel(ExplainLevel.ALL_DETAILS); | ||
| } else if (!ctx.describeObjectClause().getTokens(RelationalLexer.MINIMAL).isEmpty()) { | ||
| getDelegate().getPlanGenerationContext().setExplainLevel(ExplainLevel.STRUCTURE); | ||
|
There was a problem hiding this comment. I don't think we care about this level of distinction here, only an optional |
||
| } else { | ||
| getDelegate().getPlanGenerationContext().setExplainLevel(ExplainLevel.SOME_DETAILS); | ||
| } | ||
| final var logicalOperator = Assert.castUnchecked(ctx.describeObjectClause().accept(this), LogicalOperator.class); | ||
| return QueryPlan.LogicalQueryPlan.of(logicalOperator.getQuantifier().getRangesOver().get(), getDelegate().getPlanGenerationContext(), "TODO"); | ||
| } | ||
|
|
||
This file contains hidden or 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 |
|---|---|---|
|
|
@@ -73,7 +73,7 @@ void explainResultSetMetadataTest() throws Exception { | |
| final var expectedContTypes = List.of(Types.BINARY, Types.INTEGER, Types.VARCHAR); | ||
| try (var ddl = Ddl.builder().database(URI.create("/TEST/QT")).relationalExtension(relationalExtension).schemaTemplate(schemaTemplate).build()) { | ||
| executeInsert(ddl); | ||
| try (RelationalPreparedStatement ps = ddl.setSchemaAndGetConnection().prepareStatement("EXPLAIN VERBOSE SELECT * FROM RestaurantComplexRecord")) { | ||
|
There was a problem hiding this comment. please revert, and add targeted tests for |
||
| try (final RelationalResultSet resultSet = ps.executeQuery()) { | ||
| final var actualMetadata = resultSet.getMetaData(); | ||
| org.junit.jupiter.api.Assertions.assertEquals(expectedLabels.size(), actualMetadata.getColumnCount()); | ||
|
|
@@ -205,6 +205,60 @@ void explainExecuteStatementTest() throws Exception { | |
| } | ||
| } | ||
|
|
||
| @Test | ||
| void explainVerboseTest() throws Exception { | ||
| try (var ddl = Ddl.builder().database(URI.create("/TEST/QT")).relationalExtension(relationalExtension).schemaTemplate(schemaTemplate).build()) { | ||
| executeInsert(ddl); | ||
| try (RelationalPreparedStatement ps = ddl.setSchemaAndGetConnection().prepareStatement("EXPLAIN VERBOSE SELECT * FROM RestaurantComplexRecord where COUNT(reviews) > 3 and COUNT(reviews) < 100")) { | ||
| ps.setMaxRows(2); | ||
| try (final RelationalResultSet resultSet = ps.executeQuery()) { | ||
| final var assertResult = ResultSetAssert.assertThat(resultSet); | ||
| assertResult.hasNextRow() | ||
| .hasColumn("PLAN", "ISCAN(RECORD_NAME_IDX <,>) | FILTER count_star(*) GREATER_THAN promote(@c12 AS LONG) AND count_star(*) LESS_THAN promote(@c19 AS LONG)") | ||
| .hasColumn("PLAN_HASH", -1697137247L) | ||
| .hasColumn("PLAN_CONTINUATION", null); | ||
| assertResult.hasNoNextRow(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void explainMinimalTest() throws Exception { | ||
| try (var ddl = Ddl.builder().database(URI.create("/TEST/QT")).relationalExtension(relationalExtension).schemaTemplate(schemaTemplate).build()) { | ||
| executeInsert(ddl); | ||
| try (RelationalPreparedStatement ps = ddl.setSchemaAndGetConnection().prepareStatement("EXPLAIN MINIMAL SELECT * FROM RestaurantComplexRecord where COUNT(reviews) > 3 and COUNT(reviews) < 100")) { | ||
| ps.setMaxRows(2); | ||
| try (final RelationalResultSet resultSet = ps.executeQuery()) { | ||
| final var assertResult = ResultSetAssert.assertThat(resultSet); | ||
| assertResult.hasNextRow() | ||
| .hasColumn("PLAN", "ISCAN(RECORD_NAME_IDX) | FILTER count_star(*) GREATER_THAN promote(@c12 AS LONG) AND count_star(*) LESS_THAN promote(@c19 AS LONG)") | ||
| .hasColumn("PLAN_HASH", -1697137247L) | ||
| .hasColumn("PLAN_CONTINUATION", null); | ||
| assertResult.hasNoNextRow(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Test | ||
| void explainDefaultTest() throws Exception { | ||
| try (var ddl = Ddl.builder().database(URI.create("/TEST/QT")).relationalExtension(relationalExtension).schemaTemplate(schemaTemplate).build()) { | ||
| executeInsert(ddl); | ||
| try (RelationalPreparedStatement ps = ddl.setSchemaAndGetConnection().prepareStatement("EXPLAIN SELECT * FROM RestaurantComplexRecord where COUNT(reviews) > 3 and COUNT(reviews) < 100")) { | ||
| ps.setMaxRows(2); | ||
| try (final RelationalResultSet resultSet = ps.executeQuery()) { | ||
| final var assertResult = ResultSetAssert.assertThat(resultSet); | ||
| assertResult.hasNextRow() | ||
| .hasColumn("PLAN", "ISCAN(RECORD_NAME_IDX <,>) | FILTER count_star(*) GREATER_THAN promote(@c11 AS LONG) AND count_star(*) LESS_THAN promote(@c18 AS LONG)") | ||
| .hasColumn("PLAN_HASH", -1697137247L) | ||
| .hasColumn("PLAN_CONTINUATION", null); | ||
| assertResult.hasNoNextRow(); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| private Continuation consumeResultAndGetContinuation(RelationalPreparedStatement ps, int numRows) throws SQLException { | ||
| Continuation continuation; | ||
| try (final RelationalResultSet resultSet = ps.executeQuery()) { | ||
|
|
||
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.
@normen662 Done!