Skip to content

Commit ebca42c

Browse files
knzknz
committed
New docs on expressions and constants
1 parent d3f9c83 commit ebca42c

19 files changed

+1421
-444
lines changed

‎_data/sidebar_doc.yml‎

Lines changed: 53 additions & 235 deletions
Original file line numberDiff line numberDiff line change
@@ -56,262 +56,80 @@ entries:
5656
- title: Install Client Drivers
5757
url: /install-client-drivers.html
5858

59-
thirdlevel:
60-
- title: SQL Statements
61-
thirdlevelitems:
62-
63-
- title: Overview
64-
url: /sql-statements.html
65-
66-
- title: <code>ADD COLUMN</code>
67-
url: /add-column.html
68-
69-
- title: <code>ADD CONSTRAINT</code>
70-
url: /add-constraint.html
71-
72-
- title: <code>ALTER COLUMN</code>
73-
url: /alter-column.html
74-
75-
- title: <code>ALTER TABLE</code>
76-
url: /alter-table.html
77-
78-
- title: <code>ALTER VIEW</code>
79-
url: /alter-view.html
80-
81-
- title: <code>BEGIN</code>
82-
url: /begin-transaction.html
83-
84-
- title: <code>COMMIT</code>
85-
url: /commit-transaction.html
86-
87-
- title: <code>CREATE DATABASE</code>
88-
url: /create-database.html
89-
90-
- title: <code>CREATE INDEX</code>
91-
url: /create-index.html
92-
93-
- title: <code>CREATE TABLE</code>
94-
url: /create-table.html
95-
96-
- title: <code>CREATE TABLE AS</code>
97-
url: /create-table-as.html
98-
99-
- title: <code>CREATE USER</code>
100-
url: /create-user.html
101-
102-
- title: <code>CREATE VIEW</code>
103-
url: /create-view.html
104-
105-
- title: <code>DELETE</code>
106-
url: /delete.html
107-
108-
- title: <code>DROP COLUMN</code>
109-
url: /drop-column.html
110-
111-
- title: <code>DROP CONSTRAINT</code>
112-
url: /drop-constraint.html
113-
114-
- title: <code>DROP DATABASE</code>
115-
url: /drop-database.html
116-
117-
- title: <code>DROP INDEX</code>
118-
url: /drop-index.html
119-
120-
- title: <code>DROP TABLE</code>
121-
url: /drop-table.html
122-
123-
- title: <code>DROP VIEW</code>
124-
url: /drop-view.html
125-
126-
- title: <code>EXPLAIN</code>
127-
url: /explain.html
128-
129-
- title: <code>GRANT</code>
130-
url: /grant.html
131-
132-
- title: <code>INSERT</code>
133-
url: /insert.html
134-
135-
- title: <code>RENAME COLUMN</code>
136-
url: /rename-column.html
137-
138-
- title: <code>RENAME DATABASE</code>
139-
url: /rename-database.html
140-
141-
- title: <code>RENAME INDEX</code>
142-
url: /rename-index.html
143-
144-
- title: <code>RENAME TABLE</code>
145-
url: /rename-table.html
146-
147-
- title: <code>RELEASE SAVEPOINT</code>
148-
url: /release-savepoint.html
149-
150-
- title: <code>REVOKE</code>
151-
url: /revoke.html
152-
153-
- title: <code>ROLLBACK</code>
154-
url: /rollback-transaction.html
155-
156-
- title: <code>SAVEPOINT</code>
157-
url: /savepoint.html
158-
159-
- title: <code>SELECT</code>
160-
url: /select.html
161-
162-
- title: <code>SET DATABASE</code>
163-
url: /set-database.html
164-
165-
- title: <code>SET TIME ZONE</code>
166-
url: /set-time-zone.html
59+
thirdlevel:
60+
- title: Program SQL queries
61+
thirdlevelitems:
16762

168-
- title: <code>SET TRANSACTION</code>
169-
url: /set-transaction.html
63+
- title: Keywords & Identifiers
64+
url: /keywords-and-identifiers.html
17065

