-
Notifications
You must be signed in to change notification settings - Fork 3.5k
[Enhancement] (nereids)implement showColumnsCommand in nereids #45832
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
c029bc6
[Enhancement] (nereids)implement showColumnsCommand in nereids
msridhar78 24af313
Update fe/fe-core/src/main/antlr4/org/apache/doris/nereids/DorisParse…
msridhar78 6ef78be
Added wildWhere parsing and support
msridhar78 3984768
Fix RT test case
msridhar78 fe8744e
Removed sorting of rows
msridhar78 45606f6
fix compile
msridhar78 596e139
Regression test fixes
msridhar78 f096334
Fix regression test case issue
msridhar78 a5fbf06
review comments
msridhar78 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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
254 changes: 254 additions & 0 deletions
254
...-core/src/main/java/org/apache/doris/nereids/trees/plans/commands/ShowColumnsCommand.java
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 |
|---|---|---|
| @@ -0,0 +1,254 @@ | ||
| // Licensed to the Apache Software Foundation (ASF) under one | ||
| // or more contributor license agreements. See the NOTICE file | ||
| // distributed with this work for additional information | ||
| // regarding copyright ownership. The ASF licenses this file | ||
| // to you 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 org.apache.doris.nereids.trees.plans.commands; | ||
|
|
||
| import org.apache.doris.catalog.Column; | ||
| import org.apache.doris.catalog.DatabaseIf; | ||
| import org.apache.doris.catalog.Env; | ||
| import org.apache.doris.catalog.ScalarType; | ||
| import org.apache.doris.catalog.TableIf; | ||
| import org.apache.doris.common.AnalysisException; | ||
| import org.apache.doris.common.CaseSensibility; | ||
| import org.apache.doris.common.ErrorCode; | ||
| import org.apache.doris.common.ErrorReport; | ||
| import org.apache.doris.common.PatternMatcher; | ||
| import org.apache.doris.common.PatternMatcherWrapper; | ||
| import org.apache.doris.mysql.privilege.PrivPredicate; | ||
| import org.apache.doris.nereids.analyzer.UnboundSlot; | ||
| import org.apache.doris.nereids.trees.expressions.Expression; | ||
| import org.apache.doris.nereids.trees.expressions.visitor.DefaultExpressionRewriter; | ||
| import org.apache.doris.nereids.trees.plans.PlanType; | ||
| import org.apache.doris.nereids.trees.plans.commands.info.AliasInfo; | ||
| import org.apache.doris.nereids.trees.plans.commands.info.TableNameInfo; | ||
| import org.apache.doris.nereids.trees.plans.logical.LogicalPlan; | ||
| import org.apache.doris.nereids.trees.plans.visitor.PlanVisitor; | ||
| import org.apache.doris.nereids.util.Utils; | ||
| import org.apache.doris.qe.ConnectContext; | ||
| import org.apache.doris.qe.ShowResultSet; | ||
| import org.apache.doris.qe.ShowResultSetMetaData; | ||
| import org.apache.doris.qe.StmtExecutor; | ||
|
|
||
| import com.google.common.base.Strings; | ||
| import com.google.common.collect.Lists; | ||
|
|
||
| import java.util.ArrayList; | ||
| import java.util.List; | ||
| import java.util.Locale; | ||
|
|
||
| /** | ||
| * Represents the SHOW COLUMNS command. | ||
| */ | ||
| public class ShowColumnsCommand extends ShowCommand { | ||
| private static final ShowResultSetMetaData META_DATA = ShowResultSetMetaData.builder() | ||
| .addColumn(new Column("Field", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Type", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Null", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Key", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Default", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Extra", ScalarType.createVarchar(20))).build(); | ||
|
|
||
| private static final ShowResultSetMetaData META_DATA_VERBOSE = | ||
| ShowResultSetMetaData.builder() | ||
| .addColumn(new Column("Field", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Type", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Collation", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Null", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Key", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Default", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Extra", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Privileges", ScalarType.createVarchar(20))) | ||
| .addColumn(new Column("Comment", ScalarType.createVarchar(20))) | ||
| .build(); | ||
|
|
||
| private final boolean isFull; | ||
| private TableNameInfo tableNameInfo; | ||
| private final String databaseName; | ||
| private final String likePattern; | ||
| private final Expression whereClause; | ||
|
|
||
| /** | ||
| * SHOW COLUMNS command Constructor. | ||
| */ | ||
| public ShowColumnsCommand(boolean isFull, TableNameInfo tableNameInfo, String databaseName, String likePattern, | ||
| Expression whereClause) { | ||
| super(PlanType.SHOW_COLUMNS_COMMAND); | ||
| this.isFull = isFull; | ||
| this.tableNameInfo = tableNameInfo; | ||
| this.databaseName = databaseName; | ||
| this.likePattern = likePattern; | ||
| this.whereClause = whereClause; | ||
| } | ||
|
|
||
| /** | ||
| * SHOW COLUMNS validate. | ||
| */ | ||
| public void validate(ConnectContext ctx) throws AnalysisException { | ||
| if (!Strings.isNullOrEmpty(databaseName)) { | ||
| tableNameInfo.setDb(databaseName); | ||
| } | ||
| tableNameInfo.analyze(ctx); | ||
| if (!Env.getCurrentEnv().getAccessManager() | ||
| .checkTblPriv(ConnectContext.get(), tableNameInfo.getCtl(), tableNameInfo.getDb(), | ||
| tableNameInfo.getTbl(), PrivPredicate.SHOW)) { | ||
| ErrorReport.reportAnalysisException(ErrorCode.ERR_TABLE_ACCESS_DENIED_ERROR, | ||
| PrivPredicate.SHOW.getPrivs().toString(), tableNameInfo); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * replaceColumnNameVisitor | ||
| * replace column name to real column name | ||
| */ | ||
| private static class ReplaceColumnNameVisitor extends DefaultExpressionRewriter<Void> { | ||
| @Override | ||
| public Expression visitUnboundSlot(UnboundSlot slot, Void context) { | ||
| String name = slot.getName().toLowerCase(Locale.ROOT); | ||
| switch (name) { | ||
| case "field": | ||
| return UnboundSlot.quoted("COLUMN_NAME"); | ||
| case "type": | ||
| return UnboundSlot.quoted("COLUMN_TYPE"); | ||
| case "null": | ||
| return UnboundSlot.quoted("IS_NULLABLE"); | ||
| case "default": | ||
| return UnboundSlot.quoted("COLUMN_DEFAULT"); | ||
| case "comment": | ||
| return UnboundSlot.quoted("COLUMN_COMMENT"); | ||
| default: | ||
| return slot; | ||
| } | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| public ShowResultSet doRun(ConnectContext ctx, StmtExecutor executor) throws Exception { | ||
| validate(ctx); | ||
| if (whereClause != null) { | ||
| Expression rewritten = whereClause.accept(new ReplaceColumnNameVisitor(), null); | ||
| String whereCondition = " WHERE TABLE_NAME = '" + tableNameInfo.getTbl() + "' AND " + rewritten.toSql(); | ||
| TableNameInfo info = new TableNameInfo(tableNameInfo.getCtl(), "information_schema", "columns"); | ||
|
|
||
| List<AliasInfo> selectList = new ArrayList<>(); | ||
| if (isFull) { | ||
| selectList.add(AliasInfo.of("COLUMN_NAME", "Field")); | ||
| selectList.add(AliasInfo.of("COLUMN_TYPE", "Type")); | ||
| selectList.add(AliasInfo.of("COLLATION_NAME", "Collation")); | ||
| selectList.add(AliasInfo.of("IS_NULLABLE", "Null")); | ||
| selectList.add(AliasInfo.of("COLUMN_KEY", "Key")); | ||
| selectList.add(AliasInfo.of("COLUMN_DEFAULT", "Default")); | ||
| selectList.add(AliasInfo.of("EXTRA", "Extra")); | ||
| selectList.add(AliasInfo.of("PRIVILEGES", "Privileges")); // optional, can be set to '' | ||
| selectList.add(AliasInfo.of("COLUMN_COMMENT", "Comment")); | ||
| } else { | ||
| selectList.add(AliasInfo.of("COLUMN_NAME", "Field")); | ||
| selectList.add(AliasInfo.of("COLUMN_TYPE", "Type")); | ||
| selectList.add(AliasInfo.of("IS_NULLABLE", "Null")); | ||
| selectList.add(AliasInfo.of("COLUMN_KEY", "Key")); | ||
| selectList.add(AliasInfo.of("COLUMN_DEFAULT", "Default")); | ||
| selectList.add(AliasInfo.of("EXTRA", "Extra")); | ||
| } | ||
|
|
||
| LogicalPlan plan = Utils.buildLogicalPlan(selectList, info, whereCondition); | ||
| List<List<String>> rows = Utils.executePlan(ctx, executor, plan); | ||
| for (List<String> row : rows) { | ||
| String rawType = row.get(1); | ||
| row.set(1, normalizeSqlColumnType(rawType)); | ||
| } | ||
|
|
||
| return new ShowResultSet(getMetaData(), rows); | ||
| } | ||
| List<List<String>> rows = Lists.newArrayList(); | ||
| String ctl = tableNameInfo.getCtl(); | ||
| DatabaseIf db = Env.getCurrentEnv().getCatalogMgr().getCatalogOrAnalysisException(ctl) | ||
| .getDbOrAnalysisException(tableNameInfo.getDb()); | ||
| TableIf table = db.getTableOrAnalysisException(tableNameInfo.getTbl()); | ||
| PatternMatcher matcher = null; | ||
| if (likePattern != null) { | ||
| matcher = PatternMatcherWrapper.createMysqlPattern(likePattern, | ||
| CaseSensibility.COLUMN.getCaseSensibility()); | ||
| } | ||
| table.readLock(); | ||
| try { | ||
| List<Column> columns = table.getBaseSchema(); | ||
| for (Column col : columns) { | ||
| if (matcher != null && !matcher.match(col.getName())) { | ||
| continue; | ||
| } | ||
| final String columnName = col.getName(); | ||
| final String columnType = col.getOriginType().toString().toLowerCase(Locale.ROOT); | ||
| final String isAllowNull = col.isAllowNull() ? "YES" : "NO"; | ||
| final String isKey = col.isKey() ? "YES" : "NO"; | ||
| final String defaultValue = col.getDefaultValue(); | ||
| final String aggType = col.getAggregationType() == null ? "" : col.getAggregationType().toSql(); | ||
| if (isFull) { | ||
| // Field Type Collation Null Key Default Extra | ||
| // Privileges Comment | ||
| rows.add(Lists.newArrayList(columnName, | ||
| columnType, | ||
| "", | ||
| isAllowNull, | ||
| isKey, | ||
| defaultValue, | ||
| aggType, | ||
| "", | ||
| col.getComment())); | ||
| } else { | ||
| // Field Type Null Key Default Extra | ||
| rows.add(Lists.newArrayList(columnName, | ||
| columnType, | ||
| isAllowNull, | ||
| isKey, | ||
| defaultValue, | ||
| aggType)); | ||
| } | ||
| } | ||
| } finally { | ||
| table.readUnlock(); | ||
| } | ||
|
|
||
| return new ShowResultSet(getMetaData(), rows); | ||
| } | ||
|
|
||
| @Override | ||
| public <R, C> R accept(PlanVisitor<R, C> visitor, C context) { | ||
| return visitor.visitShowColumnsCommand(this, context); | ||
| } | ||
|
|
||
| @Override | ||
| public ShowResultSetMetaData getMetaData() { | ||
| if (isFull) { | ||
| return META_DATA_VERBOSE; | ||
| } else { | ||
| return META_DATA; | ||
| } | ||
| } | ||
|
|
||
| private static String normalizeSqlColumnType(String type) { | ||
| if (type == null) { | ||
| return null; | ||
| } | ||
|
|
||
| type = type.toLowerCase().trim(); | ||
|
|
||
| if (type.matches("^[a-z]+\\s*\\(.*\\)$")) { | ||
| int parenIndex = type.indexOf('('); | ||
| return type.substring(0, parenIndex).trim(); | ||
| } | ||
| return type; | ||
| } | ||
| } | ||
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
17 changes: 17 additions & 0 deletions
17
regression-test/data/nereids_p0/show/test_show_columns_command.out
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 |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| -- This file is automatically generated. You should know what you did if you want to edit this | ||
| -- !cmd -- | ||
| id int YES YES \N | ||
| name text YES NO \N NONE | ||
| score float YES NO \N NONE | ||
|
|
||
| -- !cmd -- | ||
| id int YES YES \N | ||
| name text YES NO \N NONE | ||
| score float YES NO \N NONE | ||
|
|
||
| -- !cmd -- | ||
| score float YES NO \N NONE | ||
|
|
||
| -- !cmd -- | ||
| id int YES DUP \N | ||
|
|
Oops, something went wrong.
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.
I am not sure why we need normalize column type, have you tried other data types like varchar, map, struct. etc...
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.
without normalizing - the result is returned as "int(11)" "varchar(50)" - all the test cases in regression suite are expecting "int" instead of the returned "int(11)" and "varchar" instead of "varchar(50)"