Skip to content

Commit 508a565

Browse files
author
Jesse Seldess
committed
Update SHOW INDEX docs
- Add Implicit column to all examples - Other minor fixes Fixes cockroachdb#1201
1 parent 35c3ce2 commit 508a565

6 files changed

+181
-168
lines changed

‎create-index.md

+8-7
Original file line numberDiff line numberDiff line change
@@ -107,13 +107,14 @@ Normally, CockroachDB selects the index that it calculates will scan the fewest
107107
> SHOW INDEX FROM products;
108108
~~~
109109
~~~
110-
+----------+--------------------+--------+-----+--------+-----------+---------+
111-
| Table | Name | Unique | Seq | Column | Direction | Storing |
112-
+----------+--------------------+--------+-----+--------+-----------+---------+
113-
| products | primary | true | 1 | id | ASC | false |
114-
| products | products_price_idx | false | 1 | name | N/A | true |
115-
| products | products_price_idx | false | 2 | price | ASC | false |
116-
+----------+--------------------+--------+-----+--------+-----------+---------+
110+
+----------+--------------------+--------+-----+--------+-----------+---------+----------+
111+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
112+
+----------+--------------------+--------+-----+--------+-----------+---------+----------+
113+
| products | primary | true | 1 | id | ASC | false | false |
114+
| products | products_price_idx | false | 1 | price | ASC | false | false |
115+
| products | products_price_idx | false | 2 | id | ASC | false | true |
116+
+----------+--------------------+--------+-----+--------+-----------+---------+----------+
117+
(3 rows)
117118
~~~
118119
~~~ sql
119120
> SELECT name FROM products@products_price_idx WHERE price > 10;

‎create-table.md

+34-39
Original file line numberDiff line numberDiff line change
@@ -74,35 +74,30 @@ In CockroachDB, every table requires a [primary key](primary-key.html). If one i
7474
user_id INT,
7575
logon_date DATE
7676
);
77-
~~~
78-
79-
~~~
80-
CREATE TABLE
81-
~~~
8277

83-
~~~ sql
8478
> SHOW COLUMNS FROM logon;
8579
~~~
8680

8781
~~~
88-
+------------+------+-------+----------------+
89-
| Field | Type | Null | Default |
90-
+------------+------+-------+----------------+
91-
| user_id | INT | true | NULL |
92-
| logon_date | DATE | true | NULL |
93-
| rowid | INT | false | unique_rowid() |
94-
+------------+------+-------+----------------+
95-
(3 rows)
82+
+------------+------+------+---------+---------+
83+
| Field | Type | Null | Default | Indices |
84+
+------------+------+------+---------+---------+
85+
| user_id | INT | true | NULL | {} |
86+
| logon_date | DATE | true | NULL | {} |
87+
+------------+------+------+---------+---------+
88+
(2 rows)
9689
~~~
90+
9791
~~~ sql
9892
> SHOW INDEX FROM logon;
9993
~~~
94+
10095
~~~
101-
+-------+---------+--------+-----+--------+-----------+---------+
102-
| Table | Name | Unique | Seq | Column | Direction | Storing |
103-
+-------+---------+--------+-----+--------+-----------+---------+
104-
| logon | primary | true | 1 | rowid | ASC | false |
105-
+-------+---------+--------+-----+--------+-----------+---------+
96+
+-------+---------+--------+-----+--------+-----------+---------+----------+
97+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
98+
+-------+---------+--------+-----+--------+-----------+---------+----------+
99+
| logon | primary | true | 1 | rowid | ASC | false | false |
100+
+-------+---------+--------+-----+--------+-----------+---------+----------+
106101
(1 row)
107102
~~~
108103

@@ -116,13 +111,7 @@ In this example, we create a table with three columns. One column is the [primar
116111
user_email STRING UNIQUE,
117112
logoff_date DATE
118113
);
119-
~~~
120-
121-
~~~
122-
CREATE TABLE
123-
~~~
124114

125-
~~~ sql
126115
> SHOW COLUMNS FROM logoff;
127116
~~~
128117

@@ -177,18 +166,23 @@ In this example, we create two secondary indexes during table creation. Secondar
177166

