forked from cockroachdb/docs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathsidebar_doc.yml
578 lines (392 loc) · 16.3 KB
/
sidebar_doc.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
# This is your sidebar TOC. The sidebar code loops through sections here and provides the appropriate formatting.
# Sidebar
entries:
- title: Sidebar
subcategories:
- title: Get Started
items:
- title: Install CockroachDB
url: /install-cockroachdb.html
thirdlevel:
- title: Start a Cluster
thirdlevelitems:
- title: From Binary
url: /start-a-local-cluster.html
- title: In Docker
url: /start-a-local-cluster-in-docker.html
- title: Secure a Cluster
url: /secure-a-cluster.html
thirdlevel:
- title: Learn CockroachDB SQL
thirdlevelitems:
- title: Essential SQL Statements
url: /learn-cockroachdb-sql.html
- title: Use the Built-in SQL Client
url: /use-the-built-in-sql-client.html
- title: Build an App
thirdlevelitems:
- title: Overview
url: /build-an-app-with-cockroachdb.html
- title: Go
url: /build-a-go-app-with-cockroachdb.html
alternate_urls: [/build-a-go-app-with-cockroachdb-gorm.html]
- title: Python
url: /build-a-python-app-with-cockroachdb.html
alternate_urls: [/build-a-python-app-with-cockroachdb-sqlalchemy.html]
- title: Ruby
url: /build-a-ruby-app-with-cockroachdb.html
alternate_urls: [/build-a-ruby-app-with-cockroachdb-activerecord.html]
- title: Java
url: /build-a-java-app-with-cockroachdb.html
alternate_urls: [/build-a-java-app-with-cockroachdb-hibernate.html]
- title: Node.js
url: /build-a-nodejs-app-with-cockroachdb.html
alternate_urls: [/build-a-nodejs-app-with-cockroachdb-sequelize.html]
- title: C++
url: /build-a-c++-app-with-cockroachdb.html
- title: Clojure
url: /build-a-clojure-app-with-cockroachdb.html
- title: PHP
url: /build-a-php-app-with-cockroachdb.html
- title: Rust
url: /build-a-rust-app-with-cockroachdb.html
- title: Explore Core Features
thirdlevelitems:
- title: Data Replication
url: /demo-data-replication.html
- title: Fault Tolerance & Recovery
url: /demo-fault-tolerance-and-recovery.html
- title: Automatic Rebalancing
url: /demo-automatic-rebalancing.html
- title: Develop
items:
- title: Install Client Drivers
url: /install-client-drivers.html
- title: SQL Feature Support
url: /sql-feature-support.html
thirdlevel:
- title: SQL Statements
thirdlevelitems:
- title: Overview
url: /sql-statements.html
- title: <code>ADD COLUMN</code>
url: /add-column.html
- title: <code>ADD CONSTRAINT</code>
url: /add-constraint.html
- title: <code>ALTER COLUMN</code>
url: /alter-column.html
- title: <code>ALTER TABLE</code>
url: /alter-table.html
- title: <code>ALTER VIEW</code>
url: /alter-view.html
- title: <code>BACKUP</code> (Enterprise)
url: /backup.html
- title: <code>BEGIN</code>
url: /begin-transaction.html
- title: <code>COMMIT</code>
url: /commit-transaction.html
- title: <code>CREATE DATABASE</code>
url: /create-database.html
- title: <code>CREATE INDEX</code>
url: /create-index.html
- title: <code>CREATE TABLE</code>
url: /create-table.html
- title: <code>CREATE TABLE AS</code>
url: /create-table-as.html
- title: <code>CREATE USER</code>
url: /create-user.html
- title: <code>CREATE VIEW</code>
url: /create-view.html
- title: <code>DELETE</code>
url: /delete.html
- title: <code>DROP COLUMN</code>
url: /drop-column.html
- title: <code>DROP CONSTRAINT</code>
url: /drop-constraint.html
- title: <code>DROP DATABASE</code>
url: /drop-database.html
- title: <code>DROP INDEX</code>
url: /drop-index.html
- title: <code>DROP TABLE</code>
url: /drop-table.html
- title: <code>DROP VIEW</code>
url: /drop-view.html
- title: <code>EXPLAIN</code>
url: /explain.html
- title: <code>GRANT</code>
url: /grant.html
- title: <code>INSERT</code>
url: /insert.html
- title: <code>RENAME COLUMN</code>
url: /rename-column.html
- title: <code>RENAME DATABASE</code>
url: /rename-database.html
- title: <code>RENAME INDEX</code>
url: /rename-index.html
- title: <code>RENAME TABLE</code>
url: /rename-table.html
- title: <code>RELEASE SAVEPOINT</code>
url: /release-savepoint.html
- title: <code>RESTORE</code> (Enterprise)
url: /restore.html
- title: <code>REVOKE</code>
url: /revoke.html
- title: <code>ROLLBACK</code>
url: /rollback-transaction.html
- title: <code>SAVEPOINT</code>
url: /savepoint.html
- title: <code>SELECT</code>
url: /select.html
- title: <code>SET DATABASE</code>
url: /set-database.html
- title: <code>SET TIME ZONE</code>
url: /set-time-zone.html
- title: <code>SET TRANSACTION</code>
url: /set-transaction.html
- title: <code>SHOW ALL</code>
url: /show-all.html
- title: <code>SHOW COLUMNS</code>
url: /show-columns.html
- title: <code>SHOW CONSTRAINTS</code>
url: /show-constraints.html
- title: <code>SHOW CREATE TABLE</code>
url: /show-create-table.html
- title: <code>SHOW CREATE VIEW</code>
url: /show-create-view.html
- title: <code>SHOW DATABASE</code>
url: /show-database.html
- title: <code>SHOW DATABASES</code>
url: /show-databases.html
- title: <code>SHOW GRANTS</code>
url: /show-grants.html
- title: <code>SHOW INDEX</code>
url: /show-index.html
- title: <code>SHOW TABLES</code>
url: /show-tables.html
- title: <code>SHOW TIME ZONE</code>
url: /show-time-zone.html
- title: <code>SHOW TRANSACTION</code>
url: /show-transaction.html
- title: <code>SHOW USERS</code>
url: /show-users.html
- title: <code>TRUNCATE</code>
url: /truncate.html
- title: <code>UPDATE</code>
url: /update.html
- title: <code>UPSERT</code>
url: /upsert.html
- title: SQL Syntax
thirdlevelitems:
- title: Keywords & Identifiers
url: /keywords-and-identifiers.html
- title: Constants
url: /sql-constants.html
- title: Value Expressions
url: /sql-expressions.html
- title: Table Expressions
url: /table-expressions.html
- title: Name Resolution
url: /sql-name-resolution.html
- title: Full SQL Grammar
url: /sql-grammar.html
- title: Constraints
thirdlevelitems:
- title: Overview
url: /constraints.html
- title: Check
url: /check.html
- title: Default Value
url: /default-value.html
- title: Foreign Key
url: /foreign-key.html
- title: Not Null
url: /not-null.html
- title: Primary Key
url: /primary-key.html
- title: Unique
url: /unique.html
- title: Data Definition
thirdlevelitems:
- title: Indexes
url: /indexes.html
- title: Views
url: /views.html
- title: Column Families
url: /column-families.html
- title: Interleaved Tables
url: /interleave-in-parent.html
- title: <code>NULL</code> Handling
url: /null-handling.html
- title: Data Types
thirdlevelitems:
- title: Overview
url: /data-types.html
- title: <code>INT</code>
url: /int.html
- title: <code>SERIAL</code>
url: /serial.html
- title: <code>DECIMAL</code>
url: /decimal.html
- title: <code>FLOAT</code>
url: /float.html
- title: <code>BOOL</code>
url: /bool.html
- title: <code>DATE</code>
url: /date.html
- title: <code>TIMESTAMP</code>
url: /timestamp.html
- title: <code>INTERVAL</code>
url: /interval.html
- title: <code>STRING</code>
url: /string.html
- title: <code>COLLATE</code>
url: /collate.html
- title: <code>BYTES</code>
url: /bytes.html
- title: Privileges
url: /privileges.html
- title: Functions and Operators
url: /functions-and-operators.html
- title: Transactions
url: /transactions.html
- title: Information Schema
url: /information-schema.html
thirdlevel:
- title: Porting Applications
thirdlevelitems:
- title: From PostgreSQL
url: /porting-postgres.html
- title: Deploy
items:
- title: Recommended Production Settings
url: /recommended-production-settings.html
- title: Manual Deployment
url: /manual-deployment.html
alternate_urls: [/manual-deployment-insecure.html]
thirdlevel:
- title: Cloud Deployment
thirdlevelitems:
- title: Overview
url: /cloud-deployment.html
- title: AWS
url: /deploy-cockroachdb-on-aws.html
alternate_urls: [/deploy-cockroachdb-on-aws-insecure.html]
- title: Azure
url: /deploy-cockroachdb-on-microsoft-azure.html
alternate_urls: [/deploy-cockroachdb-on-microsoft-azure-insecure.html]
- title: Digital Ocean
url: /deploy-cockroachdb-on-digital-ocean.html
alternate_urls: [/deploy-cockroachdb-on-digital-ocean-insecure.html]
- title: Google Cloud Platform GCE
url: /deploy-cockroachdb-on-google-cloud-platform.html
alternate_urls: [/deploy-cockroachdb-on-google-cloud-platform-insecure.html]
- title: Orchestration
thirdlevelitems:
- title: Overview
url: /orchestration.html
- title: Kubernetes
url: /orchestrate-cockroachdb-with-kubernetes.html
- title: Docker Swarm
url: /orchestrate-cockroachdb-with-docker-swarm.html
alternate_urls: [/orchestrate-cockroachdb-with-docker-swarm-insecure.html]
- title: Cluster Settings
url: /cluster-settings.html
- title: Cockroach Commands
url: /cockroach-commands.html
- title: Start a Node
url: /start-a-node.html
- title: Stop a Node
url: /stop-a-node.html
- title: Create Security Certificates
url: /create-security-certificates.html
- title: Create & Manage Users
url: /create-and-manage-users.html
- title: Configure Replication Zones
url: /configure-replication-zones.html
- title: Manage
items:
- title: Explore the Admin UI
url: /explore-the-admin-ui.html
- title: Monitor CockroachDB with Prometheus
url: /monitor-cockroachdb-with-prometheus.html
- title: View Node Details
url: /view-node-details.html
- title: View Version Details
url: /view-version-details.html
- title: Upgrade a Cluster's Version
url: /upgrade-cockroach-version.html
- title: Back up Data
url: /back-up-data.html
- title: Restore Data
url: /restore-data.html
- title: Dump/Export Schema or Data
url: /sql-dump.html
- title: Import Data
url: /import-data.html
- title: Generate CockroachDB Resources
url: /generate-cockroachdb-resources.html
- title: Diagnostics Reporting
url: /diagnostics-reporting.html
- title: Troubleshoot
items:
- title: Overview
url: /troubleshooting-overview.html
- title: General Troubleshooting
url: /general-troubleshooting.html
- title: Cluster & Node Setup
url: /cluster-setup-troubleshooting.html
- title: Query Behavior
url: /query-behavior-troubleshooting.html
- title: Debug & Error Logs
url: /debug-and-error-logs.html
- title: Support Resources
url: /support-resources.html
- title: File an Issue
url: /file-an-issue.html
- title: Contribute
items:
- title: Contribute to CockroachDB
url: /contribute-to-cockroachdb.html
- title: Improve the Docs
url: /improve-the-docs.html
- title: Releases
items:
- title: 1.0.1
url: /v1.0.1.html
- title: 1.0
url: /v1.0.html
- title: All Releases
url: /releases.html
- title: FAQs
items:
- title: Product FAQs
url: /frequently-asked-questions.html
- title: SQL FAQs
url: /sql-faqs.html
- title: Operational FAQs
url: /operational-faqs.html
- title: CockroachDB in Comparison
url: /cockroachdb-in-comparison.html
- title: CockroachDB Architecture
url: /cockroachdb-architecture.html
thirdlevel:
- title: CockroachDB Features
thirdlevelitems:
- title: Simplified Deployment
url: /simplified-deployment.html
- title: Strong Consistency
url: /strong-consistency.html
- title: SQL
url: /sql.html
- title: Distributed Transactions
url: /distributed-transactions.html
- title: Automated Scaling & Repair
url: /automated-scaling-and-repair.html
- title: High Availability
url: /high-availability.html
- title: Open Source
url: /open-source.html
- title: Go Implementation
url: /go-implementation.html
- title: Known Limitations
url: /known-limitations.html