171-
- title: <code>SHOW ALL</code>
172-
url: /show-all.html
66+
- title: Query and Update Statements
67+
url: /sql-statements.html#query-and-update-statements
17368

174-
- title: <code>SHOW COLUMNS</code>
175-
url: /show-columns.html
69+
- title: Table Expressions
70+
url: /table-expressions.html
17671

177-
- title: <code>SHOW CONSTRAINTS</code>
178-
url: /show-constraints.html
72+
- title: Constant Values
73+
url: /sql-constants.html
17974

180-
- title: <code>SHOW CREATE TABLE</code>
181-
url: /show-create-table.html
75+
- title: Value Expressions
76+
url: /sql-expressions.html
18277

183-
- title: <code>SHOW CREATE VIEW</code>
184-
url: /show-create-view.html
78+
- title: Built-in Functions and Operators
79+
url: /functions-and-operators.html
18580

186-
- title: <code>SHOW DATABASE</code>
187-
url: /show-database.html
81+
- title: Data Types
82+
url: /data-types.html
18883

189-
- title: <code>SHOW DATABASES</code>
190-
url: /show-databases.html
84+
- title: Information Schema
85+
url: /information-schema.html
19186

192-
- title: <code>SHOW GRANTS</code>
193-
url: /show-grants.html
87+
- title: SQL Grammar
88+
url: /sql-grammar.html
19489

195-
- title: <code>SHOW INDEX</code>
196-
url: /show-index.html
197-
198-
- title: <code>SHOW TABLES</code>
199-
url: /show-tables.html
200-
201-
- title: <code>SHOW TIME ZONE</code>
202-
url: /show-time-zone.html
203-
204-
- title: <code>SHOW TRANSACTION</code>
205-
url: /show-transaction.html
206-
207-
- title: <code>SHOW USERS</code>
208-
url: /show-users.html
209-
210-
- title: <code>TRUNCATE</code>
211-
url: /truncate.html
212-
213-
- title: <code>UPDATE</code>
214-
url: /update.html
215-
216-
- title: <code>UPSERT</code>
217-
url: /upsert.html
218-
219-
- title: SQL Grammar
220-
url: /sql-grammar.html
221-
222-
thirdlevel:
223-
- title: Constraints
224-
thirdlevelitems:
225-
226-
- title: Overview
227-
url: /constraints.html
228-
229-
- title: Check
230-
url: /check.html
231-
232-
- title: Default Value
233-
url: /default-value.html
234-
235-
- title: Foreign Keys
236-
url: /foreign-key.html
237-
238-
- title: Not Null
239-
url: /not-null.html
240-
241-
- title: Primary Key
242-
url: /primary-key.html
243-
244-
- title: Unique
245-
url: /unique.html
246-
247-
- title: Data Definition
248-
thirdlevelitems:
249-
250-
- title: Keywords & Identifiers
251-
url: /keywords-and-identifiers.html
252-
253-
- title: Indexes
254-
url: /indexes.html
255-
256-
- title: Views
257-
url: /views.html
258-
259-
- title: Column Families
260-
url: /column-families.html
261-
262-
- title: Interleaved Tables
263-
url: /interleave-in-parent.html
264-
265-
- title: <code>NULL</code> Handling
266-
url: /null-handling.html
267-
268-
- title: Data Types
269-
thirdlevelitems:
270-
271-
- title: Overview
272-
url: /data-types.html
90+
- title: Use Transactions
91+
url: /transactions.html
27392

274-
- title: <code>INT</code>
275-
url: /int.html
93+
thirdlevel:
94+
- title: Data Definition
95+
thirdlevelitems:
27696

277-
- title: <code>SERIAL</code>
278-
url: /serial.html
97+
- title: Data Definition Statements
98+
url: /sql-statements.html#data-definition-statements
27999

280-
- title: <code>DECIMAL</code>
281-
url: /decimal.html
100+
- title: Column Constraints
101+
url: /constraints.html
282102