178167
> SHOW INDEX FROM product_information;
179168
~~~
169+
180170
~~~
181-
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+
182-
| Table | Name | Unique | Seq | Column | Direction | Storing |
183-
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+
184-
| product_information | primary | true | 1 | product_id | ASC | false |
185-
| product_information | product_information_product_name_key | true | 1 | product_name | ASC | false |
186-
| product_information | product_information_catalog_url_key | true | 1 | catalog_url | ASC | false |
187-
| product_information | date_added_idx | false | 1 | date_added | ASC | false |
188-
| product_information | supp_id_prod_status_idx | false | 1 | supplier_id | ASC | false |
189-
| product_information | supp_id_prod_status_idx | false | 2 | product_status | ASC | false |
190-
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+
191-
(6 rows)
171+
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+----------+
172+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
173+
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+----------+
174+
| product_information | primary | true | 1 | product_id | ASC | false | false |
175+
| product_information | product_information_product_name_key | true | 1 | product_name | ASC | false | false |
176+
| product_information | product_information_product_name_key | true | 2 | product_id | ASC | false | true |
177+
| product_information | product_information_catalog_url_key | true | 1 | catalog_url | ASC | false | false |
178+
| product_information | product_information_catalog_url_key | true | 2 | product_id | ASC | false | true |
179+
| product_information | date_added_idx | false | 1 | date_added | ASC | false | false |
180+
| product_information | date_added_idx | false | 2 | product_id | ASC | false | true |
181+
| product_information | supp_id_prod_status_idx | false | 1 | supplier_id | ASC | false | false |
182+
| product_information | supp_id_prod_status_idx | false | 2 | product_status | ASC | false | false |
183+
| product_information | supp_id_prod_status_idx | false | 3 | product_id | ASC | false | true |
184+
+---------------------+--------------------------------------+--------+-----+----------------+-----------+---------+----------+
185+
(10 rows)
192186
~~~
193187

194188
We also have other resources on indexes:
@@ -202,16 +196,16 @@ To auto-generate unique row IDs, use the [`SERIAL`](serial.html) data type, whic
202196

203197
~~~ sql
204198
> CREATE TABLE test (
205-
id SERIAL PRIMARY KEY,
199+
id SERIAL PRIMARY KEY,
206200
name STRING
207201
);
208202
~~~
209203

210-
On insert, the `unique_rowid()` function generates a default value from the timestamp and ID of the node executing the insert, a combination that is likely to be globally unique except in extreme cases where a very large number of IDs (100,000+) are generated per node per second. In such cases, you should use a [`BYTES`](bytes.html) column with the `uuid_v4()` function as the default value instead:
204+
On insert, the `unique_rowid()` function generates a default value from the timestamp and ID of the node executing the insert, a combination that is likely to be globally unique except in extreme cases where a very large number of IDs (100,000+) are generated per node per second. In such cases, you should use a [`BYTES`](bytes.html) column with the `uuid_v4()` function as the default value instead:
211205

