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,opt: add cluster and session settings for locality optimized search #60771

Merged
merged 1 commit into from
Feb 20, 2021
Merged

sql,opt: add cluster and session settings for locality optimized search #60771

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
16 changes: 16 additions & 0 deletions pkg/sql/exec_util.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -286,6 +286,18 @@ var optUseMultiColStatsClusterMode = settings.RegisterBoolSetting(
true,
)

// localityOptimizedSearchMode controls the cluster default for the use of
// locality optimized search. If enabled, the optimizer will try to plan scans
// and lookup joins in which local nodes (i.e., nodes in the gateway region) are
// searched for matching rows before remote nodes, in the hope that the
// execution engine can avoid visiting remote nodes.
var localityOptimizedSearchMode = settings.RegisterBoolSetting(
"sql.defaults.locality_optimized_partitioned_index_scan.enabled",
"default value for locality_optimized_partitioned_index_scan session setting; "+
"enables searching for rows in the current region before searching remote regions",
false,
)

var implicitSelectForUpdateClusterMode = settings.RegisterBoolSetting(
"sql.defaults.implicit_select_for_update.enabled",
"default value for enable_implicit_select_for_update session setting; enables FOR UPDATE locking during the row-fetch phase of mutation statements",
Expand Down Expand Up @@ -2192,6 +2204,10 @@ func (m *sessionDataMutator) SetOptimizerUseMultiColStats(val bool) {
m.data.OptimizerUseMultiColStats = val
}

func (m *sessionDataMutator) SetLocalityOptimizedSearch(val bool) {
m.data.LocalityOptimizedSearch = val
}

func (m *sessionDataMutator) SetImplicitSelectForUpdate(val bool) {
m.data.ImplicitSelectForUpdate = val
}
Expand Down
1 change: 1 addition & 0 deletions pkg/sql/logictest/testdata/logic_test/information_schema
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3462,6 +3462,7 @@ idle_in_transaction_session_timeout 0
integer_datetimes on
intervalstyle postgres
locality region=test,dc=dc1
locality_optimized_partitioned_index_scan off
lock_timeout 0
max_identifier_length 128
max_index_keys 32
Expand Down
3 changes: 3 additions & 0 deletions pkg/sql/logictest/testdata/logic_test/pg_catalog
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2017,6 +2017,7 @@ idle_in_transaction_session_timeout 0 NULL
integer_datetimes on NULL NULL NULL string
intervalstyle postgres NULL NULL NULL string
locality region=test,dc=dc1 NULL NULL NULL string
locality_optimized_partitioned_index_scan off NULL NULL NULL string
lock_timeout 0 NULL NULL NULL string
max_identifier_length 128 NULL NULL NULL string
max_index_keys 32 NULL NULL NULL string
Expand Down Expand Up @@ -2094,6 +2095,7 @@ idle_in_transaction_session_timeout 0 NULL
integer_datetimes on NULL user NULL on on
intervalstyle postgres NULL user NULL postgres postgres
locality region=test,dc=dc1 NULL user NULL region=test,dc=dc1 region=test,dc=dc1
locality_optimized_partitioned_index_scan off NULL user NULL off off
lock_timeout 0 NULL user NULL 0 0
max_identifier_length 128 NULL user NULL 128 128
max_index_keys 32 NULL user NULL 32 32
Expand Down Expand Up @@ -2167,6 +2169,7 @@ idle_in_transaction_session_timeout NULL NULL NULL
integer_datetimes NULL NULL NULL NULL NULL
intervalstyle NULL NULL NULL NULL NULL
locality NULL NULL NULL NULL NULL
locality_optimized_partitioned_index_scan NULL NULL NULL NULL NULL
lock_timeout NULL NULL NULL NULL NULL
max_identifier_length NULL NULL NULL NULL NULL
max_index_keys NULL NULL NULL NULL NULL
Expand Down
1 change: 1 addition & 0 deletions pkg/sql/logictest/testdata/logic_test/show_source
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@ idle_in_transaction_session_timeout 0
integer_datetimes on
intervalstyle postgres
locality region=test,dc=dc1
locality_optimized_partitioned_index_scan off
lock_timeout 0
max_identifier_length 128
max_index_keys 32
Expand Down
3 changes: 3 additions & 0 deletions pkg/sql/opt/memo/memo.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,7 @@ type Memo struct {
zigzagJoinEnabled bool
useHistograms bool
useMultiColStats bool
localityOptimizedSearch bool
safeUpdates bool
preferLookupJoinsForFKs bool
saveTablesPrefix string
Expand Down Expand Up @@ -173,6 +174,7 @@ func (m *Memo) Init(evalCtx *tree.EvalContext) {
zigzagJoinEnabled: evalCtx.SessionData.ZigzagJoinEnabled,
useHistograms: evalCtx.SessionData.OptimizerUseHistograms,
useMultiColStats: evalCtx.SessionData.OptimizerUseMultiColStats,
localityOptimizedSearch: evalCtx.SessionData.LocalityOptimizedSearch,
safeUpdates: evalCtx.SessionData.SafeUpdates,
preferLookupJoinsForFKs: evalCtx.SessionData.PreferLookupJoinsForFKs,
saveTablesPrefix: evalCtx.SessionData.SaveTablesPrefix,
Expand Down Expand Up @@ -281,6 +283,7 @@ func (m *Memo) IsStale(
m.zigzagJoinEnabled != evalCtx.SessionData.ZigzagJoinEnabled ||
m.useHistograms != evalCtx.SessionData.OptimizerUseHistograms ||
m.useMultiColStats != evalCtx.SessionData.OptimizerUseMultiColStats ||
m.localityOptimizedSearch != evalCtx.SessionData.LocalityOptimizedSearch ||
m.safeUpdates != evalCtx.SessionData.SafeUpdates ||
m.preferLookupJoinsForFKs != evalCtx.SessionData.PreferLookupJoinsForFKs ||
m.saveTablesPrefix != evalCtx.SessionData.SaveTablesPrefix {
Expand Down
6 changes: 6 additions & 0 deletions pkg/sql/opt/memo/memo_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,12 @@ func TestMemoIsStale(t *testing.T) {
evalCtx.SessionData.OptimizerUseMultiColStats = false
notStale()

// Stale locality optimized search enable.
evalCtx.SessionData.LocalityOptimizedSearch = true
stale()
evalCtx.SessionData.LocalityOptimizedSearch = false
notStale()

// Stale safe updates.
evalCtx.SessionData.SafeUpdates = true
stale()
Expand Down
1 change: 1 addition & 0 deletions pkg/sql/opt/optbuilder/builder_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ func TestBuilder(t *testing.T) {
evalCtx := tree.MakeTestingEvalContext(cluster.MakeTestingClusterSettings())
evalCtx.SessionData.OptimizerUseHistograms = true
evalCtx.SessionData.OptimizerUseMultiColStats = true
evalCtx.SessionData.LocalityOptimizedSearch = true

var o xform.Optimizer
o.Init(&evalCtx, catalog)
Expand Down
1 change: 1 addition & 0 deletions pkg/sql/opt/testutils/opttester/opt_tester.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -244,6 +244,7 @@ func New(catalog cat.Catalog, sql string) *OptTester {
ot.evalCtx.SessionData.ZigzagJoinEnabled = true
ot.evalCtx.SessionData.OptimizerUseHistograms = true
ot.evalCtx.SessionData.OptimizerUseMultiColStats = true
ot.evalCtx.SessionData.LocalityOptimizedSearch = true
ot.evalCtx.SessionData.ReorderJoinsLimit = opt.DefaultJoinOrderLimit
ot.evalCtx.SessionData.InsertFastPath = true

Expand Down
5 changes: 5 additions & 0 deletions pkg/sql/sessiondata/session_data.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,11 @@ type LocalOnlySessionData struct {
// OptimizerUseMultiColStats indicates whether we should use multi-column
// statistics for cardinality estimation in the optimizer.
OptimizerUseMultiColStats bool
// LocalityOptimizedSearch indicates that the optimizer will try to plan scans
// and lookup joins in which local nodes (i.e., nodes in the gateway region)
// are searched for matching rows before remote nodes, in the hope that the
// execution engine can avoid visiting remote nodes.
LocalityOptimizedSearch bool
// SafeUpdates causes errors when the client
// sends syntax that may have unwanted side effects.
SafeUpdates bool
Expand Down
19 changes: 19 additions & 0 deletions pkg/sql/vars.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -673,6 +673,25 @@ var varGen = map[string]sessionVar{
},
},

// CockroachDB extension.
`locality_optimized_partitioned_index_scan`: {
GetStringVal: makePostgresBoolGetStringValFn(`locality_optimized_partitioned_index_scan`),
Set: func(_ context.Context, m *sessionDataMutator, s string) error {
b, err := paramparse.ParseBoolVar(`locality_optimized_partitioned_index_scan`, s)
if err != nil {
return err
}
m.SetLocalityOptimizedSearch(b)
return nil
},
Get: func(evalCtx *extendedEvalContext) string {
return formatBoolAsPostgresSetting(evalCtx.SessionData.LocalityOptimizedSearch)
},
GlobalDefault: func(sv *settings.Values) string {
return formatBoolAsPostgresSetting(localityOptimizedSearchMode.Get(sv))
},
},

// CockroachDB extension.
`enable_implicit_select_for_update`: {
GetStringVal: makePostgresBoolGetStringValFn(`enable_implicit_select_for_update`),
Expand Down