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.

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

[Feat](Nereids) support unset command #43103

Merged
merged 3 commits into from
Nov 4, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -54,12 +54,12 @@ statementBase
| constraintStatement #constraintStatementAlias
| supportedDropStatement #supportedDropStatementAlias
| supportedSetStatement #supportedSetStatementAlias
| supportedUnsetStatement #supportedUnsetStatementAlias
| unsupportedStatement #unsupported
;

unsupportedStatement
: unsupoortedUnsetStatement
| unsupportedUseStatement
: unsupportedUseStatement
| unsupportedDmlStatement
| unsupportedKillStatement
| unsupportedDescribeStatement
Expand Down Expand Up @@ -839,7 +839,7 @@ isolationLevel
: ISOLATION LEVEL ((READ UNCOMMITTED) | (READ COMMITTED) | (REPEATABLE READ) | (SERIALIZABLE))
;

unsupoortedUnsetStatement
supportedUnsetStatement
: UNSET (GLOBAL | SESSION | LOCAL)? VARIABLE (ALL | identifier)
| UNSET DEFAULT STORAGE VAULT
;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -205,6 +205,7 @@
import org.apache.doris.nereids.DorisParser.StructLiteralContext;
import org.apache.doris.nereids.DorisParser.SubqueryContext;
import org.apache.doris.nereids.DorisParser.SubqueryExpressionContext;
import org.apache.doris.nereids.DorisParser.SupportedUnsetStatementContext;
import org.apache.doris.nereids.DorisParser.SystemVariableContext;
import org.apache.doris.nereids.DorisParser.TableAliasContext;
import org.apache.doris.nereids.DorisParser.TableNameContext;
Expand Down Expand Up @@ -421,6 +422,8 @@
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.UnsetDefaultStorageVaultCommand;
import org.apache.doris.nereids.trees.plans.commands.UnsetVariableCommand;
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 @@ -3823,6 +3826,25 @@ public Object visitUnsupported(UnsupportedContext ctx) {
return UnsupportedCommand.INSTANCE;
}

@Override
public LogicalPlan visitSupportedUnsetStatement(SupportedUnsetStatementContext ctx) {
if (ctx.DEFAULT() != null && ctx.STORAGE() != null && ctx.VAULT() != null) {
return new UnsetDefaultStorageVaultCommand();
}
SetType type = SetType.DEFAULT;
if (ctx.GLOBAL() != null) {
type = SetType.GLOBAL;
} else if (ctx.LOCAL() != null || ctx.SESSION() != null) {
type = SetType.SESSION;
}
if (ctx.ALL() != null) {
return new UnsetVariableCommand(type, true);
} else if (ctx.identifier() != null) {
return new UnsetVariableCommand(type, ctx.identifier().getText());
}
throw new AnalysisException("Should add 'ALL' or variable name");
}

