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.

Sign up for GitHub

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

sql: add a SET CLUSTER SETTING sql.defaults deprecation notice #80548

Merged
merged 1 commit into from
May 16, 2022
Merged

sql: add a SET CLUSTER SETTING sql.defaults deprecation notice #80548

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
6 changes: 6 additions & 0 deletions pkg/ccl/backupccl/testdata/backup-restore/multiregion
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,8 @@ DROP DATABASE no_region_db_2;
exec-sql
SET CLUSTER SETTING sql.defaults.primary_region = 'non-existent-region';
----
NOTICE: setting global default sql.defaults.primary_region is not recommended
HINT: use the `ALTER ROLE ... SET` syntax to control session variable defaults at a finer-grained level. See: https://www.cockroachlabs.com/docs/v22.1/alter-role.html#set-default-session-variable-values-for-a-role

exec-sql
RESTORE DATABASE no_region_db FROM LATEST IN 'nodelocal://1/no_region_database_backup/';
Expand All @@ -107,6 +109,8 @@ set the default PRIMARY REGION to a region that exists (see SHOW REGIONS FROM CL
exec-sql
SET CLUSTER SETTING sql.defaults.primary_region = 'eu-central-1';
----
NOTICE: setting global default sql.defaults.primary_region is not recommended
HINT: use the `ALTER ROLE ... SET` syntax to control session variable defaults at a finer-grained level. See: https://www.cockroachlabs.com/docs/v22.1/alter-role.html#set-default-session-variable-values-for-a-role

exec-sql
RESTORE DATABASE no_region_db FROM LATEST IN 'nodelocal://1/no_region_database_backup/';
Expand Down Expand Up @@ -146,6 +150,8 @@ new-server name=s4 share-io-dir=s1 allow-implicit-access localities=eu-central-1
exec-sql
SET CLUSTER SETTING sql.defaults.primary_region = 'eu-north-1';
----
NOTICE: setting global default sql.defaults.primary_region is not recommended
HINT: use the `ALTER ROLE ... SET` syntax to control session variable defaults at a finer-grained level. See: https://www.cockroachlabs.com/docs/v22.1/alter-role.html#set-default-session-variable-values-for-a-role

exec-sql
RESTORE FROM LATEST IN 'nodelocal://1/no_region_cluster_backup/';
Expand Down
14 changes: 14 additions & 0 deletions pkg/sql/set_cluster_setting.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@ import (
"time"

"github.com/cockroachdb/cockroach/pkg/clusterversion"
"github.com/cockroachdb/cockroach/pkg/docs"
"github.com/cockroachdb/cockroach/pkg/kv"
"github.com/cockroachdb/cockroach/pkg/roachpb"
"github.com/cockroachdb/cockroach/pkg/security"
Expand All @@ -31,6 +32,7 @@ import (
"github.com/cockroachdb/cockroach/pkg/sql/paramparse"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgcode"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgerror"
"github.com/cockroachdb/cockroach/pkg/sql/pgwire/pgnotice"
"github.com/cockroachdb/cockroach/pkg/sql/roleoption"
"github.com/cockroachdb/cockroach/pkg/sql/sem/tree"
"github.com/cockroachdb/cockroach/pkg/sql/sessiondata"
Expand Down Expand Up @@ -193,6 +195,18 @@ func (p *planner) getAndValidateTypedClusterSetting(
}

func (n *setClusterSettingNode) startExec(params runParams) error {

if strings.HasPrefix(n.name, "sql.defaults") {
params.p.BufferClientNotice(
params.ctx,
errors.WithHintf(
pgnotice.Newf("setting global default %s is not recommended", n.name),
"use the `ALTER ROLE ... SET` syntax to control session variable defaults at a finer-grained level. See: %s",
docs.URL("alter-role.html#set-default-session-variable-values-for-a-role"),
),
)
}

if !params.extendedEvalCtx.TxnIsSingleStmt {
return errors.Errorf("SET CLUSTER SETTING cannot be used inside a multi-statement transaction")
}
Expand Down