283-
- title: <code>FLOAT</code>
284-
url: /float.html
103+
- title: Indexes
104+
url: /indexes.html
285105

286-
- title: <code>BOOL</code>
287-
url: /bool.html
106+
- title: Views
107+
url: /views.html
288108

289-
- title: <code>DATE</code>
290-
url: /date.html
109+
- title: Column Families
110+
url: /column-families.html
291111

292-
- title: <code>TIMESTAMP</code>
293-
url: /timestamp.html
112+
- title: Interleaved Tables
113+
url: /interleave-in-parent.html
294114

295-
- title: <code>INTERVAL</code>
296-
url: /interval.html
115+
- title: <code>NULL</code> Handling
116+
url: /null-handling.html
297117

298-
- title: <code>STRING</code>
299-
url: /string.html
118+
- title: Information Schema
119+
url: /information-schema.html
300120

301-
- title: <code>BYTES</code>
302-
url: /bytes.html
121+
thirdlevel:
122+
- title: Privileges
123+
thirdlevelitems:
303124

304-
- title: Privileges
305-
url: /privileges.html
306-
307-
- title: Functions and Operators
308-
url: /functions-and-operators.html
125+
- title: Overview
126+
url: /privileges.html
309127

310-
- title: Transactions
311-
url: /transactions.html
128+
- title: Privilege Management Statements
129+
url: /sql-statements.html#privilege-management-statements
312130

313-
- title: Information Schema
314-
url: /information-schema.html
131+
- title: Create and Manage Users
132+
url: /create-and-manage-users.html
315133

316134
- title: Deploy
317135
items:
@@ -346,7 +164,7 @@ entries:
346164

347165
- title: Overview
348166
url: /orchestration.html
349-
167+
350168
- title: Kubernetes
351169
url: /orchestrate-cockroachdb-with-kubernetes.html
352170

@@ -425,7 +243,7 @@ entries:
425243

426244
- title: SQL
427245
url: /sql.html
428-
246+
429247
- title: Distributed Transactions
430248
url: /distributed-transactions.html
431249

‎bool.md‎

Lines changed: 11 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -4,26 +4,29 @@ summary: The BOOL data type stores Boolean values of false or true.
44
toc: false
55
---
66

7-
The `BOOL` [data type](data-types.html) stores a Boolean value of `false` or `true`.
7+
The `BOOL` [data type](data-types.html) stores a Boolean value of `false` or `true`.
88

99
<div id="toc"></div>
1010

1111
## Aliases
1212

13-
In CockroachDB, `BOOLEAN` is an alias for `BOOL`.
13+
In CockroachDB, `BOOLEAN` is an alias for `BOOL`.
1414

15-
## Format
15+
## Syntax
1616

17-
When inserting into a `BOOL` column, format the value as `false` or `true` (case-insensitive).
17+
There are two predefined
18+
[named constants](sql-constants.html#named-constants) for `BOOL`:
19+
`TRUE` and `FALSE` (the names are case-insensitive).
1820

19-
Alternately, you can cast `0` or `1` as a `BOOL`:
21+
Alternately, a boolean value can be obtained by coercing a numeric
22+
value: zero is coerced to `FALSE`, and any non-zero value to `TRUE`.
2023

2124
- `CAST(0 AS BOOL)` (false)
22-
- `CAST(1 AS BOOL)` (true)
25+
- `CAST(123 AS BOOL)` (true)
2326

2427
## Size
2528

26-
A `BOOL` value is 1 byte in width, but the total storage size is likely to be larger due to CockroachDB metadata.
29+
A `BOOL` value is 1 byte in width, but the total storage size is likely to be larger due to CockroachDB metadata.
2730

2831
## Examples
2932

@@ -69,4 +72,4 @@ Type | Details
6972

7073
## See Also
7174

72-
[Data Types](data-types.html)
75+
[Data Types](data-types.html)

0 commit comments

Comments
 (0)