Merge cockroachdb#38815

38815: opt: add Index.PartitionByListPrefixes to catalog r=RaduBerinde a=RaduBerinde

#### opt: add EXPLAIN (OPT, CATALOG)

Adding a `CATALOG` flag to `EXPLAIN (OPT)` which also formats all the
cat.Table objects. This is useful for testing the opt_catalog
implementation.

Release note: None

#### opt: add Index.PartitionByListPrefixes to catalog

Add a catalog function that returns index regions of interest based on
PARTITION BY LIST values. This information will be used for an "index
skip scan".

Informs cockroachdb#38031.

Release note: None


Co-authored-by: Radu Berinde <radu@cockroachlabs.com>

pkg/ccl/logictestccl/testdata/logic_test/partitioning

@@ -1,4 +1,4 @@
-# LogicTest: local
+# LogicTest: local-opt
 
 statement error syntax
 CREATE TABLE t (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST ()
@@ -399,6 +399,21 @@ ok1  CREATE TABLE ok1 (
    PARTITION p2 VALUES IN ((2))
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok1
+----
+TABLE ok1
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           ├── (1)
+           └── (2)
+scan ok1
+
 statement ok
 CREATE TABLE ok2 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a) (
     PARTITION p1 VALUES IN ((1)),
@@ -419,6 +434,21 @@ ok2  CREATE TABLE ok2 (
    PARTITION p2 VALUES IN ((2))
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok2
+----
+TABLE ok2
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           ├── (1)
+           └── (2)
+scan ok2
+
 statement ok
 CREATE TABLE ok3 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a) (
     PARTITION p1 VALUES IN (1),
@@ -439,6 +469,20 @@ ok3  CREATE TABLE ok3 (
    PARTITION p2 VALUES IN ((DEFAULT))
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok3
+----
+TABLE ok3
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           └── (1)
+scan ok3
+
 statement ok
 CREATE TABLE ok4 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a, b) (
     PARTITION p1 VALUES IN ((1, 1)),
@@ -463,6 +507,22 @@ ok4  CREATE TABLE ok4 (
    PARTITION p4 VALUES IN ((DEFAULT, DEFAULT))
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok4
+----
+TABLE ok4
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           ├── (1, 1)
+           ├── (1)
+           └── (2, 3)
+scan ok4
+
 statement ok
 CREATE TABLE ok5 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a) (
     PARTITION p1 VALUES IN (1) PARTITION BY LIST (b) (
@@ -475,6 +535,21 @@ CREATE TABLE ok5 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a)
     PARTITION p3 VALUES IN (DEFAULT)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok5
+----
+TABLE ok5
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           ├── (1)
+           └── (2)
+scan ok5
+
 query TT
 SHOW CREATE TABLE ok5
 ----
@@ -515,6 +590,18 @@ ok6  CREATE TABLE ok6 (
    PARTITION p2 VALUES FROM (1) TO (2)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok6
+----
+TABLE ok6
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      └── b int not null
+scan ok6
+
 statement ok
 CREATE TABLE ok7 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY RANGE (a) (
     PARTITION p1 VALUES FROM ((0)) TO (((1)))
@@ -533,6 +620,18 @@ ok7  CREATE TABLE ok7 (
    PARTITION p1 VALUES FROM (0) TO (1)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok7
+----
+TABLE ok7
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      └── b int not null
+scan ok7
+
 statement ok
 CREATE TABLE ok8 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY RANGE (a) (
     PARTITION p1 VALUES FROM (MINVALUE) TO (1),
@@ -555,6 +654,18 @@ ok8  CREATE TABLE ok8 (
    PARTITION p3 VALUES FROM (2) TO (MAXVALUE)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok8
+----
+TABLE ok8
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      └── b int not null
+scan ok8
+
 statement ok
 CREATE TABLE ok9 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY RANGE (a, b) (
     PARTITION p1 VALUES FROM (MINVALUE, MINVALUE) TO (1, MAXVALUE),
@@ -579,6 +690,18 @@ ok9  CREATE TABLE ok9 (
    PARTITION p4 VALUES FROM (3, MAXVALUE) TO (MAXVALUE, MAXVALUE)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok9
+----
+TABLE ok9
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      └── b int not null
+scan ok9
+
 statement ok
 CREATE TABLE ok10 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY RANGE (a, b) (
     PARTITION p1 VALUES FROM (MINVALUE, MINVALUE) TO (1, 1),
@@ -605,6 +728,18 @@ ok10  CREATE TABLE ok10 (
    PARTITION p5 VALUES FROM (3, 4) TO (MAXVALUE, MAXVALUE)
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok10
+----
+TABLE ok10
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      └── b int not null
+scan ok10
+
 statement ok
 CREATE TABLE ok11 (a INT, b INT, c INT, PRIMARY KEY (a, b, c)) PARTITION BY LIST (a) (
     PARTITION p1 VALUES IN (1) PARTITION BY LIST (b) (
@@ -639,6 +774,22 @@ ok11  CREATE TABLE ok11 (
    )
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok11
+----
+TABLE ok11
+ ├── a int not null
+ ├── b int not null
+ ├── c int not null
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      ├── c int not null
+      └── partition by list prefixes
+           ├── (1)
+           └── (6)
+scan ok11
+
 statement ok
 CREATE TABLE IF NOT EXISTS ok12 (a INT, b INT, c INT, PRIMARY KEY (a, b)) PARTITION BY LIST (a) (
     PARTITION pu VALUES IN (NULL),
@@ -662,6 +813,22 @@ ok12  CREATE TABLE ok12 (
    PARTITION p2 VALUES IN ((2))
 )
 
+query T
+EXPLAIN (OPT, CATALOG) SELECT * from ok12
+----
+TABLE ok12
+ ├── a int not null
+ ├── b int not null
+ ├── c int
+ └── INDEX primary
+      ├── a int not null
+      ├── b int not null
+      └── partition by list prefixes
+           ├── (NULL)
+           ├── (1)
+           └── (2)
+scan ok12
+
 # Verify that creating a partition that includes NULL does not change the
 # implicit NOT NULL contrainst of a primary key.
 statement error null value in column "a" violates not-null constraint