Merge #68352

68352: sql: gate DateStyle behind datestyle_enabled session variable r=rafiss a=otan See individual commits for details. Co-authored-by: Oliver Tan <[email protected]>
cockroachdb · Aug 8, 2021 · 049ed14 · 049ed14
2 parents cab185f + 6b543ce
commit 049ed14
Show file tree

Hide file tree

Showing 20 changed files with 334 additions and 81 deletions.
diff --git a/docs/generated/settings/settings-for-tenants.txt b/docs/generated/settings/settings-for-tenants.txt
@@ -72,6 +72,7 @@ sql.cross_db_sequence_owners.enabled	boolean	false	if true, creating sequences o
 sql.cross_db_views.enabled	boolean	false	if true, creating views that refer to other databases is allowed
 sql.defaults.copy_partitioning_when_deinterleaving_table.enabled	boolean	false	default value for enable_copying_partitioning_when_deinterleaving_table session variable
 sql.defaults.datestyle	enumeration	iso, mdy	default value for DateStyle session setting [iso, mdy = 0, iso, dmy = 1, iso, ymd = 2]
+sql.defaults.datestyle.enabled	boolean	false	default value for datestyle_enabled session setting
 sql.defaults.default_int_size	integer	8	the size, in bytes, of an INT type
 sql.defaults.disallow_full_table_scans.enabled	boolean	false	setting to true rejects queries that have planned a full table scan
 sql.defaults.distsql	enumeration	auto	default distributed SQL execution mode [off = 0, auto = 1, on = 2]
@@ -92,7 +93,7 @@ sql.defaults.implicit_select_for_update.enabled	boolean	true	default value for e
 sql.defaults.insert_fast_path.enabled	boolean	true	default value for enable_insert_fast_path session setting; enables a specialized insert path
 sql.defaults.interleaved_tables.enabled	boolean	false	allows creation of interleaved tables or indexes
 sql.defaults.intervalstyle	enumeration	postgres	default value for IntervalStyle session setting [postgres = 0, iso_8601 = 1, sql_standard = 2]
-sql.defaults.intervalstyle.enabled	boolean	false	default value for enable_intervalstyle session setting
+sql.defaults.intervalstyle.enabled	boolean	false	default value for intervalstyle_enabled session setting
 sql.defaults.locality_optimized_partitioned_index_scan.enabled	boolean	true	default value for locality_optimized_partitioned_index_scan session setting; enables searching for rows in the current region before searching remote regions
 sql.defaults.optimizer_use_histograms.enabled	boolean	true	default value for optimizer_use_histograms session setting; enables usage of histograms in the optimizer by default
 sql.defaults.optimizer_use_multicol_stats.enabled	boolean	true	default value for optimizer_use_multicol_stats session setting; enables usage of multi-column stats in the optimizer by default

diff --git a/docs/generated/settings/settings.html b/docs/generated/settings/settings.html
@@ -76,6 +76,7 @@
 <tr><td><code>sql.cross_db_views.enabled</code></td><td>boolean</td><td><code>false</code></td><td>if true, creating views that refer to other databases is allowed</td></tr>
 <tr><td><code>sql.defaults.copy_partitioning_when_deinterleaving_table.enabled</code></td><td>boolean</td><td><code>false</code></td><td>default value for enable_copying_partitioning_when_deinterleaving_table session variable</td></tr>
 <tr><td><code>sql.defaults.datestyle</code></td><td>enumeration</td><td><code>iso, mdy</code></td><td>default value for DateStyle session setting [iso, mdy = 0, iso, dmy = 1, iso, ymd = 2]</td></tr>
+<tr><td><code>sql.defaults.datestyle.enabled</code></td><td>boolean</td><td><code>false</code></td><td>default value for datestyle_enabled session setting</td></tr>
 <tr><td><code>sql.defaults.default_int_size</code></td><td>integer</td><td><code>8</code></td><td>the size, in bytes, of an INT type</td></tr>
 <tr><td><code>sql.defaults.disallow_full_table_scans.enabled</code></td><td>boolean</td><td><code>false</code></td><td>setting to true rejects queries that have planned a full table scan</td></tr>
 <tr><td><code>sql.defaults.distsql</code></td><td>enumeration</td><td><code>auto</code></td><td>default distributed SQL execution mode [off = 0, auto = 1, on = 2]</td></tr>