212206
~~~ sql
213207
> CREATE TABLE test (
214-
id BYTES PRIMARY KEY DEFAULT uuid_v4(),
208+
id BYTES PRIMARY KEY DEFAULT uuid_v4(),
215209
name STRING
216210
);
217211
~~~
@@ -271,6 +265,7 @@ To show the definition of a table, use the [`SHOW CREATE TABLE`](show-create-tab
271265
~~~ sql
272266
> SHOW CREATE TABLE logoff;
273267
~~~
268+
274269
~~~
275270
+--------+----------------------------------------------------------+
276271
| Table | CreateTable |

‎drop-index.md

+27-22
Original file line numberDiff line numberDiff line change
@@ -32,25 +32,28 @@ The user must have the `CREATE` [privilege](privileges.html) on each specified t
3232
~~~ sql
3333
> SHOW INDEX FROM tbl;
3434
~~~
35-
~~~
36-
+-------+------------+--------+-----+--------+-----------+---------+
37-
| Table | Name | Unique | Seq | Column | Direction | Storing |
38-
+-------+------------+--------+-----+--------+-----------+---------+
39-
| tbl | primary | true | 1 | id | ASC | false |
40-
| tbl | index_name | false | 1 | name | ASC | false |
41-
+-------+------------+--------+-----+--------+-----------+---------+
35+
~~~
36+
+-------+--------------+--------+-----+--------+-----------+---------+----------+
37+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
38+
+-------+--------------+--------+-----+--------+-----------+---------+----------+
39+
| tbl | primary | true | 1 | id | ASC | false | false |
40+
| tbl | tbl_name_idx | false | 1 | name | ASC | false | false |
41+
| tbl | tbl_name_idx | false | 2 | id | ASC | false | true |
42+
+-------+--------------+--------+-----+--------+-----------+---------+----------+
43+
(3 rows)
4244
~~~
4345
~~~ sql
44-
> DROP INDEX tbl@index_name;
46+
> DROP INDEX tbl@tbl_name_idx;
4547

4648
> SHOW INDEX FROM tbl;
4749
~~~
48-
~~~
49-
+-------+---------+--------+-----+--------+-----------+---------+
50-
| Table | Name | Unique | Seq | Column | Direction | Storing |
51-
+-------+---------+--------+-----+--------+-----------+---------+
52-
| tbl | primary | true | 1 | id | ASC | false |
53-
+-------+---------+--------+-----+--------+-----------+---------+
50+
~~~
51+
+-------+---------+--------+-----+--------+-----------+---------+----------+
52+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
53+
+-------+---------+--------+-----+--------+-----------+---------+----------+
54+
| tbl | primary | true | 1 | id | ASC | false | false |
55+
+-------+---------+--------+-----+--------+-----------+---------+----------+
56+
(1 row)
5457
~~~
5558

5659
### Remove an Index and Dependent Objects with `CASCADE`
@@ -60,18 +63,20 @@ The user must have the `CREATE` [privilege](privileges.html) on each specified t
6063
~~~ sql
6164
> SHOW INDEX FROM orders;
6265
~~~
63-
~~~
64-
+--------+---------------------+--------+-----+----------+-----------+---------+
65-
| Table | Name | Unique | Seq | Column | Direction | Storing |
66-
+--------+---------------------+--------+-----+----------+-----------+---------+
67-
| orders | primary | true | 1 | id | ASC | false |
68-
| orders | orders_customer_idx | false | 1 | customer | ASC | false |
69-
+--------+---------------------+--------+-----+----------+-----------+---------+
66+
~~~
67+
+--------+---------------------+--------+-----+----------+-----------+---------+----------+
68+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
69+
+--------+---------------------+--------+-----+----------+-----------+---------+----------+
70+
| orders | primary | true | 1 | id | ASC | false | false |
71+
| orders | orders_customer_idx | false | 1 | customer | ASC | false | false |
72+
| orders | orders_customer_idx | false | 2 | id | ASC | false | true |
73+
+--------+---------------------+--------+-----+----------+-----------+---------+----------+
74+
(3 rows)
7075
~~~
7176
~~~ sql
7277
> DROP INDEX orders@orders_customer_idx;
7378
~~~
74-
~~~
79+
~~~
7580
pq: index "orders_customer_idx" is in use as a foreign key constraint
7681
~~~
7782
~~~ sql

‎rename-index.md

+19-12
Original file line numberDiff line numberDiff line change
@@ -35,26 +35,33 @@ The user must have the `CREATE` [privilege](privileges.html) on the table.
3535
> SHOW INDEXES FROM users;
3636
~~~
3737
~~~
38-
+-------+----------------+--------+-----+--------+-----------+---------+
39-
| Table | Name | Unique | Seq | Column | Direction | Storing |
40-
+-------+----------------+--------+-----+--------+-----------+---------+
41-
| users | primary | true | 1 | id | ASC | false |
42-
| users | users_name_idx | false | 1 | name | ASC | false |
43-
+-------+----------------+--------+-----+--------+-----------+---------+
38+
+-------+----------------+--------+-----+--------+-----------+---------+----------+
39+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
40+
+-------+----------------+--------+-----+--------+-----------+---------+----------+
41+
| users | primary | true | 1 | id | ASC | false | false |
42+
| users | users_name_idx | false | 1 | name | ASC | false | false |
43+
| users | users_name_idx | false | 2 | id | ASC | false | true |
44+
+-------+----------------+--------+-----+--------+-----------+---------+----------+
45+
(3 rows)
4446
~~~
4547
~~~ sql
4648
> ALTER INDEX users@users_name_idx RENAME TO name_idx;
4749
~~~
50+
~~~
51+
RENAME INDEX
52+
~~~
4853
~~~ sql
4954
> SHOW INDEXES FROM users;
5055
~~~
5156
~~~
52-
+-------+----------+--------+-----+--------+-----------+---------+
53-
| Table | Name | Unique | Seq | Column | Direction | Storing |
54-
+-------+----------+--------+-----+--------+-----------+---------+
55-
| users | primary | true | 1 | id | ASC | false |
56-
| users | name_idx | false | 1 | name | ASC | false |
57-
+-------+----------+--------+-----+--------+-----------+---------+
57+
+-------+----------+--------+-----+--------+-----------+---------+----------+
58+
| Table | Name | Unique | Seq | Column | Direction | Storing | Implicit |
59+
+-------+----------+--------+-----+--------+-----------+---------+----------+
60+
| users | primary | true | 1 | id | ASC | false | false |
61+
| users | name_idx | false | 1 | name | ASC | false | false |
62+
| users | name_idx | false | 2 | id | ASC | false | true |
63+
+-------+----------+--------+-----+--------+-----------+---------+----------+
64+
(3 rows)
5865
~~~
5966

6067
## See Also

0 commit comments

Comments
 (0)