Skip to content

Commit

Permalink
[feature](nereids)support show view command in nereids (#44698)
Browse files Browse the repository at this point in the history
  • Loading branch information
starocean999 authored Nov 29, 2024
1 parent 412cec5 commit 22b7c4c
Show file tree
Hide file tree
Showing 11 changed files with 324 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -48,8 +48,9 @@ statementBase
| supportedCreateStatement #supportedCreateStatementAlias
| supportedAlterStatement #supportedAlterStatementAlias
| materializedViewStatement #materializedViewStatementAlias
| supportedJobStatement #supportedJobStatementAlias
| supportedJobStatement #supportedJobStatementAlias
| constraintStatement #constraintStatementAlias
| supportedShowStatement #supportedShowStatementAlias
| unsupportedStatement #unsupported
;

Expand Down Expand Up @@ -180,6 +181,12 @@ supportedAlterStatement
AS query #alterView
;

supportedShowStatement
: SHOW VIEW
(FROM |IN) tableName=multipartIdentifier
((FROM | IN) database=identifier)? #showView
;

unsupportedOtherStatement
: HELP mark=identifierOrText #help
| INSTALL PLUGIN FROM source=identifierOrText properties=propertyClause? #installPlugin
Expand Down Expand Up @@ -284,9 +291,6 @@ unsupportedShowStatement
| SHOW (KEY | KEYS | INDEX | INDEXES)
(FROM |IN) tableName=multipartIdentifier
((FROM | IN) database=multipartIdentifier)? #showIndex
| SHOW VIEW
(FROM |IN) tableName=multipartIdentifier
((FROM | IN) database=multipartIdentifier)? #showView
| SHOW TRANSACTION ((FROM | IN) database=multipartIdentifier)? wildWhere? #showTransaction
| SHOW QUERY PROFILE queryIdPath=STRING_LITERAL #showQueryProfile
| SHOW LOAD PROFILE loadIdPath=STRING_LITERAL #showLoadProfile
Expand Down
13 changes: 13 additions & 0 deletions fe/fe-core/src/main/java/org/apache/doris/catalog/Database.java
Original file line number Diff line number Diff line change
Expand Up @@ -473,6 +473,19 @@ public List<Table> getViews() {
return views;
}

public List<Table> getViewsOnIdOrder() {
List<Table> tables = idToTable.values().stream()
.sorted(Comparator.comparing(Table::getId))
.collect(Collectors.toList());
List<Table> views = new ArrayList<>();
for (Table table : tables) {
if (table.getType() == TableType.VIEW) {
views.add(table);
}
}
return views;
}

/**
* this method is used for get existed table list by table id list, if table not exist, just ignore it.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -173,6 +173,7 @@
import org.apache.doris.nereids.DorisParser.ShowCreateMTMVContext;
import org.apache.doris.nereids.DorisParser.ShowCreateProcedureContext;
import org.apache.doris.nereids.DorisParser.ShowProcedureStatusContext;
import org.apache.doris.nereids.DorisParser.ShowViewContext;
import org.apache.doris.nereids.DorisParser.SimpleColumnDefContext;
import org.apache.doris.nereids.DorisParser.SimpleColumnDefsContext;
import org.apache.doris.nereids.DorisParser.SingleStatementContext;
Expand Down Expand Up @@ -389,6 +390,7 @@
import org.apache.doris.nereids.trees.plans.commands.ShowCreateMTMVCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowCreateProcedureCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowProcedureStatusCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowViewCommand;
import org.apache.doris.nereids.trees.plans.commands.UnsupportedCommand;
import org.apache.doris.nereids.trees.plans.commands.UpdateCommand;
import org.apache.doris.nereids.trees.plans.commands.info.AlterMTMVInfo;
Expand Down Expand Up @@ -3673,4 +3675,14 @@ public LogicalPlan visitCreateTableLike(CreateTableLikeContext ctx) {
rollupNames, withAllRollUp);
return new CreateTableLikeCommand(info);
}

@Override
public ShowViewCommand visitShowView(ShowViewContext ctx) {
List<String> tableNameParts = visitMultipartIdentifier(ctx.tableName);
String databaseName = null;
if (ctx.database != null) {
databaseName = stripQuotes(ctx.database.getText());
}
return new ShowViewCommand(databaseName, new TableNameInfo(tableNameParts));
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -159,6 +159,7 @@ public enum PlanType {
DROP_PROCEDURE_COMMAND,
SHOW_PROCEDURE_COMMAND,
SHOW_CREATE_PROCEDURE_COMMAND,
SHOW_VIEW_COMMAND,
CREATE_VIEW_COMMAND,
ALTER_VIEW_COMMAND,
UNSUPPORTED_COMMAND,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,151 @@
// 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.Database;
import org.apache.doris.catalog.Env;
import org.apache.doris.catalog.ScalarType;
import org.apache.doris.catalog.Table;
import org.apache.doris.catalog.View;
import org.apache.doris.common.ErrorCode;
import org.apache.doris.common.ErrorReport;
import org.apache.doris.common.util.Util;
import org.apache.doris.mysql.privilege.PrivPredicate;
import org.apache.doris.nereids.NereidsPlanner;
import org.apache.doris.nereids.StatementContext;
import org.apache.doris.nereids.parser.NereidsParser;
import org.apache.doris.nereids.properties.PhysicalProperties;
import org.apache.doris.nereids.trees.plans.PlanType;
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.PlanUtils;
import org.apache.doris.qe.ConnectContext;
import org.apache.doris.qe.OriginStatement;
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.List;
import java.util.stream.Collectors;

/**
* ShowViewCommand
*/
public class ShowViewCommand extends Command implements NoForward {
private static final ShowResultSetMetaData META_DATA = ShowResultSetMetaData.builder()
.addColumn(new Column("View", ScalarType.createVarchar(30)))
.addColumn(new Column("Create View", ScalarType.createVarchar(65535)))
.build();

private final String db;
private final TableNameInfo tbl;
private List<View> matchViews = Lists.newArrayList();

public ShowViewCommand(String db, TableNameInfo tbl) {
super(PlanType.SHOW_VIEW_COMMAND);
this.db = db;
this.tbl = tbl;
}

@Override
public <R, C> R accept(PlanVisitor<R, C> visitor, C context) {
return visitor.visitShowViewCommand(this, context);
}

private void validate(ConnectContext ctx) throws Exception {
if (!Strings.isNullOrEmpty(db)) {
// if user specify the `from db`, overwrite the db in `tbl` with this db.
// for example:
// show view from db1.tbl1 from db2;
// will be rewrote to:
// show view from db2.tbl1;
// this act same as in MySQL
tbl.setDb(db);
}
tbl.analyze(ctx);
// disallow external catalog
Util.prohibitExternalCatalog(tbl.getCtl(), this.getClass().getSimpleName());

String dbName = tbl.getDb();
if (!Env.getCurrentEnv().getAccessManager().checkTblPriv(
ConnectContext.get(), tbl.getCtl(), dbName, tbl.getTbl(), PrivPredicate.SHOW)) {
ErrorReport.reportAnalysisException(ErrorCode.ERR_TABLEACCESS_DENIED_ERROR, "SHOW VIEW",
ConnectContext.get().getQualifiedUser(),
ConnectContext.get().getRemoteIP(),
dbName + ": " + tbl.getTbl());
}

Database database = Env.getCurrentInternalCatalog().getDbOrAnalysisException(dbName);
database.getOlapTableOrAnalysisException(tbl.getTbl());
for (Table table : database.getViewsOnIdOrder()) {
View view = (View) table;
// get table refs instead of get tables because it don't need to check table's validity
List<TableNameInfo> tableNameInfos = getTableNames(ctx, view.getInlineViewDef());
for (TableNameInfo tableNameInfo : tableNameInfos) {
tableNameInfo.analyze(ctx);
if (tableNameInfo.equals(tbl)) {
matchViews.add(view);
}
}
}
}

private List<TableNameInfo> getTableNames(ConnectContext ctx, String sql) {
LogicalPlan unboundMvPlan = new NereidsParser().parseSingle(sql);
StatementContext statementContext = new StatementContext(ctx,
new OriginStatement(sql, 0));
NereidsPlanner planner = new NereidsPlanner(statementContext);
if (ctx.getStatementContext() == null) {
ctx.setStatementContext(statementContext);
}
planner.planWithLock(unboundMvPlan, PhysicalProperties.ANY, ExplainCommand.ExplainLevel.ANALYZED_PLAN);
LogicalPlan logicalPlan = (LogicalPlan) planner.getCascadesContext().getRewritePlan();

return PlanUtils.getLogicalScanFromRootPlan(logicalPlan).stream()
.map(plan -> new TableNameInfo(plan.getTable().getFullQualifiers())).collect(Collectors.toList());
}

@Override
public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
validate(ctx);
List<List<String>> rows = Lists.newArrayList();
for (View view : matchViews) {
view.readLock();
try {
List<String> createViewStmt = Lists.newArrayList();
Env.getDdlStmt(view, createViewStmt, null, null, false, true /* hide password */, -1L);
if (!createViewStmt.isEmpty()) {
rows.add(Lists.newArrayList(view.getName(), createViewStmt.get(0)));
}
} finally {
view.readUnlock();
}
}
ShowResultSet resultSet = new ShowResultSet(META_DATA, rows);
if (executor.isProxy()) {
executor.setProxyShowResultSet(resultSet);
} else {
executor.sendResultSet(resultSet);
}
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -121,6 +121,14 @@ public String getCtl() {
return ctl;
}

/**
* set a new database name
* @param db new database name
*/
public void setDb(String db) {
this.db = db;
}

/**
* get db name
* @return dbName
Expand Down Expand Up @@ -162,4 +170,27 @@ public void readFields(DataInput in) throws IOException {
db = fromJson.db;
tbl = fromJson.tbl;
}

/**
* equals
*/
@Override
public boolean equals(Object o) {
if (this == o) {
return true;
}
if (o == null || getClass() != o.getClass()) {
return false;
}
TableNameInfo that = (TableNameInfo) o;
return tbl.equals(that.tbl) && db.equals(that.db) && ctl.equals(that.ctl);
}

/**
* hashCode
*/
@Override
public int hashCode() {
return Objects.hash(tbl, db, ctl);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,7 @@
import org.apache.doris.nereids.trees.plans.commands.ShowCreateMTMVCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowCreateProcedureCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowProcedureStatusCommand;
import org.apache.doris.nereids.trees.plans.commands.ShowViewCommand;
import org.apache.doris.nereids.trees.plans.commands.UnsupportedCommand;
import org.apache.doris.nereids.trees.plans.commands.UpdateCommand;
import org.apache.doris.nereids.trees.plans.commands.insert.BatchInsertIntoTableCommand;
Expand Down Expand Up @@ -186,4 +187,8 @@ default R visitUnsupportedCommand(UnsupportedCommand unsupportedCommand, C conte
default R visitCreateTableLikeCommand(CreateTableLikeCommand createTableLikeCommand, C context) {
return visitCommand(createTableLikeCommand, context);
}

default R visitShowViewCommand(ShowViewCommand showViewCommand, C context) {
return visitCommand(showViewCommand, context);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,10 @@ public StmtExecutor(ConnectContext ctx, StatementBase parsedStmt) {
context.getSessionVariable().profileLevel, context.getSessionVariable().getEnablePipelineXEngine());
}

public boolean isProxy() {
return isProxy;
}

public static InternalService.PDataRow getRowStringValue(List<Expr> cols,
FormatOptions options) throws UserException {
if (cols.isEmpty()) {
Expand Down
17 changes: 17 additions & 0 deletions regression-test/data/nereids_p0/show/show_view_command.out
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 --
ttv1 CREATE VIEW `ttv1` AS select `internal`.`test_show_view_db2`.`t1`.`c1`, `internal`.`test_show_view_db2`.`t2`.`c2` from `internal`.`test_show_view_db2`.`t1` join `internal`.`test_show_view_db2`.`t2` on `internal`.`test_show_view_db2`.`t1`.`c2` = `internal`.`test_show_view_db2`.`t2`.`c2`;
ttv2 CREATE VIEW `ttv2` AS select `internal`.`test_show_view_db2`.`t1`.`c1` from `internal`.`test_show_view_db2`.`t1` where `internal`.`test_show_view_db2`.`t1`.`c2` = 1;

-- !cmd --
tv1 CREATE VIEW `tv1` AS select `internal`.`test_show_view_db1`.`t1`.`c1`, `internal`.`test_show_view_db1`.`t2`.`c2` from `internal`.`test_show_view_db1`.`t1` join `internal`.`test_show_view_db1`.`t2` on `internal`.`test_show_view_db1`.`t1`.`c2` = `internal`.`test_show_view_db1`.`t2`.`c2`;
tv2 CREATE VIEW `tv2` AS select `internal`.`test_show_view_db1`.`t1`.`c1` from `internal`.`test_show_view_db1`.`t1` where `internal`.`test_show_view_db1`.`t1`.`c2` = 1;

-- !cmd --
ttv1 CREATE VIEW `ttv1` AS select `internal`.`test_show_view_db2`.`t1`.`c1`, `internal`.`test_show_view_db2`.`t2`.`c2` from `internal`.`test_show_view_db2`.`t1` join `internal`.`test_show_view_db2`.`t2` on `internal`.`test_show_view_db2`.`t1`.`c2` = `internal`.`test_show_view_db2`.`t2`.`c2`;
ttv2 CREATE VIEW `ttv2` AS select `internal`.`test_show_view_db2`.`t1`.`c1` from `internal`.`test_show_view_db2`.`t1` where `internal`.`test_show_view_db2`.`t1`.`c2` = 1;

-- !cmd --
ttv1 CREATE VIEW `ttv1` AS select `internal`.`test_show_view_db2`.`t1`.`c1`, `internal`.`test_show_view_db2`.`t2`.`c2` from `internal`.`test_show_view_db2`.`t1` join `internal`.`test_show_view_db2`.`t2` on `internal`.`test_show_view_db2`.`t1`.`c2` = `internal`.`test_show_view_db2`.`t2`.`c2`;
ttv2 CREATE VIEW `ttv2` AS select `internal`.`test_show_view_db2`.`t1`.`c1` from `internal`.`test_show_view_db2`.`t1` where `internal`.`test_show_view_db2`.`t1`.`c2` = 1;

Original file line number Diff line number Diff line change
Expand Up @@ -92,4 +92,6 @@ suite("create_view_use_mv") {
group by
k1, k2, k3, k4, k5, l_orderkey, mv_o_orderkey"""
qt_alter_view_from_mv "select * from v_for_alter order by 1"

sql """show view from orders""";
}
Loading

0 comments on commit 22b7c4c

Please sign in to comment.