ShowIndexCommand.java
// 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.analysis.RedirectStatus;
import org.apache.doris.catalog.Column;
import org.apache.doris.catalog.Database;
import org.apache.doris.catalog.DatabaseIf;
import org.apache.doris.catalog.Env;
import org.apache.doris.catalog.Index;
import org.apache.doris.catalog.OlapTable;
import org.apache.doris.catalog.ScalarType;
import org.apache.doris.catalog.TableIf;
import org.apache.doris.catalog.TableKeyMeta;
import org.apache.doris.catalog.info.TableNameInfo;
import org.apache.doris.common.AnalysisException;
import org.apache.doris.common.ErrorCode;
import org.apache.doris.common.ErrorReport;
import org.apache.doris.datasource.InternalCatalog;
import org.apache.doris.mysql.privilege.PrivPredicate;
import org.apache.doris.nereids.trees.plans.PlanType;
import org.apache.doris.nereids.trees.plans.visitor.PlanVisitor;
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.annotations.VisibleForTesting;
import com.google.common.base.Strings;
import com.google.common.collect.Lists;
import java.util.List;
/**
* show index command
*/
public class ShowIndexCommand extends ShowCommand {
private static final ShowResultSetMetaData META_DATA =
ShowResultSetMetaData.builder()
.addColumn(new Column("Table", ScalarType.createVarchar(128)))
.addColumn(new Column("Non_unique", ScalarType.createVarchar(128)))
.addColumn(new Column("Key_name", ScalarType.createVarchar(160)))
.addColumn(new Column("Seq_in_index", ScalarType.createVarchar(128)))
.addColumn(new Column("Column_name", ScalarType.createVarchar(160)))
.addColumn(new Column("Collation", ScalarType.createVarchar(160)))
.addColumn(new Column("Cardinality", ScalarType.createVarchar(160)))
.addColumn(new Column("Sub_part", ScalarType.createVarchar(160)))
.addColumn(new Column("Packed", ScalarType.createVarchar(160)))
.addColumn(new Column("Null", ScalarType.createVarchar(160)))
.addColumn(new Column("Index_type", ScalarType.createVarchar(160)))
.addColumn(new Column("Comment", ScalarType.createVarchar(160)))
.addColumn(new Column("Properties", ScalarType.createVarchar(400)))
.build();
/**
* MySQL's own SHOW INDEX layout, which splits what Doris packs into one column: Comment
* carries status information about the index, Index_comment carries the description the
* user declared. A client that reads the declared description looks for Index_comment,
* so compatible mode has to name it that. Doris' own Properties is kept on the end,
* after everything MySQL documents, so nothing is lost by turning the switch on.
*/
private static final ShowResultSetMetaData MYSQL_COMPATIBLE_META_DATA =
ShowResultSetMetaData.builder()
.addColumn(new Column("Table", ScalarType.createVarchar(128)))
.addColumn(new Column("Non_unique", ScalarType.createVarchar(128)))
.addColumn(new Column("Key_name", ScalarType.createVarchar(160)))
.addColumn(new Column("Seq_in_index", ScalarType.createVarchar(128)))
.addColumn(new Column("Column_name", ScalarType.createVarchar(160)))
.addColumn(new Column("Collation", ScalarType.createVarchar(160)))
.addColumn(new Column("Cardinality", ScalarType.createVarchar(160)))
.addColumn(new Column("Sub_part", ScalarType.createVarchar(160)))
.addColumn(new Column("Packed", ScalarType.createVarchar(160)))
.addColumn(new Column("Null", ScalarType.createVarchar(160)))
.addColumn(new Column("Index_type", ScalarType.createVarchar(160)))
.addColumn(new Column("Comment", ScalarType.createVarchar(160)))
.addColumn(new Column("Index_comment", ScalarType.createVarchar(1024)))
.addColumn(new Column("Visible", ScalarType.createVarchar(3)))
.addColumn(new Column("Expression", ScalarType.createVarchar(1024)))
.addColumn(new Column("Properties", ScalarType.createVarchar(400)))
.build();
private TableNameInfo tableNameInfo;
/**
* constructor for show index
*/
public ShowIndexCommand(TableNameInfo tableNameInfo) {
super(PlanType.SHOW_INDEX_COMMAND);
this.tableNameInfo = tableNameInfo;
}
@VisibleForTesting
protected void analyze(ConnectContext ctx) throws AnalysisException {
if (Strings.isNullOrEmpty(tableNameInfo.getCtl())) {
String ctl = ctx.getCurrentCatalog().getName();
if (Strings.isNullOrEmpty(ctl)) {
ctl = InternalCatalog.INTERNAL_CATALOG_NAME;
}
tableNameInfo.setCtl(ctl);
}
if (Strings.isNullOrEmpty(tableNameInfo.getDb())) {
String dbName = ctx.getDatabase();
if (Strings.isNullOrEmpty(dbName)) {
ErrorReport.reportAnalysisException(ErrorCode.ERR_NO_DB_ERROR);
}
tableNameInfo.setDb(dbName);
}
if (Strings.isNullOrEmpty(tableNameInfo.getTbl())) {
throw new AnalysisException("Table name is null");
}
if (!Env.getCurrentEnv().getAccessManager().checkTblPriv(
ConnectContext.get(), tableNameInfo.getCtl(),
tableNameInfo.getDb(), tableNameInfo.getTbl(), PrivPredicate.SHOW)) {
ErrorReport.reportAnalysisException(ErrorCode.ERR_TABLEACCESS_DENIED_ERROR, "SHOW INDEX",
ConnectContext.get().getQualifiedUser(), ConnectContext.get().getRemoteIP(), tableNameInfo.toSql());
}
}
private ShowResultSet handleShowIndex(ConnectContext ctx, StmtExecutor executor) throws Exception {
analyze(ctx);
DatabaseIf db = Env.getCurrentEnv().getCatalogMgr()
.getCatalogOrAnalysisException(tableNameInfo.getCtl())
.getDbOrAnalysisException(tableNameInfo.getDb());
boolean mysqlCompatible = ctx.getSessionVariable().enableMysqlCompatibleIndexMetadata();
List<List<String>> rows = mysqlCompatible ? mysqlCompatibleRows(db) : legacyRows(db);
return new ShowResultSet(getMetaData(), rows);
}
/**
* Reports keys and indexes the way MySQL does: one row per indexed column, with the
* unique key of the table named PRIMARY so that ODBC and JDBC clients recognize it.
*/
private List<List<String>> mysqlCompatibleRows(DatabaseIf db) throws Exception {
List<List<String>> rows = Lists.newArrayList();
TableIf table = db.getTableOrAnalysisException(tableNameInfo.getTbl());
table.readLock();
try {
for (TableKeyMeta.KeyRow row : TableKeyMeta.buildKeyRows(table)) {
// A null cell is sent as SQL NULL, which is what MySQL reports for a
// value that does not apply to the index.
rows.add(Lists.newArrayList(
row.getTableName(),
row.isNonUnique() ? "1" : "0",
row.getIndexName(),
String.valueOf(row.getSeqInIndex()),
row.getColumnName(),
row.getCollation(),
row.getCardinality() == null ? null : String.valueOf(row.getCardinality()),
null,
null,
row.isNullable() ? "YES" : "",
row.getIndexType(),
// MySQL keeps Comment for index status, of which Doris has none,
// and reports the declared description as Index_comment.
"",
row.getComment(),
"YES",
null,
row.getProperties()));
}
} finally {
table.readUnlock();
}
return rows;
}
/**
* The output Doris has always produced: secondary indexes only, one row per index,
* with the columns of an index joined into a single cell.
*/
private List<List<String>> legacyRows(DatabaseIf db) throws Exception {
List<List<String>> rows = Lists.newArrayList();
// in show index, only support internal catalog
if (db instanceof Database) {
TableIf table = db.getTableOrAnalysisException(tableNameInfo.getTbl());
if (table instanceof OlapTable) {
OlapTable olapTable = (OlapTable) table;
olapTable.readLock();
try {
List<Index> indexes = olapTable.getIndexes();
for (Index index : indexes) {
rows.add(Lists.newArrayList(tableNameInfo.getTbl(), "", index.getIndexName(),
"", String.join(",", index.getColumns()), "", "", "", "",
"", index.getIndexType().name(), index.getComment(), index.getPropertiesString()));
}
} finally {
olapTable.readUnlock();
}
}
}
return rows;
}
@Override
public ShowResultSet doRun(ConnectContext ctx, StmtExecutor executor) throws Exception {
return handleShowIndex(ctx, executor);
}
@Override
public ShowResultSetMetaData getMetaData() {
ConnectContext ctx = ConnectContext.get();
return ctx != null && ctx.getSessionVariable().enableMysqlCompatibleIndexMetadata()
? MYSQL_COMPATIBLE_META_DATA : META_DATA;
}
@Override
public RedirectStatus toRedirectStatus() {
return RedirectStatus.NO_FORWARD;
}
@Override
public <R, C> R accept(PlanVisitor<R, C> visitor, C context) {
return visitor.visitShowIndexCommand(this, context);
}
}