[Feat](Nereids) support unset command #43103
There are no files selected for viewing
This file contains 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 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 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 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,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. | ||
| 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); | ||
| } | ||
| } | ||
This file contains 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,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 { | ||
|
There was a problem hiding this comment. Forward or ForwardWithSync? There was a problem hiding this comment. Forward, because it should be decided by toRedirectStatus |
||
| private static final Logger LOG = LogManager.getLogger(StmtExecutor.class); | ||
|
|
||
| private SetType setType; | ||
|
|
||
| // variables to restore | ||
|
There was a problem hiding this comment. why plural？does this command unset one variable or a set of “variables”？ There was a problem hiding this comment. only one variable can be unset at one time, nice check |
||
| 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); | ||
| } | ||
| } | ||
This file contains 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
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.
vault => value?
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.
storage vault is a word group