@Override
public LogicalPlan visitCreateTableLike(CreateTableLikeContext ctx) {
List<String> nameParts = visitMultipartIdentifier(ctx.name);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,8 @@ public enum PlanType {
ALTER_VIEW_COMMAND,
ALTER_STORAGE_VAULT,
DROP_CATALOG_RECYCLE_BIN_COMMAND,
UNSET_VARIABLE_COMMAND,
UNSET_DEFAULT_STORAGE_VAULT_COMMAND,
UNSUPPORTED_COMMAND,
CREATE_TABLE_LIKE_COMMAND,
SET_OPTIONS_COMMAND,
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// 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.Env;
import org.apache.doris.cloud.catalog.CloudEnv;
import org.apache.doris.common.AnalysisException;
import org.apache.doris.common.Config;
import org.apache.doris.common.ErrorCode;
import org.apache.doris.common.ErrorReport;
import org.apache.doris.common.FeConstants;
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.StmtExecutor;

/**
* Unset Default Storage Vault Command
*/
public class UnsetDefaultStorageVaultCommand extends Command implements ForwardWithSync {
public UnsetDefaultStorageVaultCommand() {
super(PlanType.UNSET_DEFAULT_STORAGE_VAULT_COMMAND);
}

public String toSql() {
final String stmt = "UNSET DEFAULT STORAGE VAULT";
return stmt;
}

@Override
public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
if (Config.isNotCloudMode()) {
throw new AnalysisException("Storage Vault is only supported for cloud mode");
}
if (!FeConstants.runningUnitTest) {
// In legacy cloud mode, some s3 back-ended storage does need to use storage vault.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

vault => value?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

storage vault is a word group

if (!((CloudEnv) Env.getCurrentEnv()).getEnableStorageVault()) {
throw new AnalysisException("Your cloud instance doesn't support storage vault");
}
}

// check auth
if (!Env.getCurrentEnv().getAccessManager().checkGlobalPriv(ConnectContext.get(), PrivPredicate.ADMIN)) {
ErrorReport.reportAnalysisException(ErrorCode.ERR_SPECIFIC_ACCESS_DENIED_ERROR, "ADMIN");
}

ctx.getEnv().getStorageVaultMgr().unsetDefaultStorageVault();
}

@Override
public <R, C> R accept(PlanVisitor<R, C> visitor, C context) {
return visitor.visitUnsetDefaultStorageVaultCommand(this, context);
}
}
Original file line number Diff line number Diff line change
@@ -0,0 +1,160 @@
// 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.analysis.SetType;
import org.apache.doris.analysis.SetVar;
import org.apache.doris.analysis.StringLiteral;
import org.apache.doris.catalog.Env;
import org.apache.doris.common.AnalysisException;
import org.apache.doris.common.DdlException;
import org.apache.doris.common.ErrorCode;
import org.apache.doris.common.ErrorReport;
import org.apache.doris.common.UserException;
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.StmtExecutor;
import org.apache.doris.qe.VariableMgr;

import org.apache.commons.lang3.StringUtils;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

/**
* UnSetVarOp
*/
public class UnsetVariableCommand extends Command implements Forward {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forward or ForwardWithSync?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forward, because it should be decided by toRedirectStatus

private static final Logger LOG = LogManager.getLogger(StmtExecutor.class);

private SetType setType;

// variable to restore
private String variable = null;

private boolean applyToAll = false;

public UnsetVariableCommand(SetType setType, String varName) {
super(PlanType.UNSET_VARIABLE_COMMAND);
this.setType = setType;
this.variable = varName;
}

public UnsetVariableCommand(SetType setType, boolean applyToAll) {
super(PlanType.UNSET_VARIABLE_COMMAND);
this.setType = setType;
this.applyToAll = applyToAll;
}

public SetType getSetType() {
return setType;
}

public String getVariable() {
return variable;
}

public boolean isApplyToAll() {
return applyToAll;
}

private void validate() throws UserException {
if (StringUtils.isEmpty(variable) && !applyToAll) {
throw new AnalysisException("You should specific the unset variable.");
}

if (setType == SetType.GLOBAL) {
if (!Env.getCurrentEnv().getAccessManager().checkGlobalPriv(ConnectContext.get(), PrivPredicate.ADMIN)) {
ErrorReport.reportAnalysisException(ErrorCode.ERR_SPECIFIC_ACCESS_DENIED_ERROR,
"ADMIN");
}
}
}

/**
* return sql expression of this command
* @return string of this command
*/
public String toSql() {
StringBuilder sb = new StringBuilder();

sb.append("UNSET ");
sb.append(setType).append(" VARIABLE ");
if (!StringUtils.isEmpty(variable)) {
sb.append(variable).append(" ");
} else if (applyToAll) {
sb.append("ALL");
}
return sb.toString();
}

@Override
public RedirectStatus toRedirectStatus() {
if (setType == SetType.GLOBAL) {
return RedirectStatus.FORWARD_WITH_SYNC;
}

return RedirectStatus.NO_FORWARD;
}

@Override
public void afterForwardToMaster(ConnectContext context) throws Exception {
if (isApplyToAll()) {
VariableMgr.setAllVarsToDefaultValue(context.getSessionVariable(), SetType.SESSION);
englefly marked this conversation as resolved.
Show resolved Hide resolved
} else {
String defaultValue = VariableMgr.getDefaultValue(getVariable());
if (defaultValue == null) {
ErrorReport.reportDdlException(ErrorCode.ERR_UNKNOWN_SYSTEM_VARIABLE, getVariable());
}
SetVar var = new SetVar(SetType.SESSION, getVariable(),
new StringLiteral(defaultValue), SetVar.SetVarType.SET_SESSION_VAR);
VariableMgr.setVar(context.getSessionVariable(), var);
}
}

@Override
public void run(ConnectContext ctx, StmtExecutor executor) throws Exception {
validate();
try {
if (isApplyToAll()) {
VariableMgr.setAllVarsToDefaultValue(ctx.getSessionVariable(), getSetType());
} else {
String defaultValue = VariableMgr.getDefaultValue(getVariable());
if (defaultValue == null) {
ErrorReport.reportDdlException(ErrorCode.ERR_UNKNOWN_SYSTEM_VARIABLE, getVariable());
}
SetVar var = new SetVar(getSetType(), getVariable(),
new StringLiteral(defaultValue), SetVar.SetVarType.SET_SESSION_VAR);
VariableMgr.setVar(ctx.getSessionVariable(), var);
}
} catch (DdlException e) {
LOG.warn("", e);
// Return error message to client.
ctx.getState().setError(ErrorCode.ERR_LOCAL_VARIABLE, e.getMessage() + toSql());
return;
}
ctx.getState().setOk();
}

@Override
public <R, C> R accept(PlanVisitor<R, C> visitor, C context) {
return visitor.visitUnsetVariableCommand(this, context);
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,8 @@
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.UnsetDefaultStorageVaultCommand;
import org.apache.doris.nereids.trees.plans.commands.UnsetVariableCommand;
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 @@ -198,6 +200,15 @@ default R visitUnsupportedCommand(UnsupportedCommand unsupportedCommand, C conte
return visitCommand(unsupportedCommand, context);
}

default R visitUnsetVariableCommand(UnsetVariableCommand unsetVariableCommand, C context) {
return visitCommand(unsetVariableCommand, context);
}

default R visitUnsetDefaultStorageVaultCommand(UnsetDefaultStorageVaultCommand unsetDefaultStorageVaultCommand,
C context) {
return visitCommand(unsetDefaultStorageVaultCommand, context);
}

default R visitCreateTableLikeCommand(CreateTableLikeCommand createTableLikeCommand, C context) {
return visitCommand(createTableLikeCommand, context);
}
Expand Down
Loading
Loading