@@ -96,7 +97,7 @@
 <tr><td><code>sql.defaults.insert_fast_path.enabled</code></td><td>boolean</td><td><code>true</code></td><td>default value for enable_insert_fast_path session setting; enables a specialized insert path</td></tr>
 <tr><td><code>sql.defaults.interleaved_tables.enabled</code></td><td>boolean</td><td><code>false</code></td><td>allows creation of interleaved tables or indexes</td></tr>
 <tr><td><code>sql.defaults.intervalstyle</code></td><td>enumeration</td><td><code>postgres</code></td><td>default value for IntervalStyle session setting [postgres = 0, iso_8601 = 1, sql_standard = 2]</td></tr>
-<tr><td><code>sql.defaults.intervalstyle.enabled</code></td><td>boolean</td><td><code>false</code></td><td>default value for enable_intervalstyle session setting</td></tr>
+<tr><td><code>sql.defaults.intervalstyle.enabled</code></td><td>boolean</td><td><code>false</code></td><td>default value for intervalstyle_enabled session setting</td></tr>
 <tr><td><code>sql.defaults.locality_optimized_partitioned_index_scan.enabled</code></td><td>boolean</td><td><code>true</code></td><td>default value for locality_optimized_partitioned_index_scan session setting; enables searching for rows in the current region before searching remote regions</td></tr>
 <tr><td><code>sql.defaults.optimizer_use_histograms.enabled</code></td><td>boolean</td><td><code>true</code></td><td>default value for optimizer_use_histograms session setting; enables usage of histograms in the optimizer by default</td></tr>
 <tr><td><code>sql.defaults.optimizer_use_multicol_stats.enabled</code></td><td>boolean</td><td><code>true</code></td><td>default value for optimizer_use_multicol_stats session setting; enables usage of multi-column stats in the optimizer by default</td></tr>

diff --git a/pkg/sql/conn_executor.go b/pkg/sql/conn_executor.go
@@ -2416,6 +2416,7 @@ func (ex *connExecutor) resetPlanner(
 	p.semaCtx = tree.MakeSemaContext()
 	p.semaCtx.SearchPath = ex.sessionData.SearchPath
 	p.semaCtx.IntervalStyleEnabled = ex.sessionData.IntervalStyleEnabled
+	p.semaCtx.DateStyleEnabled = ex.sessionData.DateStyleEnabled
 	p.semaCtx.Annotations = nil
 	p.semaCtx.TypeResolver = p
 	p.semaCtx.TableNameResolver = p

diff --git a/pkg/sql/exec_util.go b/pkg/sql/exec_util.go
@@ -542,11 +542,20 @@ var dateStyle = settings.RegisterEnumSetting(
 ).WithPublic()
 
 // intervalStyleEnabled controls intervals representation.
-// TODO(#sql-experience): remove session setting in v21.1 and have this
+// TODO(#sql-experience): remove session setting in v22.1 and have this
 // always enabled.
 var intervalStyleEnabled = settings.RegisterBoolSetting(
 	"sql.defaults.intervalstyle.enabled",
-	"default value for enable_intervalstyle session setting",
+	"default value for intervalstyle_enabled session setting",
+	false,
+).WithPublic()
+
+// dateStyleEnabled controls dates representation.
+// TODO(#sql-experience): remove session setting in v22.1 and have this
+// always enabled.
+var dateStyleEnabled = settings.RegisterBoolSetting(
+	"sql.defaults.datestyle.enabled",
+	"default value for datestyle_enabled session setting",
 	false,
 ).WithPublic()
 
@@ -2629,6 +2638,11 @@ func (m *sessionDataMutator) SetIntervalStyleEnabled(enabled bool) {
 	m.data.IntervalStyleEnabled = enabled
 }
 
+// SetDateStyleEnabled sets the DateStyleEnabled for the given session.
+func (m *sessionDataMutator) SetDateStyleEnabled(enabled bool) {
+	m.data.DateStyleEnabled = enabled
+}
+
 // SetStubCatalogTablesEnabled sets default value for stub_catalog_tables.
 func (m *sessionDataMutator) SetStubCatalogTablesEnabled(enabled bool) {
 	m.data.StubCatalogTablesEnabled = enabled

diff --git a/pkg/sql/logictest/testdata/logic_test/datetime b/pkg/sql/logictest/testdata/logic_test/datetime
@@ -1766,6 +1766,45 @@ true
 
 subtest datestyle_order
 
+statement error setting DateStyle is not enabled
+set datestyle = 'dmy'
+
+statement error setting DateStyle is not enabled
+set datestyle = 'ymd'
+
+statement ok
+set datestyle_enabled = true
+
+statement error context-dependent operators are not allowed in computed column\nHINT: TIMESTAMP to STRING casts are dependent on DateStyle; consider using to_char\(timestamp\) instead\.
+CREATE TABLE invalid_table (
+  invalid_col string AS ('2020-05-12 10:12:13'::timestamp::string) STORED
+)
+
+statement error context-dependent operators are not allowed in computed column\nHINT: DATE to STRING casts are dependent on DateStyle; consider using to_char\(date\) instead\.
+CREATE TABLE invalid_table (
+  invalid_col string AS ('2020-05-12 10:12:13'::date::string) STORED
+)
+
+statement error context-dependent operators are not allowed in computed column\nHINT: STRING to TIMESTAMP casts are context-dependent because of relative timestamp strings like 'now' and session settings such as DateStyle; use parse_timestamp\(string\) instead\.
+CREATE TABLE invalid_table (
+  invalid_col timestamp AS ('2020-05-12 10:12:13'::string::timestamp) STORED
+)
+
+statement error context-dependent operators are not allowed in computed column\nHINT: STRING to DATE casts depend on session DateStyle; use parse_date\(string\) instead
+CREATE TABLE invalid_table (
+  invalid_col date AS ('2020-05-12 10:12:13'::string::date) STORED
+)
+
+statement error context-dependent operators are not allowed in computed column\nHINT: STRING to TIME casts depend on session DateStyle; use parse_time\(string\) instead
+CREATE TABLE invalid_table (
+  invalid_col time AS ('2020-05-12 10:12:13'::string::time) STORED
+)
+
+statement error context-dependent operators are not allowed in computed column\nHINT: STRING to TIMETZ casts depend on session DateStyle; use parse_timetz\(string\) instead
+CREATE TABLE invalid_table (
+  invalid_col timetz AS ('2020-05-12 10:12:13'::string::timetz) STORED
+)
+
 statement ok
 set datestyle = 'dmy'
 

diff --git a/pkg/sql/logictest/testdata/logic_test/information_schema b/pkg/sql/logictest/testdata/logic_test/information_schema
@@ -4517,6 +4517,7 @@ client_encoding                                        UTF8
 client_min_messages                                    notice
 database                                               test
 datestyle                                              ISO, MDY
+datestyle_enabled                                      off
 default_int_size                                       8
 default_tablespace                                     ·
 default_transaction_isolation                          serializable

diff --git a/pkg/sql/logictest/testdata/logic_test/pg_catalog b/pkg/sql/logictest/testdata/logic_test/pg_catalog
@@ -3836,6 +3836,7 @@ client_encoding                                        UTF8                NULL
 client_min_messages                                    notice              NULL      NULL        NULL        string
 database                                               test                NULL      NULL        NULL        string
 datestyle                                              ISO, MDY            NULL      NULL        NULL        string
+datestyle_enabled                                      off                 NULL      NULL        NULL        string
 default_int_size                                       8                   NULL      NULL        NULL        string
 default_tablespace                                     ·                   NULL      NULL        NULL        string
 default_transaction_isolation                          serializable        NULL      NULL        NULL        string
@@ -3922,6 +3923,7 @@ client_encoding                                        UTF8                NULL
 client_min_messages                                    notice              NULL  user     NULL      notice              notice
 database                                               test                NULL  user     NULL      ·                   test
 datestyle                                              ISO, MDY            NULL  user     NULL      ISO, MDY            ISO, MDY
+datestyle_enabled                                      off                 NULL  user     NULL      off                 off
 default_int_size                                       8                   NULL  user     NULL      8                   8
 default_tablespace                                     ·                   NULL  user     NULL      ·                   ·
 default_transaction_isolation                          serializable        NULL  user     NULL      default             default
@@ -4004,6 +4006,7 @@ client_min_messages                                    NULL    NULL     NULL
 crdb_version                                           NULL    NULL     NULL     NULL        NULL
 database                                               NULL    NULL     NULL     NULL        NULL
 datestyle                                              NULL    NULL     NULL     NULL        NULL
+datestyle_enabled                                      NULL    NULL     NULL     NULL        NULL
 default_int_size                                       NULL    NULL     NULL     NULL        NULL
 default_tablespace                                     NULL    NULL     NULL     NULL        NULL
 default_transaction_isolation                          NULL    NULL     NULL     NULL        NULL

diff --git a/pkg/sql/logictest/testdata/logic_test/set b/pkg/sql/logictest/testdata/logic_test/set
@@ -171,6 +171,9 @@ SHOW datestyle
 ----
 ISO, MDY
 
+statement ok
+SET datestyle_enabled = true
+
 statement ok
 SET datestyle = 'ymd'
 

diff --git a/pkg/sql/logictest/testdata/logic_test/show_source b/pkg/sql/logictest/testdata/logic_test/show_source
@@ -33,6 +33,7 @@ client_encoding                                        UTF8
 client_min_messages                                    notice
 database                                               test
 datestyle                                              ISO, MDY
+datestyle_enabled                                      off
 default_int_size                                       8
 default_tablespace                                     ·
 default_transaction_isolation                          serializable

diff --git a/pkg/sql/opt/memo/memo.go b/pkg/sql/opt/memo/memo.go
@@ -141,6 +141,7 @@ type Memo struct {
 	safeUpdates             bool
 	preferLookupJoinsForFKs bool
 	saveTablesPrefix        string
+	dateStyleEnabled        bool
 	intervalStyleEnabled    bool
 	dateStyle               pgdate.DateStyle
 	intervalStyle           duration.IntervalStyle
@@ -183,6 +184,7 @@ func (m *Memo) Init(evalCtx *tree.EvalContext) {
 		preferLookupJoinsForFKs: evalCtx.SessionData.PreferLookupJoinsForFKs,
 		saveTablesPrefix:        evalCtx.SessionData.SaveTablesPrefix,
 		intervalStyleEnabled:    evalCtx.SessionData.IntervalStyleEnabled,
+		dateStyleEnabled:        evalCtx.SessionData.DateStyleEnabled,
 		dateStyle:               evalCtx.SessionData.GetDateStyle(),
 		intervalStyle:           evalCtx.SessionData.GetIntervalStyle(),
 	}
@@ -294,6 +296,7 @@ func (m *Memo) IsStale(
 		m.preferLookupJoinsForFKs != evalCtx.SessionData.PreferLookupJoinsForFKs ||
 		m.saveTablesPrefix != evalCtx.SessionData.SaveTablesPrefix ||
 		m.intervalStyleEnabled != evalCtx.SessionData.IntervalStyleEnabled ||
+		m.dateStyleEnabled != evalCtx.SessionData.DateStyleEnabled ||
 		m.dateStyle != evalCtx.SessionData.GetDateStyle() ||
 		m.intervalStyle != evalCtx.SessionData.GetIntervalStyle() {
 		return true, nil

diff --git a/pkg/sql/opt/memo/memo_test.go b/pkg/sql/opt/memo/memo_test.go
@@ -224,6 +224,12 @@ func TestMemoIsStale(t *testing.T) {
 	evalCtx.SessionData.IntervalStyleEnabled = false
 	notStale()
 
+	// Stale dateStyleEnabled.
+	evalCtx.SessionData.DateStyleEnabled = true
+	stale()
+	evalCtx.SessionData.DateStyleEnabled = false
+	notStale()
+
 	// Stale DateStyle.
 	evalCtx.SessionData.DataConversionConfig.DateStyle = pgdate.DateStyle{Order: pgdate.Order_YMD}
 	stale()

diff --git a/pkg/sql/pgwire/testdata/pgtest/param_status b/pkg/sql/pgwire/testdata/pgtest/param_status
@@ -100,6 +100,23 @@ ReadyForQuery
 {"Type":"CommandComplete","CommandTag":"SET"}
 {"Type":"ReadyForQuery","TxStatus":"I"}
 
+send
+Query {"String": "SET DateStyle_enabled = true"}
+----
+
+until crdb_only
+ReadyForQuery
+----
+{"Type":"CommandComplete","CommandTag":"SET"}
+{"Type":"ReadyForQuery","TxStatus":"I"}
+
+until noncrdb_only
+ErrorResponse
+ReadyForQuery
+----
+{"Type":"ErrorResponse","Code":"42704"}
+{"Type":"ReadyForQuery","TxStatus":"I"}
+
 send
 Query {"String": "SET DateStyle = 'YMD, ISO'"}
 ----

diff --git a/pkg/sql/planner.go b/pkg/sql/planner.go
@@ -340,6 +340,7 @@ func newInternalPlanner(
 	p.semaCtx = tree.MakeSemaContext()
 	p.semaCtx.SearchPath = sd.SearchPath
 	p.semaCtx.IntervalStyleEnabled = sd.IntervalStyleEnabled
+	p.semaCtx.DateStyleEnabled = sd.DateStyleEnabled
 	p.semaCtx.TypeResolver = p
 	p.semaCtx.DateStyle = sd.GetDateStyle()
 	p.semaCtx.IntervalStyle = sd.GetIntervalStyle()