github.com/cockroachdb/cockroachdb-parser@v0.23.3-0.20240213214944-911057d40c9a/pkg/sql/parser/help_messages.go (about) 1 // Code generated by help.awk. DO NOT EDIT. 2 // GENERATED FILE DO NOT EDIT 3 4 package parser 5 6 var helpMessages = map[string]HelpMessageBody{ 7 //line sql.y: 1817 8 `ALTER`: { 9 //line sql.y: 1818 10 Category: hGroup, 11 //line sql.y: 1819 12 Text: `ALTER TABLE, ALTER INDEX, ALTER VIEW, ALTER SEQUENCE, ALTER DATABASE, ALTER USER, ALTER ROLE, ALTER DEFAULT PRIVILEGES 13 `, 14 }, 15 //line sql.y: 1844 16 `ALTER TABLE`: { 17 ShortDescription: `change the definition of a table`, 18 //line sql.y: 1845 19 Category: hDDL, 20 //line sql.y: 1846 21 Text: ` 22 ALTER TABLE [IF EXISTS] <tablename> <command> [, ...] 23 24 Commands: 25 ALTER TABLE ... ADD [COLUMN] [IF NOT EXISTS] <colname> <type> [<qualifiers...>] 26 ALTER TABLE ... ADD <constraint> 27 ALTER TABLE ... DROP [COLUMN] [IF EXISTS] <colname> [RESTRICT | CASCADE] 28 ALTER TABLE ... DROP CONSTRAINT [IF EXISTS] <constraintname> [RESTRICT | CASCADE] 29 ALTER TABLE ... ALTER [COLUMN] <colname> {SET DEFAULT <expr> | DROP DEFAULT} 30 ALTER TABLE ... ALTER [COLUMN] <colname> {SET ON UPDATE <expr> | DROP ON UPDATE} 31 ALTER TABLE ... ALTER [COLUMN] <colname> DROP NOT NULL 32 ALTER TABLE ... ALTER [COLUMN] <colname> DROP STORED 33 ALTER TABLE ... ALTER [COLUMN] <colname> [SET DATA] TYPE <type> [COLLATE <collation>] 34 ALTER TABLE ... ALTER PRIMARY KEY USING COLUMNS ( <colnames...> ) 35 ALTER TABLE ... RENAME TO <newname> 36 ALTER TABLE ... RENAME [COLUMN] <colname> TO <newname> 37 ALTER TABLE ... VALIDATE CONSTRAINT <constraintname> 38 ALTER TABLE ... SET (storage_param = value, ...) 39 ALTER TABLE ... SPLIT AT <selectclause> [WITH EXPIRATION <expr>] 40 ALTER TABLE ... UNSPLIT AT <selectclause> 41 ALTER TABLE ... UNSPLIT ALL 42 ALTER TABLE ... SCATTER [ FROM ( <exprs...> ) TO ( <exprs...> ) ] 43 ALTER TABLE ... INJECT STATISTICS ... (experimental) 44 ALTER TABLE ... RELOCATE [ LEASE | VOTERS | NONVOTERS ] <selectclause> (experimental) 45 ALTER TABLE ... PARTITION BY RANGE ( <name...> ) ( <rangespec> ) 46 ALTER TABLE ... PARTITION BY LIST ( <name...> ) ( <listspec> ) 47 ALTER TABLE ... PARTITION BY NOTHING 48 ALTER TABLE ... CONFIGURE ZONE <zoneconfig> 49 ALTER TABLE ... SET SCHEMA <newschemaname> 50 ALTER TABLE ... SET LOCALITY [REGIONAL BY [TABLE IN <region> | ROW] | GLOBAL] 51 52 Column qualifiers: 53 [CONSTRAINT <constraintname>] {NULL | NOT NULL | UNIQUE | PRIMARY KEY | CHECK (<expr>) | DEFAULT <expr>} 54 FAMILY <familyname>, CREATE [IF NOT EXISTS] FAMILY [<familyname>] 55 REFERENCES <tablename> [( <colnames...> )] 56 COLLATE <collationname> 57 58 Zone configurations: 59 DISCARD 60 USING <var> = <expr> [, ...] 61 USING <var> = COPY FROM PARENT [, ...] 62 { TO | = } <expr> 63 64 `, 65 //line sql.y: 1889 66 SeeAlso: `WEBDOCS/alter-table.html 67 `, 68 }, 69 //line sql.y: 1905 70 `ALTER PARTITION`: { 71 ShortDescription: `apply zone configurations to a partition`, 72 //line sql.y: 1906 73 Category: hDDL, 74 //line sql.y: 1907 75 Text: ` 76 ALTER PARTITION <name> <command> 77 78 Commands: 79 -- Alter a single partition which exists on any of a table's indexes. 80 ALTER PARTITION <partition> OF TABLE <tablename> CONFIGURE ZONE <zoneconfig> 81 82 -- Alter a partition of a specific index. 83 ALTER PARTITION <partition> OF INDEX <tablename>@<indexname> CONFIGURE ZONE <zoneconfig> 84 85 -- Alter all partitions with the same name across a table's indexes. 86 ALTER PARTITION <partition> OF INDEX <tablename>@* CONFIGURE ZONE <zoneconfig> 87 88 Zone configurations: 89 DISCARD 90 USING <var> = <expr> [, ...] 91 USING <var> = COPY FROM PARENT [, ...] 92 { TO | = } <expr> 93 94 `, 95 //line sql.y: 1926 96 SeeAlso: `WEBDOCS/configure-zone.html 97 `, 98 }, 99 //line sql.y: 1931 100 `ALTER VIEW`: { 101 ShortDescription: `change the definition of a view`, 102 //line sql.y: 1932 103 Category: hDDL, 104 //line sql.y: 1933 105 Text: ` 106 ALTER [MATERIALIZED] VIEW [IF EXISTS] <name> RENAME TO <newname> 107 ALTER [MATERIALIZED] VIEW [IF EXISTS] <name> SET SCHEMA <newschemaname> 108 `, 109 //line sql.y: 1936 110 SeeAlso: `WEBDOCS/alter-view.html 111 `, 112 }, 113 //line sql.y: 1945 114 `ALTER SEQUENCE`: { 115 ShortDescription: `change the definition of a sequence`, 116 //line sql.y: 1946 117 Category: hDDL, 118 //line sql.y: 1947 119 Text: ` 120 ALTER SEQUENCE [IF EXISTS] <name> 121 [AS <typename>] 122 [INCREMENT <increment>] 123 [MINVALUE <minvalue> | NO MINVALUE] 124 [MAXVALUE <maxvalue> | NO MAXVALUE] 125 [START [WITH] <start>] 126 [RESTART [[WITH] <restart>]] 127 [[NO] CYCLE] 128 ALTER SEQUENCE [IF EXISTS] <name> RENAME TO <newname> 129 ALTER SEQUENCE [IF EXISTS] <name> SET SCHEMA <newschemaname> 130 `, 131 }, 132 //line sql.y: 1976 133 `ALTER DATABASE`: { 134 ShortDescription: `change the definition of a database`, 135 //line sql.y: 1977 136 Category: hDDL, 137 //line sql.y: 1978 138 Text: ` 139 ALTER DATABASE <name> RENAME TO <newname> 140 ALTER DATABASE <name> CONFIGURE ZONE <zone config> 141 ALTER DATABASE <name> OWNER TO <newowner> 142 ALTER DATABASE <name> CONVERT TO SCHEMA WITH PARENT <name> 143 ALTER DATABASE <name> ADD REGION [IF NOT EXISTS] <region> 144 ALTER DATABASE <name> DROP REGION [IF EXISTS] <region> 145 ALTER DATABASE <name> PRIMARY REGION <region> 146 ALTER DATABASE <name> SURVIVE <failure type> 147 ALTER DATABASE <name> PLACEMENT { RESTRICTED | DEFAULT } 148 ALTER DATABASE <name> SET var { TO | = } { value | DEFAULT } 149 ALTER DATABASE <name> RESET { var | ALL } 150 ALTER DATABASE <name> ALTER LOCALITY { GLOBAL | REGIONAL [IN <region>] } CONFIGURE ZONE <zone config> 151 `, 152 //line sql.y: 1991 153 SeeAlso: `WEBDOCS/alter-database.html 154 `, 155 }, 156 //line sql.y: 2010 157 `ALTER FUNCTION`: { 158 ShortDescription: `change the definition of a function`, 159 //line sql.y: 2011 160 Category: hDDL, 161 //line sql.y: 2012 162 Text: ` 163 ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 164 action [ ... ] [ RESTRICT ] 165 ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 166 RENAME TO new_name 167 ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 168 OWNER TO { new_owner | CURRENT_USER | SESSION_USER } 169 ALTER FUNCTION name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 170 SET SCHEMA new_schema 171 172 where action is one of: 173 174 CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT 175 IMMUTABLE | STABLE | VOLATILE 176 [ NOT ] LEAKPROOF 177 `, 178 //line sql.y: 2027 179 SeeAlso: `WEBDOCS/alter-function.html 180 `, 181 }, 182 //line sql.y: 2036 183 `ALTER PROCEDURE`: { 184 ShortDescription: `change the definition of a procedure`, 185 //line sql.y: 2037 186 Category: hDDL, 187 //line sql.y: 2038 188 Text: ` 189 ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 190 RENAME TO new_name 191 ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 192 OWNER TO { new_owner | CURRENT_USER | SESSION_USER } 193 ALTER PROCEDURE name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] 194 SET SCHEMA new_schema 195 196 `, 197 //line sql.y: 2046 198 SeeAlso: `WEBDOCS/alter-procedure.html 199 `, 200 }, 201 //line sql.y: 2240 202 `ALTER RANGE`: { 203 ShortDescription: `change the parameters of a range`, 204 //line sql.y: 2241 205 Category: hDDL, 206 //line sql.y: 2242 207 Text: ` 208 ALTER RANGE <zonename> <command> 209 210 Commands: 211 ALTER RANGE ... CONFIGURE ZONE <zoneconfig> 212 ALTER RANGE RELOCATE { VOTERS | NONVOTERS } FROM <store_id> TO <store_id> FOR <selectclause> 213 ALTER RANGE r RELOCATE { VOTERS | NONVOTERS } FROM <store_id> TO <store_id> 214 ALTER RANGE RELOCATE LEASE TO <store_id> FOR <selectclause> 215 ALTER RANGE r RELOCATE LEASE TO <store_id> 216 217 Zone configurations: 218 DISCARD 219 USING <var> = <expr> [, ...] 220 USING <var> = COPY FROM PARENT [, ...] 221 { TO | = } <expr> 222 223 `, 224 //line sql.y: 2258 225 SeeAlso: `ALTER TABLE 226 `, 227 }, 228 //line sql.y: 2264 229 `ALTER INDEX`: { 230 ShortDescription: `change the definition of an index`, 231 //line sql.y: 2265 232 Category: hDDL, 233 //line sql.y: 2266 234 Text: ` 235 ALTER INDEX [IF EXISTS] <idxname> <command> 236 237 Commands: 238 ALTER INDEX ... RENAME TO <newname> 239 ALTER INDEX ... SPLIT AT <selectclause> [WITH EXPIRATION <expr>] 240 ALTER INDEX ... UNSPLIT AT <selectclause> 241 ALTER INDEX ... UNSPLIT ALL 242 ALTER INDEX ... SCATTER [ FROM ( <exprs...> ) TO ( <exprs...> ) ] 243 ALTER INDEX ... RELOCATE [ LEASE | VOTERS | NONVOTERS ] <selectclause> 244 ALTER INDEX ... [VISIBLE | NOT VISIBLE | INVISIBLE | VISIBILITY ...] 245 246 Zone configurations: 247 DISCARD 248 USING <var> = <expr> [, ...] 249 USING <var> = COPY FROM PARENT [, ...] 250 { TO | = } <expr> 251 252 `, 253 //line sql.y: 2284 254 SeeAlso: `WEBDOCS/alter-index.html 255 `, 256 }, 257 //line sql.y: 2986 258 `ALTER TYPE`: { 259 ShortDescription: `change the definition of a type.`, 260 //line sql.y: 2987 261 Category: hDDL, 262 //line sql.y: 2988 263 Text: `ALTER TYPE <typename> <command> 264 265 Commands: 266 ALTER TYPE ... ADD VALUE [IF NOT EXISTS] <value> [ { BEFORE | AFTER } <value> ] 267 ALTER TYPE ... RENAME VALUE <oldname> TO <newname> 268 ALTER TYPE ... RENAME TO <newname> 269 ALTER TYPE ... SET SCHEMA <newschemaname> 270 ALTER TYPE ... OWNER TO {<newowner> | CURRENT_USER | SESSION_USER } 271 ALTER TYPE ... RENAME ATTRIBUTE <oldname> TO <newname> [ CASCADE | RESTRICT ] 272 ALTER TYPE ... <attributeaction> [, ... ] 273 274 Attribute action: 275 ADD ATTRIBUTE <name> <type> [ COLLATE <collation> ] [ CASCADE | RESTRICT ] 276 DROP ATTRIBUTE [IF EXISTS] <name> [ CASCADE | RESTRICT ] 277 ALTER ATTRIBUTE <name> [ SET DATA ] TYPE <type> [ COLLATE <collation> ] [ CASCADE | RESTRICT ] 278 279 `, 280 //line sql.y: 3004 281 SeeAlso: `WEBDOCS/alter-type.html 282 `, 283 }, 284 //line sql.y: 3153 285 `REFRESH`: { 286 ShortDescription: `recalculate a materialized view`, 287 //line sql.y: 3154 288 Category: hMisc, 289 //line sql.y: 3155 290 Text: ` 291 REFRESH MATERIALIZED VIEW [CONCURRENTLY] view_name [WITH [NO] DATA] 292 `, 293 }, 294 //line sql.y: 3182 295 `BACKUP`: { 296 ShortDescription: `back up data to external storage`, 297 //line sql.y: 3183 298 Category: hCCL, 299 //line sql.y: 3184 300 Text: ` 301 302 Create a full backup 303 BACKUP <targets...> INTO <destination...> 304 [ AS OF SYSTEM TIME <expr> ] 305 [ WITH <option> [= <value>] [, ...] ] 306 307 Append an incremental backup to the most recent backup added to a collection 308 BACKUP <targets...> INTO LATEST IN <destination...> 309 [ AS OF SYSTEM TIME <expr> ] 310 [ WITH <option> [= <value>] [, ...] ] 311 312 313 Append an incremental backup in the <subdir>. This command will create an 314 incremental backup iff there is a full backup in <destination> 315 BACKUP <targets...> INTO [<subdir...> IN] <destination> 316 [ AS OF SYSTEM TIME <expr> ] 317 [ WITH <option> [= <value>] [, ...] ] 318 319 Targets: 320 Empty targets list: backup full cluster. 321 TABLE <pattern> [, ...] 322 DATABASE <databasename> [, ...] 323 324 Destination: 325 "[scheme]://[host]/[path to backup]?[parameters]" 326 327 Options: 328 revision_history: enable revision history 329 encryption_passphrase="secret": encrypt backups 330 kms="[kms_provider]://[kms_host]/[master_key_identifier]?[parameters]" : encrypt backups using KMS 331 detached: execute backup job asynchronously, without waiting for its completion 332 incremental_location: specify a different path to store the incremental backup 333 include_all_virtual_clusters: enable backups of all virtual clusters during a cluster backup 334 335 `, 336 //line sql.y: 3219 337 SeeAlso: `RESTORE, WEBDOCS/backup.html 338 `, 339 }, 340 //line sql.y: 3365 341 `CREATE SCHEDULE FOR BACKUP`: { 342 ShortDescription: `backup data periodically`, 343 //line sql.y: 3366 344 Category: hCCL, 345 //line sql.y: 3367 346 Text: ` 347 CREATE SCHEDULE [IF NOT EXISTS] 348 [<description>] 349 FOR BACKUP [<targets>] INTO <location...> 350 [WITH <backup_option>[=<value>] [, ...]] 351 RECURRING [crontab|NEVER] [FULL BACKUP <crontab|ALWAYS>] 352 [WITH EXPERIMENTAL SCHEDULE OPTIONS <schedule_option>[= <value>] [, ...] ] 353 354 All backups run in UTC timezone. 355 356 Description: 357 Optional description (or name) for this schedule 358 359 Targets: 360 empty targets: Backup entire cluster 361 DATABASE <pattern> [, ...]: comma separated list of databases to backup. 362 TABLE <pattern> [, ...]: comma separated list of tables to backup. 363 364 Location: 365 "[scheme]://[host]/[path prefix to backup]?[parameters]" 366 Backup schedule will create subdirectories under this location to store 367 full and periodic backups. 368 369 WITH <options>: 370 Options specific to BACKUP: See BACKUP options 371 372 RECURRING <crontab>: 373 The RECURRING expression specifies when we backup. By default these are incremental 374 backups that capture changes since the last backup, writing to the "current" backup. 375 376 Schedule specified as a string in crontab format. 377 All times in UTC. 378 "5 0 * * *": run schedule 5 minutes past midnight. 379 "@daily": run daily, at midnight 380 See https://en.wikipedia.org/wiki/Cron 381 382 FULL BACKUP <crontab|ALWAYS>: 383 The optional FULL BACKUP '<cron expr>' clause specifies when we'll start a new full backup, 384 which becomes the "current" backup when complete. 385 If FULL BACKUP ALWAYS is specified, then the backups triggered by the RECURRING clause will 386 always be full backups. For free users, this is the only accepted value of FULL BACKUP. 387 388 If the FULL BACKUP clause is omitted, we will select a reasonable default: 389 * RECURRING <= 1 hour: we default to FULL BACKUP '@daily'; 390 * RECURRING <= 1 day: we default to FULL BACKUP '@weekly'; 391 * Otherwise: we default to FULL BACKUP ALWAYS. 392 393 SCHEDULE OPTIONS: 394 The schedule can be modified by specifying the following options (which are considered 395 to be experimental at this time): 396 * first_run=TIMESTAMPTZ: 397 execute the schedule at the specified time. If not specified, the default is to execute 398 the scheduled based on it's next RECURRING time. 399 * on_execution_failure='[retry|reschedule|pause]': 400 If an error occurs during the execution, handle the error based as: 401 * retry: retry execution right away 402 * reschedule: retry execution by rescheduling it based on its RECURRING expression. 403 This is the default. 404 * pause: pause this schedule. Requires manual intervention to unpause. 405 * on_previous_running='[start|skip|wait]': 406 If the previous backup started by this schedule still running, handle this as: 407 * start: start this execution anyway, even if the previous one still running. 408 * skip: skip this execution, reschedule it based on RECURRING (or change_capture_period) 409 expression. 410 * wait: wait for the previous execution to complete. This is the default. 411 * ignore_existing_backups 412 If backups were already created in the destination in which a new schedule references, 413 this flag must be passed in to acknowledge that the new schedule may be backing up different 414 objects. 415 416 `, 417 //line sql.y: 3437 418 SeeAlso: `BACKUP 419 `, 420 }, 421 //line sql.y: 3455 422 `ALTER BACKUP SCHEDULE`: { 423 ShortDescription: `alter an existing backup schedule`, 424 //line sql.y: 3456 425 Category: hCCL, 426 //line sql.y: 3457 427 Text: ` 428 ALTER BACKUP SCHEDULE <id> <command> [, ...] 429 430 Commands: 431 ALTER BACKUP SCHEDULE ... SET LABEL <label> 432 ALTER BACKUP SCHEDULE ... SET INTO <destination> 433 ALTER BACKUP SCHEDULE ... SET WITH <option> 434 ALTER BACKUP SCHEDULE ... SET RECURRING <crontab> 435 ALTER BACKUP SCHEDULE ... SET FULL BACKUP <crontab|ALWAYS> 436 ALTER BACKUP SCHEDULE ... SET SCHEDULE OPTION <option> 437 438 See CREATE SCHEDULE FOR BACKUP for detailed option descriptions. 439 `, 440 //line sql.y: 3469 441 SeeAlso: `CREATE SCHEDULE FOR BACKUP 442 `, 443 }, 444 //line sql.y: 3609 445 `CREATE EXTERNAL CONNECTION`: { 446 ShortDescription: `create a new external connection`, 447 //line sql.y: 3610 448 Category: hMisc, 449 //line sql.y: 3611 450 Text: ` 451 CREATE EXTERNAL CONNECTION [IF NOT EXISTS] <name> AS <endpoint> 452 453 Name: 454 Unique name for this external connection. 455 456 Endpoint: 457 Endpoint of the resource that the external connection represents. 458 `, 459 }, 460 //line sql.y: 3629 461 `DROP EXTERNAL CONNECTION`: { 462 ShortDescription: `drop an existing external connection`, 463 //line sql.y: 3630 464 Category: hMisc, 465 //line sql.y: 3631 466 Text: ` 467 DROP EXTERNAL CONNECTION <name> 468 469 Name: 470 Unique name for this external connection. 471 `, 472 }, 473 //line sql.y: 3645 474 `RESTORE`: { 475 ShortDescription: `restore data from external storage`, 476 //line sql.y: 3646 477 Category: hCCL, 478 //line sql.y: 3647 479 Text: ` 480 RESTORE <targets...> FROM <location...> 481 [ AS OF SYSTEM TIME <expr> ] 482 [ WITH <option> [= <value>] [, ...] ] 483 or 484 RESTORE SYSTEM USERS FROM <location...> 485 [ AS OF SYSTEM TIME <expr> ] 486 [ WITH <option> [= <value>] [, ...] ] 487 488 Targets: 489 TABLE <pattern> [, ...] 490 DATABASE <databasename> [, ...] 491 492 Locations: 493 "[scheme]://[host]/[path to backup]?[parameters]" 494 495 Options: 496 into_db: specify target database 497 skip_missing_foreign_keys: remove foreign key constraints before restoring 498 skip_missing_sequences: ignore sequence dependencies 499 skip_missing_views: skip restoring views because of dependencies that cannot be restored 500 skip_missing_sequence_owners: remove sequence-table ownership dependencies before restoring 501 skip_missing_udfs: skip restoring 502 encryption_passphrase=passphrase: decrypt BACKUP with specified passphrase 503 kms="[kms_provider]://[kms_host]/[master_key_identifier]?[parameters]" : decrypt backups using KMS 504 detached: execute restore job asynchronously, without waiting for its completion 505 skip_localities_check: ignore difference of zone configuration between restore cluster and backup cluster 506 debug_pause_on: describes the events that the job should pause itself on for debugging purposes. 507 new_db_name: renames the restored database. only applies to database restores 508 include_all_virtual_clusters: enable backups of all virtual clusters during a cluster backup 509 `, 510 //line sql.y: 3677 511 SeeAlso: `BACKUP, WEBDOCS/restore.html 512 `, 513 }, 514 //line sql.y: 3905 515 `IMPORT`: { 516 ShortDescription: `load data from file in a distributed manner`, 517 //line sql.y: 3906 518 Category: hCCL, 519 //line sql.y: 3907 520 Text: ` 521 -- Import both schema and table data: 522 IMPORT [ TABLE <tablename> FROM ] 523 <format> <datafile> 524 [ WITH <option> [= <value>] [, ...] ] 525 526 Formats: 527 MYSQLDUMP 528 PGDUMP 529 530 Options: 531 distributed = '...' 532 sstsize = '...' 533 temp = '...' 534 535 Use CREATE TABLE followed by IMPORT INTO to create and import into a table 536 from external files that only have table data. 537 538 `, 539 //line sql.y: 3925 540 SeeAlso: `CREATE TABLE, WEBDOCS/import-into.html 541 `, 542 }, 543 //line sql.y: 3959 544 `EXPORT`: { 545 ShortDescription: `export data to file in a distributed manner`, 546 //line sql.y: 3960 547 Category: hCCL, 548 //line sql.y: 3961 549 Text: ` 550 EXPORT INTO <format> <datafile> [WITH <option> [= value] [,...]] FROM <query> 551 552 Formats: 553 CSV 554 Parquet 555 556 Options: 557 delimiter = '...' [CSV-specific] 558 559 `, 560 //line sql.y: 3971 561 SeeAlso: `SELECT 562 `, 563 }, 564 //line sql.y: 4053 565 `CALL`: { 566 ShortDescription: `invoke a procedure`, 567 //line sql.y: 4054 568 Category: hMisc, 569 //line sql.y: 4055 570 Text: `CALL <name> ( [ <expr> [, ...] ] ) 571 `, 572 //line sql.y: 4056 573 SeeAlso: `CREATE PROCEDURE 574 `, 575 }, 576 //line sql.y: 4298 577 `CANCEL`: { 578 //line sql.y: 4299 579 Category: hGroup, 580 //line sql.y: 4300 581 Text: `CANCEL JOBS, CANCEL QUERIES, CANCEL SESSIONS 582 `, 583 }, 584 //line sql.y: 4308 585 `CANCEL JOBS`: { 586 ShortDescription: `cancel background jobs`, 587 //line sql.y: 4309 588 Category: hMisc, 589 //line sql.y: 4310 590 Text: ` 591 CANCEL JOBS <selectclause> 592 CANCEL JOB <jobid> 593 `, 594 //line sql.y: 4313 595 SeeAlso: `SHOW JOBS, PAUSE JOBS, RESUME JOBS 596 `, 597 }, 598 //line sql.y: 4335 599 `CANCEL QUERIES`: { 600 ShortDescription: `cancel running queries`, 601 //line sql.y: 4336 602 Category: hMisc, 603 //line sql.y: 4337 604 Text: ` 605 CANCEL QUERIES [IF EXISTS] <selectclause> 606 CANCEL QUERY [IF EXISTS] <expr> 607 `, 608 //line sql.y: 4340 609 SeeAlso: `SHOW STATEMENTS 610 `, 611 }, 612 //line sql.y: 4371 613 `CANCEL SESSIONS`: { 614 ShortDescription: `cancel open sessions`, 615 //line sql.y: 4372 616 Category: hMisc, 617 //line sql.y: 4373 618 Text: ` 619 CANCEL SESSIONS [IF EXISTS] <selectclause> 620 CANCEL SESSION [IF EXISTS] <sessionid> 621 `, 622 //line sql.y: 4376 623 SeeAlso: `SHOW SESSIONS 624 `, 625 }, 626 //line sql.y: 4407 627 `CANCEL ALL JOBS`: { 628 ShortDescription: `cancel all background jobs`, 629 //line sql.y: 4408 630 Category: hMisc, 631 //line sql.y: 4409 632 Text: ` 633 CANCEL ALL {BACKUP|CHANGEFEED|IMPORT|RESTORE} JOBS 634 `, 635 }, 636 //line sql.y: 4472 637 `CREATE`: { 638 //line sql.y: 4473 639 Category: hGroup, 640 //line sql.y: 4474 641 Text: ` 642 CREATE DATABASE, CREATE TABLE, CREATE INDEX, CREATE TABLE AS, 643 CREATE USER, CREATE VIEW, CREATE SEQUENCE, CREATE STATISTICS, 644 CREATE ROLE, CREATE TYPE, CREATE EXTENSION, CREATE SCHEDULE 645 `, 646 }, 647 //line sql.y: 4490 648 `CREATE VIRTUAL CLUSTER`: { 649 ShortDescription: `create a new virtual cluster`, 650 //line sql.y: 4491 651 Category: hExperimental, 652 //line sql.y: 4492 653 Text: ` 654 CREATE VIRTUAL CLUSTER [ IF NOT EXISTS ] name [ LIKE <virtual_cluster_spec> ] [ <replication> ] 655 656 Replication option: 657 FROM REPLICATION OF <virtual_cluster_spec> ON <location> [ WITH OPTIONS ... ] 658 `, 659 }, 660 //line sql.y: 4597 661 `CREATE SCHEDULE`: { 662 //line sql.y: 4598 663 Category: hGroup, 664 //line sql.y: 4599 665 Text: ` 666 CREATE SCHEDULE FOR BACKUP, 667 CREATE SCHEDULE FOR CHANGEFEED 668 `, 669 }, 670 //line sql.y: 4607 671 `CREATE EXTENSION`: { 672 ShortDescription: `pseudo-statement for PostgreSQL compatibility`, 673 //line sql.y: 4608 674 Category: hCfg, 675 //line sql.y: 4609 676 Text: `CREATE EXTENSION [IF NOT EXISTS] name 677 `, 678 }, 679 //line sql.y: 4627 680 `CREATE FUNCTION`: { 681 ShortDescription: `define a new function`, 682 //line sql.y: 4628 683 Category: hDDL, 684 //line sql.y: 4629 685 Text: ` 686 CREATE [ OR REPLACE ] FUNCTION 687 name ( [ [ argmode ] [ argname ] argtype [, ...] ] ) 688 [ RETURNS rettype ] 689 { LANGUAGE lang_name 690 | { IMMUTABLE | STABLE | VOLATILE } 691 | [ NOT ] LEAKPROOF 692 | { CALLED ON NULL INPUT | RETURNS NULL ON NULL INPUT | STRICT } 693 | AS 'definition' 694 } ... 695 `, 696 //line sql.y: 4639 697 SeeAlso: `WEBDOCS/create-function.html 698 `, 699 }, 700 //line sql.y: 4661 701 `CREATE PROCEDURE`: { 702 ShortDescription: `define a new procedure`, 703 //line sql.y: 4662 704 Category: hDDL, 705 //line sql.y: 4663 706 Text: ` 707 CREATE [ OR REPLACE ] PROCEDURE 708 name ( [ [ argmode ] [ argname ] argtype [, ...] ] ) 709 { LANGUAGE lang_name 710 | AS 'definition' 711 } ... 712 `, 713 //line sql.y: 4669 714 SeeAlso: `WEBDOCS/create-procedure.html 715 `, 716 }, 717 //line sql.y: 4933 718 `DROP FUNCTION`: { 719 ShortDescription: `remove a function`, 720 //line sql.y: 4934 721 Category: hDDL, 722 //line sql.y: 4935 723 Text: ` 724 DROP FUNCTION [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...] 725 [ CASCADE | RESTRICT ] 726 `, 727 //line sql.y: 4938 728 SeeAlso: `WEBDOCS/drop-function.html 729 `, 730 }, 731 //line sql.y: 4957 732 `DROP PROCEDURE`: { 733 ShortDescription: `remove a procedure`, 734 //line sql.y: 4958 735 Category: hDDL, 736 //line sql.y: 4959 737 Text: ` 738 DROP PROCEDURE [ IF EXISTS ] name [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...] 739 [ CASCADE | RESTRICT ] 740 `, 741 //line sql.y: 4962 742 SeeAlso: `WEBDOCS/drop-procedure.html 743 `, 744 }, 745 //line sql.y: 5189 746 `CREATE STATISTICS`: { 747 ShortDescription: `create a new table statistic`, 748 //line sql.y: 5190 749 Category: hMisc, 750 //line sql.y: 5191 751 Text: ` 752 CREATE STATISTICS <statisticname> 753 [ON <colname> [, ...]] 754 FROM <tablename> [AS OF SYSTEM TIME <expr>] 755 `, 756 }, 757 //line sql.y: 5291 758 `CREATE CHANGEFEED`: { 759 ShortDescription: `create change data capture`, 760 //line sql.y: 5292 761 Category: hCCL, 762 //line sql.y: 5293 763 Text: ` 764 CREATE CHANGEFEED 765 FOR <targets> [INTO sink] [WITH <options>] 766 767 sink: data capture stream destination (Enterprise only) 768 `, 769 }, 770 //line sql.y: 5335 771 `CREATE SCHEDULE FOR CHANGEFEED`: { 772 ShortDescription: `create changefeed periodically`, 773 //line sql.y: 5336 774 Category: hCCL, 775 //line sql.y: 5337 776 Text: ` 777 CREATE SCHEDULE [IF NOT EXISTS] 778 [<description>] 779 FOR CHANGEFEED 780 <targets> INTO <sink> [WITH <options>] 781 RECURRING [crontab|NEVER] 782 [WITH EXPERIMENTAL SCHEDULE OPTIONS <schedule_option>[= <value>] [, ...] ] 783 784 All changefeeds run in UTC timezone. 785 786 Description: 787 Optional description (or name) for this schedule 788 789 RECURRING <crontab>: 790 The RECURRING expression specifies when export runs 791 Schedule specified as a string in crontab format. 792 All times in UTC. 793 "5 0 * * *": run schedule 5 minutes past midnight. 794 "@daily": run daily, at midnight 795 See https://en.wikipedia.org/wiki/Cron 796 797 sink: data capture stream destination (Enterprise only) 798 `, 799 //line sql.y: 5359 800 SeeAlso: `CREATE CHANGEFEED 801 `, 802 }, 803 //line sql.y: 5458 804 `DELETE`: { 805 ShortDescription: `delete rows from a table`, 806 //line sql.y: 5459 807 Category: hDML, 808 //line sql.y: 5460 809 Text: ` 810 DELETE 811 [BATCH [SIZE <expr>]] 812 FROM <tablename> 813 [WHERE <expr>] 814 [ORDER BY <exprs...>] 815 [USING <exprs...>] 816 [LIMIT <expr>] 817 [RETURNING <exprs...>] 818 `, 819 //line sql.y: 5469 820 SeeAlso: `WEBDOCS/delete.html 821 `, 822 }, 823 //line sql.y: 5527 824 `DISCARD`: { 825 ShortDescription: `reset the session to its initial state`, 826 //line sql.y: 5528 827 Category: hCfg, 828 //line sql.y: 5529 829 Text: `DISCARD ALL 830 `, 831 }, 832 //line sql.y: 5550 833 `DROP`: { 834 //line sql.y: 5551 835 Category: hGroup, 836 //line sql.y: 5552 837 Text: ` 838 DROP DATABASE, DROP INDEX, DROP TABLE, DROP VIEW, DROP SEQUENCE, 839 DROP USER, DROP ROLE, DROP TYPE 840 `, 841 }, 842 //line sql.y: 5575 843 `DROP VIEW`: { 844 ShortDescription: `remove a view`, 845 //line sql.y: 5576 846 Category: hDDL, 847 //line sql.y: 5577 848 Text: `DROP [MATERIALIZED] VIEW [IF EXISTS] <tablename> [, ...] [CASCADE | RESTRICT] 849 `, 850 //line sql.y: 5578 851 SeeAlso: `WEBDOCS/drop-index.html 852 `, 853 }, 854 //line sql.y: 5608 855 `DROP SEQUENCE`: { 856 ShortDescription: `remove a sequence`, 857 //line sql.y: 5609 858 Category: hDDL, 859 //line sql.y: 5610 860 Text: `DROP SEQUENCE [IF EXISTS] <sequenceName> [, ...] [CASCADE | RESTRICT] 861 `, 862 //line sql.y: 5611 863 SeeAlso: `DROP 864 `, 865 }, 866 //line sql.y: 5623 867 `DROP TABLE`: { 868 ShortDescription: `remove a table`, 869 //line sql.y: 5624 870 Category: hDDL, 871 //line sql.y: 5625 872 Text: `DROP TABLE [IF EXISTS] <tablename> [, ...] [CASCADE | RESTRICT] 873 `, 874 //line sql.y: 5626 875 SeeAlso: `WEBDOCS/drop-table.html 876 `, 877 }, 878 //line sql.y: 5638 879 `DROP INDEX`: { 880 ShortDescription: `remove an index`, 881 //line sql.y: 5639 882 Category: hDDL, 883 //line sql.y: 5640 884 Text: `DROP INDEX [CONCURRENTLY] [IF EXISTS] <idxname> [, ...] [CASCADE | RESTRICT] 885 `, 886 //line sql.y: 5641 887 SeeAlso: `WEBDOCS/drop-index.html 888 `, 889 }, 890 //line sql.y: 5663 891 `DROP DATABASE`: { 892 ShortDescription: `remove a database`, 893 //line sql.y: 5664 894 Category: hDDL, 895 //line sql.y: 5665 896 Text: `DROP DATABASE [IF EXISTS] <databasename> [CASCADE | RESTRICT] 897 `, 898 //line sql.y: 5666 899 SeeAlso: `WEBDOCS/drop-database.html 900 `, 901 }, 902 //line sql.y: 5686 903 `DROP TYPE`: { 904 ShortDescription: `remove a type`, 905 //line sql.y: 5687 906 Category: hDDL, 907 //line sql.y: 5688 908 Text: `DROP TYPE [IF EXISTS] <type_name> [, ...] [CASCASE | RESTRICT] 909 `, 910 }, 911 //line sql.y: 5708 912 `DROP VIRTUAL CLUSTER`: { 913 ShortDescription: `remove a virtual cluster`, 914 //line sql.y: 5709 915 Category: hExperimental, 916 //line sql.y: 5710 917 Text: `DROP VIRTUAL CLUSTER [IF EXISTS] <virtual_cluster_spec> [IMMEDIATE] 918 `, 919 }, 920 //line sql.y: 5754 921 `DROP SCHEMA`: { 922 ShortDescription: `remove a schema`, 923 //line sql.y: 5755 924 Category: hDDL, 925 //line sql.y: 5756 926 Text: `DROP SCHEMA [IF EXISTS] <schema_name> [, ...] [CASCADE | RESTRICT] 927 `, 928 }, 929 //line sql.y: 5776 930 `DROP ROLE`: { 931 ShortDescription: `remove a user`, 932 //line sql.y: 5777 933 Category: hPriv, 934 //line sql.y: 5778 935 Text: `DROP ROLE [IF EXISTS] <user> [, ...] 936 `, 937 //line sql.y: 5779 938 SeeAlso: `CREATE ROLE, SHOW ROLE 939 `, 940 }, 941 //line sql.y: 5812 942 `ANALYZE`: { 943 ShortDescription: `collect table statistics`, 944 //line sql.y: 5813 945 Category: hMisc, 946 //line sql.y: 5814 947 Text: ` 948 ANALYZE <tablename> 949 950 `, 951 //line sql.y: 5817 952 SeeAlso: `CREATE STATISTICS 953 `, 954 }, 955 //line sql.y: 5840 956 `EXPLAIN`: { 957 ShortDescription: `show the logical plan of a query`, 958 //line sql.y: 5841 959 Category: hMisc, 960 //line sql.y: 5842 961 Text: ` 962 EXPLAIN <statement> 963 EXPLAIN ([PLAN ,] <planoptions...> ) <statement> 964 EXPLAIN (DISTSQL) <statement> 965 EXPLAIN ANALYZE [(DISTSQL)] <statement> 966 EXPLAIN ANALYZE (PLAN <planoptions...>) <statement> 967 968 Explainable statements: 969 SELECT, CREATE, DROP, ALTER, INSERT, UPSERT, UPDATE, DELETE, 970 SHOW, EXPLAIN 971 972 Plan options: 973 TYPES, VERBOSE, OPT 974 975 `, 976 //line sql.y: 5856 977 SeeAlso: `WEBDOCS/explain.html 978 `, 979 }, 980 //line sql.y: 5979 981 `ALTER CHANGEFEED`: { 982 ShortDescription: `alter an existing changefeed`, 983 //line sql.y: 5980 984 Category: hCCL, 985 //line sql.y: 5981 986 Text: ` 987 ALTER CHANGEFEED <job_id> {{ADD|DROP <targets...>} | SET <options...>}... 988 `, 989 }, 990 //line sql.y: 6032 991 `ALTER BACKUP`: { 992 ShortDescription: `alter an existing backup's encryption keys`, 993 //line sql.y: 6033 994 Category: hCCL, 995 //line sql.y: 6034 996 Text: ` 997 ALTER BACKUP <location...> 998 [ ADD NEW_KMS = <kms...> ] 999 [ WITH OLD_KMS = <kms...> ] 1000 Locations: 1001 "[scheme]://[host]/[path to backup]?[parameters]" 1002 1003 KMS: 1004 "[kms_provider]://[kms_host]/[master_key_identifier]?[parameters]" : add new kms keys to backup 1005 `, 1006 }, 1007 //line sql.y: 6088 1008 `SHOW VIRTUAL CLUSTER`: { 1009 ShortDescription: `display metadata about virtual clusters`, 1010 //line sql.y: 6089 1011 Category: hExperimental, 1012 //line sql.y: 6090 1013 Text: ` 1014 SHOW VIRTUAL CLUSTER { <virtual_cluster_spec> | ALL } [ WITH <options> ] 1015 SHOW VIRTUAL CLUSTERS [ WITH <options> ] 1016 1017 Options: 1018 REPLICATION STATUS 1019 CAPABILITIES 1020 `, 1021 }, 1022 //line sql.y: 6175 1023 `PREPARE`: { 1024 ShortDescription: `prepare a statement for later execution`, 1025 //line sql.y: 6176 1026 Category: hMisc, 1027 //line sql.y: 6177 1028 Text: `PREPARE <name> [ ( <types...> ) ] AS <query> 1029 `, 1030 //line sql.y: 6178 1031 SeeAlso: `EXECUTE, DEALLOCATE, DISCARD 1032 `, 1033 }, 1034 //line sql.y: 6209 1035 `EXECUTE`: { 1036 ShortDescription: `execute a statement prepared previously`, 1037 //line sql.y: 6210 1038 Category: hMisc, 1039 //line sql.y: 6211 1040 Text: `EXECUTE <name> [ ( <exprs...> ) ] 1041 `, 1042 //line sql.y: 6212 1043 SeeAlso: `PREPARE, DEALLOCATE, DISCARD 1044 `, 1045 }, 1046 //line sql.y: 6242 1047 `DEALLOCATE`: { 1048 ShortDescription: `remove a prepared statement`, 1049 //line sql.y: 6243 1050 Category: hMisc, 1051 //line sql.y: 6244 1052 Text: `DEALLOCATE [PREPARE] { <name> | ALL } 1053 `, 1054 //line sql.y: 6245 1055 SeeAlso: `PREPARE, EXECUTE, DISCARD 1056 `, 1057 }, 1058 //line sql.y: 6265 1059 `GRANT`: { 1060 ShortDescription: `define access privileges and role memberships`, 1061 //line sql.y: 6266 1062 Category: hPriv, 1063 //line sql.y: 6267 1064 Text: ` 1065 Grant privileges: 1066 GRANT {ALL [PRIVILEGES] | <privileges...> } ON <targets...> TO <grantees...> 1067 Grant role membership: 1068 GRANT <roles...> TO <grantees...> [WITH ADMIN OPTION] 1069 1070 Privileges: 1071 CREATE, DROP, GRANT, SELECT, INSERT, DELETE, UPDATE, USAGE, EXECUTE 1072 1073 Targets: 1074 DATABASE <databasename> [, ...] 1075 [TABLE] [<databasename> .] { <tablename> | * } [, ...] 1076 TYPE <typename> [, <typename>]... 1077 FUNCTION <functionname> [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...] 1078 SCHEMA [<databasename> .]<schemaname> [, [<databasename> .]<schemaname>]... 1079 ALL TABLES IN SCHEMA schema_name [, ...] 1080 1081 `, 1082 //line sql.y: 6284 1083 SeeAlso: `REVOKE, WEBDOCS/grant.html 1084 `, 1085 }, 1086 //line sql.y: 6378 1087 `REVOKE`: { 1088 ShortDescription: `remove access privileges and role memberships`, 1089 //line sql.y: 6379 1090 Category: hPriv, 1091 //line sql.y: 6380 1092 Text: ` 1093 Revoke privileges: 1094 REVOKE {ALL | <privileges...> } ON <targets...> FROM <grantees...> 1095 Revoke role membership: 1096 REVOKE [ADMIN OPTION FOR] <roles...> FROM <grantees...> 1097 1098 Privileges: 1099 CREATE, DROP, GRANT, SELECT, INSERT, DELETE, UPDATE, USAGE, EXECUTE 1100 1101 Targets: 1102 DATABASE <databasename> [, <databasename>]... 1103 [TABLE] [<databasename> .] { <tablename> | * } [, ...] 1104 TYPE <typename> [, <typename>]... 1105 FUNCTION <functionname> [ ( [ [ argmode ] [ argname ] argtype [, ...] ] ) ] [, ...] 1106 SCHEMA [<databasename> .]<schemaname> [, [<databasename> .]<schemaname]... 1107 ALL TABLES IN SCHEMA schema_name [, ...] 1108 1109 `, 1110 //line sql.y: 6397 1111 SeeAlso: `GRANT, WEBDOCS/revoke.html 1112 `, 1113 }, 1114 //line sql.y: 6595 1115 `RESET`: { 1116 ShortDescription: `reset a session variable to its default value`, 1117 //line sql.y: 6596 1118 Category: hCfg, 1119 //line sql.y: 6597 1120 Text: `RESET [SESSION] <var> 1121 `, 1122 //line sql.y: 6598 1123 SeeAlso: `RESET CLUSTER SETTING, WEBDOCS/set-vars.html 1124 `, 1125 }, 1126 //line sql.y: 6614 1127 `RESET CLUSTER SETTING`: { 1128 ShortDescription: `reset a cluster setting to its default value`, 1129 //line sql.y: 6615 1130 Category: hCfg, 1131 //line sql.y: 6616 1132 Text: `RESET CLUSTER SETTING <var> 1133 `, 1134 //line sql.y: 6617 1135 SeeAlso: `SET CLUSTER SETTING, RESET 1136 `, 1137 }, 1138 //line sql.y: 6626 1139 `USE`: { 1140 ShortDescription: `set the current database`, 1141 //line sql.y: 6627 1142 Category: hCfg, 1143 //line sql.y: 6628 1144 Text: `USE <dbname> 1145 1146 "USE <dbname>" is an alias for "SET [SESSION] database = <dbname>". 1147 `, 1148 //line sql.y: 6631 1149 SeeAlso: `SET SESSION, WEBDOCS/set-vars.html 1150 `, 1151 }, 1152 //line sql.y: 6652 1153 `SCRUB`: { 1154 ShortDescription: `run checks against databases or tables`, 1155 //line sql.y: 6653 1156 Category: hExperimental, 1157 //line sql.y: 6654 1158 Text: ` 1159 EXPERIMENTAL SCRUB TABLE <table> ... 1160 EXPERIMENTAL SCRUB DATABASE <database> 1161 1162 The various checks that ca be run with SCRUB includes: 1163 - Physical table data (encoding) 1164 - Secondary index integrity 1165 - Constraint integrity (NOT NULL, CHECK, FOREIGN KEY, UNIQUE) 1166 `, 1167 //line sql.y: 6662 1168 SeeAlso: `SCRUB TABLE, SCRUB DATABASE 1169 `, 1170 }, 1171 //line sql.y: 6668 1172 `SCRUB DATABASE`: { 1173 ShortDescription: `run scrub checks on a database`, 1174 //line sql.y: 6669 1175 Category: hExperimental, 1176 //line sql.y: 6670 1177 Text: ` 1178 EXPERIMENTAL SCRUB DATABASE <database> 1179 [AS OF SYSTEM TIME <expr>] 1180 1181 All scrub checks will be run on the database. This includes: 1182 - Physical table data (encoding) 1183 - Secondary index integrity 1184 - Constraint integrity (NOT NULL, CHECK, FOREIGN KEY, UNIQUE) 1185 `, 1186 //line sql.y: 6678 1187 SeeAlso: `SCRUB TABLE, SCRUB 1188 `, 1189 }, 1190 //line sql.y: 6686 1191 `SCRUB TABLE`: { 1192 ShortDescription: `run scrub checks on a table`, 1193 //line sql.y: 6687 1194 Category: hExperimental, 1195 //line sql.y: 6688 1196 Text: ` 1197 SCRUB TABLE <tablename> 1198 [AS OF SYSTEM TIME <expr>] 1199 [WITH OPTIONS <option> [, ...]] 1200 1201 Options: 1202 EXPERIMENTAL SCRUB TABLE ... WITH OPTIONS INDEX ALL 1203 EXPERIMENTAL SCRUB TABLE ... WITH OPTIONS INDEX (<index>...) 1204 EXPERIMENTAL SCRUB TABLE ... WITH OPTIONS CONSTRAINT ALL 1205 EXPERIMENTAL SCRUB TABLE ... WITH OPTIONS CONSTRAINT (<constraint>...) 1206 EXPERIMENTAL SCRUB TABLE ... WITH OPTIONS PHYSICAL 1207 `, 1208 //line sql.y: 6699 1209 SeeAlso: `SCRUB DATABASE, SRUB 1210 `, 1211 }, 1212 //line sql.y: 6754 1213 `SET CLUSTER SETTING`: { 1214 ShortDescription: `change a cluster setting`, 1215 //line sql.y: 6755 1216 Category: hCfg, 1217 //line sql.y: 6756 1218 Text: `SET CLUSTER SETTING <var> { TO | = } <value> 1219 `, 1220 //line sql.y: 6757 1221 SeeAlso: `SHOW CLUSTER SETTING, RESET CLUSTER SETTING, SET SESSION, SET LOCAL 1222 WEBDOCS/cluster-settings.html 1223 `, 1224 }, 1225 //line sql.y: 6767 1226 `ALTER VIRTUAL CLUSTER`: { 1227 ShortDescription: `alter configuration of virtual clusters`, 1228 //line sql.y: 6768 1229 Category: hGroup, 1230 //line sql.y: 6769 1231 Text: ` 1232 ALTER VIRTUAL CLUSTER REPLICATION, ALTER VIRTUAL CLUSTER SETTING, 1233 ALTER VIRTUAL CLUSTER CAPABILITY, ALTER VIRTUAL CLUSTER RENAME, 1234 ALTER VIRTUAL CLUSTER SERVICE 1235 `, 1236 }, 1237 //line sql.y: 6787 1238 `ALTER VIRTUAL CLUSTER RENAME`: { 1239 ShortDescription: `rename a virtual cluster`, 1240 //line sql.y: 6788 1241 Category: hExperimental, 1242 //line sql.y: 6789 1243 Text: ` 1244 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> RENAME TO <name> 1245 `, 1246 }, 1247 //line sql.y: 6801 1248 `ALTER VIRTUAL CLUSTER SERVICE`: { 1249 ShortDescription: `alter service mode of a virtual cluster`, 1250 //line sql.y: 6802 1251 Category: hExperimental, 1252 //line sql.y: 6803 1253 Text: ` 1254 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> START SERVICE EXTERNAL 1255 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> START SERVICE SHARED 1256 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> STOP SERVICE 1257 `, 1258 }, 1259 //line sql.y: 6836 1260 `ALTER VIRTUAL CLUSTER REPLICATION`: { 1261 ShortDescription: `alter replication stream between virtual clusters`, 1262 //line sql.y: 6837 1263 Category: hExperimental, 1264 //line sql.y: 6838 1265 Text: ` 1266 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> PAUSE REPLICATION 1267 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> RESUME REPLICATION 1268 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> COMPLETE REPLICATION TO LATEST 1269 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> COMPLETE REPLICATION TO SYSTEM TIME 'time' 1270 ALTER VIRTUAL CLUSTER <virtual_cluster_spec> SET REPLICATION opt=value,... 1271 `, 1272 }, 1273 //line sql.y: 6891 1274 `ALTER VIRTUAL CLUSTER SETTING`: { 1275 ShortDescription: `alter cluster setting overrides for virtual clusters`, 1276 //line sql.y: 6892 1277 Category: hGroup, 1278 //line sql.y: 6893 1279 Text: ` 1280 ALTER VIRTUAL CLUSTER { <virtual_cluster_spec> | ALL } SET CLUSTER SETTING <var> { TO | = } <value> 1281 ALTER VIRTUAL CLUSTER { <virtual_cluster_spec> | ALL } RESET CLUSTER SETTING <var> 1282 `, 1283 //line sql.y: 6896 1284 SeeAlso: `SET CLUSTER SETTING 1285 `, 1286 }, 1287 //line sql.y: 6936 1288 `ALTER VIRTUAL CLUSTER CAPABILITY`: { 1289 ShortDescription: `alter system capability of virtual cluster`, 1290 //line sql.y: 6937 1291 Category: hGroup, 1292 //line sql.y: 6938 1293 Text: ` 1294 ALTER VIRTUAL CLUSTER <tenant_id> GRANT CAPABILITY <var> { TO | = } <value> 1295 ALTER VIRTUAL CLUSTER <tenant_id> REVOKE CAPABILITY <var> 1296 `, 1297 }, 1298 //line sql.y: 7016 1299 `SET SESSION`: { 1300 ShortDescription: `change a session variable`, 1301 //line sql.y: 7017 1302 Category: hCfg, 1303 //line sql.y: 7018 1304 Text: ` 1305 SET [SESSION] <var> { TO | = } <values...> 1306 SET [SESSION] TIME ZONE <tz> 1307 SET [SESSION] CHARACTERISTICS AS TRANSACTION ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE } 1308 SET [SESSION] TRACING { TO | = } { on | off | cluster | kv | results } [,...] 1309 1310 `, 1311 //line sql.y: 7024 1312 SeeAlso: `SHOW SESSION, RESET, DISCARD, SHOW, SET CLUSTER SETTING, SET TRANSACTION, SET LOCAL 1313 WEBDOCS/set-vars.html 1314 `, 1315 }, 1316 //line sql.y: 7055 1317 `SET LOCAL`: { 1318 ShortDescription: `change a session variable scoped to the current transaction`, 1319 //line sql.y: 7056 1320 Category: hCfg, 1321 //line sql.y: 7057 1322 Text: ` 1323 SET LOCAL <var> { TO | = } <values...> 1324 SET LOCAL TIME ZONE <tz> 1325 1326 `, 1327 //line sql.y: 7061 1328 SeeAlso: `SHOW SESSION, RESET, DISCARD, SHOW, SET CLUSTER SETTING, SET TRANSACTION, SET SESSION 1329 WEBDOCS/set-vars.html 1330 `, 1331 }, 1332 //line sql.y: 7072 1333 `SET TRANSACTION`: { 1334 ShortDescription: `configure the transaction settings`, 1335 //line sql.y: 7073 1336 Category: hTxn, 1337 //line sql.y: 7074 1338 Text: ` 1339 SET [SESSION] TRANSACTION <txnparameters...> 1340 1341 Transaction parameters: 1342 ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE } 1343 PRIORITY { LOW | NORMAL | HIGH } 1344 AS OF SYSTEM TIME <expr> 1345 [NOT] DEFERRABLE 1346 1347 `, 1348 //line sql.y: 7083 1349 SeeAlso: `SHOW TRANSACTION, SET SESSION, SET LOCAL 1350 WEBDOCS/set-transaction.html 1351 `, 1352 }, 1353 //line sql.y: 7282 1354 `SHOW`: { 1355 //line sql.y: 7283 1356 Category: hGroup, 1357 //line sql.y: 7284 1358 Text: ` 1359 SHOW BACKUP, SHOW CLUSTER SETTING, SHOW COLUMNS, SHOW CONSTRAINTS, 1360 SHOW CREATE, SHOW CREATE SCHEDULES, SHOW DATABASES, SHOW ENUMS, SHOW 1361 FUNCTION, SHOW FUNCTIONS, SHOW HISTOGRAM, SHOW INDEXES, SHOW PARTITIONS, SHOW JOBS, 1362 SHOW STATEMENTS, SHOW RANGE, SHOW RANGES, SHOW REGIONS, SHOW SURVIVAL GOAL, 1363 SHOW ROLES, SHOW SCHEMAS, SHOW SEQUENCES, SHOW SESSION, SHOW SESSIONS, 1364 SHOW STATISTICS, SHOW SYNTAX, SHOW TABLES, SHOW TRACE, SHOW TRANSACTION, 1365 SHOW TRANSACTIONS, SHOW TRANSFER, SHOW TYPES, SHOW USERS, SHOW LAST QUERY STATISTICS, 1366 SHOW SCHEDULES, SHOW LOCALITY, SHOW ZONE CONFIGURATION, SHOW COMMIT TIMESTAMP, 1367 SHOW FULL TABLE SCANS, SHOW CREATE EXTERNAL CONNECTIONS 1368 `, 1369 }, 1370 //line sql.y: 7342 1371 `CLOSE`: { 1372 ShortDescription: `close SQL cursor`, 1373 //line sql.y: 7343 1374 Category: hMisc, 1375 //line sql.y: 7344 1376 Text: `CLOSE [ ALL | <name> ] 1377 `, 1378 //line sql.y: 7345 1379 SeeAlso: `DECLARE, FETCH 1380 `, 1381 }, 1382 //line sql.y: 7361 1383 `DECLARE`: { 1384 ShortDescription: `declare SQL cursor`, 1385 //line sql.y: 7362 1386 Category: hMisc, 1387 //line sql.y: 7363 1388 Text: `DECLARE <name> [ options ] CURSOR p [ WITH | WITHOUT HOLD ] FOR <query> 1389 `, 1390 //line sql.y: 7364 1391 SeeAlso: `CLOSE, FETCH 1392 `, 1393 }, 1394 //line sql.y: 7433 1395 `FETCH`: { 1396 ShortDescription: `fetch rows from a SQL cursor`, 1397 //line sql.y: 7434 1398 Category: hMisc, 1399 //line sql.y: 7435 1400 Text: `FETCH [ direction [ FROM | IN ] ] <name> 1401 `, 1402 //line sql.y: 7436 1403 SeeAlso: `MOVE, CLOSE, DECLARE 1404 `, 1405 }, 1406 //line sql.y: 7446 1407 `MOVE`: { 1408 ShortDescription: `move a SQL cursor without fetching rows`, 1409 //line sql.y: 7447 1410 Category: hMisc, 1411 //line sql.y: 7448 1412 Text: `MOVE [ direction [ FROM | IN ] ] <name> 1413 `, 1414 //line sql.y: 7449 1415 SeeAlso: `FETCH, CLOSE, DECLARE 1416 `, 1417 }, 1418 //line sql.y: 7585 1419 `SHOW SESSION`: { 1420 ShortDescription: `display session variables`, 1421 //line sql.y: 7586 1422 Category: hCfg, 1423 //line sql.y: 7587 1424 Text: `SHOW [SESSION] { <var> | ALL } 1425 `, 1426 //line sql.y: 7588 1427 SeeAlso: `WEBDOCS/show-vars.html 1428 `, 1429 }, 1430 //line sql.y: 7633 1431 `SHOW STATISTICS`: { 1432 ShortDescription: `display table statistics`, 1433 //line sql.y: 7634 1434 Category: hMisc, 1435 //line sql.y: 7635 1436 Text: `SHOW STATISTICS [USING JSON] FOR TABLE <table_name> [WITH FORECAST] 1437 1438 Returns the available statistics for a table. The statistics can include a 1439 histogram ID, which can be used with SHOW HISTOGRAM. 1440 1441 If USING JSON is specified, the statistics and histograms are encoded in JSON 1442 format. 1443 1444 If WITH FORECAST is specified, forecasted statistics are included if 1445 available. 1446 1447 `, 1448 //line sql.y: 7646 1449 SeeAlso: `SHOW HISTOGRAM 1450 `, 1451 }, 1452 //line sql.y: 7668 1453 `SHOW HISTOGRAM`: { 1454 ShortDescription: `display histogram (experimental)`, 1455 //line sql.y: 7669 1456 Category: hExperimental, 1457 //line sql.y: 7670 1458 Text: `SHOW HISTOGRAM <histogram_id> 1459 1460 Returns the data in the histogram with the 1461 given ID (as returned by SHOW STATISTICS). 1462 `, 1463 //line sql.y: 7674 1464 SeeAlso: `SHOW STATISTICS 1465 `, 1466 }, 1467 //line sql.y: 7687 1468 `SHOW BACKUP`: { 1469 ShortDescription: `list backup contents`, 1470 //line sql.y: 7688 1471 Category: hCCL, 1472 //line sql.y: 7689 1473 Text: `SHOW BACKUP [SCHEMAS|FILES|RANGES] <location> 1474 `, 1475 //line sql.y: 7690 1476 SeeAlso: `WEBDOCS/show-backup.html 1477 `, 1478 }, 1479 //line sql.y: 7904 1480 `SHOW CLUSTER SETTING`: { 1481 ShortDescription: `display cluster settings`, 1482 //line sql.y: 7905 1483 Category: hCfg, 1484 //line sql.y: 7906 1485 Text: ` 1486 SHOW CLUSTER SETTING <var> [ FOR VIRTUAL CLUSTER <virtual_cluster_spec> ] 1487 SHOW [ PUBLIC | ALL ] CLUSTER SETTINGS [ FOR VIRTUAL CLUSTER <virtual_cluster_spec> ] 1488 `, 1489 //line sql.y: 7909 1490 SeeAlso: `WEBDOCS/cluster-settings.html 1491 `, 1492 }, 1493 //line sql.y: 7959 1494 `SHOW COLUMNS`: { 1495 ShortDescription: `list columns in relation`, 1496 //line sql.y: 7960 1497 Category: hDDL, 1498 //line sql.y: 7961 1499 Text: `SHOW COLUMNS FROM <tablename> 1500 `, 1501 //line sql.y: 7962 1502 SeeAlso: `WEBDOCS/show-columns.html 1503 `, 1504 }, 1505 //line sql.y: 7970 1506 `SHOW PARTITIONS`: { 1507 ShortDescription: `list partition information`, 1508 //line sql.y: 7971 1509 Category: hDDL, 1510 //line sql.y: 7972 1511 Text: `SHOW PARTITIONS FROM { TABLE <table> | INDEX <index> | DATABASE <database> } 1512 `, 1513 //line sql.y: 7973 1514 SeeAlso: `WEBDOCS/show-partitions.html 1515 `, 1516 }, 1517 //line sql.y: 7993 1518 `SHOW DATABASES`: { 1519 ShortDescription: `list databases`, 1520 //line sql.y: 7994 1521 Category: hDDL, 1522 //line sql.y: 7995 1523 Text: `SHOW DATABASES 1524 `, 1525 //line sql.y: 7996 1526 SeeAlso: `WEBDOCS/show-databases.html 1527 `, 1528 }, 1529 //line sql.y: 8004 1530 `SHOW DEFAULT PRIVILEGES`: { 1531 ShortDescription: `list default privileges`, 1532 //line sql.y: 8005 1533 Category: hDDL, 1534 //line sql.y: 8006 1535 Text: `SHOW DEFAULT PRIVILEGES 1536 `, 1537 //line sql.y: 8007 1538 SeeAlso: `WEBDOCS/show-default-privileges 1539 `, 1540 }, 1541 //line sql.y: 8030 1542 `SHOW ENUMS`: { 1543 ShortDescription: `list enums`, 1544 //line sql.y: 8031 1545 Category: hMisc, 1546 //line sql.y: 8032 1547 Text: `SHOW ENUMS 1548 `, 1549 }, 1550 //line sql.y: 8060 1551 `SHOW TYPES`: { 1552 ShortDescription: `list user defined types`, 1553 //line sql.y: 8061 1554 Category: hMisc, 1555 //line sql.y: 8062 1556 Text: `SHOW TYPES 1557 `, 1558 }, 1559 //line sql.y: 8070 1560 `SHOW GRANTS`: { 1561 ShortDescription: `list grants`, 1562 //line sql.y: 8071 1563 Category: hPriv, 1564 //line sql.y: 8072 1565 Text: ` 1566 Show privilege grants: 1567 SHOW GRANTS [ON <targets...>] [FOR <users...>] 1568 Show role grants: 1569 SHOW GRANTS ON ROLE [<roles...>] [FOR <grantees...>] 1570 1571 `, 1572 //line sql.y: 8078 1573 SeeAlso: `WEBDOCS/show-grants.html 1574 `, 1575 }, 1576 //line sql.y: 8098 1577 `SHOW INDEXES`: { 1578 ShortDescription: `list indexes`, 1579 //line sql.y: 8099 1580 Category: hDDL, 1581 //line sql.y: 8100 1582 Text: `SHOW INDEXES FROM { <tablename> | DATABASE <database_name> } [WITH COMMENT] 1583 `, 1584 //line sql.y: 8101 1585 SeeAlso: `WEBDOCS/show-index.html 1586 `, 1587 }, 1588 //line sql.y: 8131 1589 `SHOW COMMIT TIMESTAMP`: { 1590 ShortDescription: `show timestamp commit timestamp of last transaction`, 1591 //line sql.y: 8132 1592 Category: hMisc, 1593 //line sql.y: 8133 1594 Text: `SHOW COMMIT TIMESTAMP 1595 1596 Shows the commit timestamp of the last committed transaction if not currently 1597 in a transaction. If currently in a transaction, implicitly commits the 1598 transaction, returning any errors which may have occurred during the commit. 1599 The transaction state will remain open from the perspective of the client, 1600 meaning that a COMMIT must be issued to move the connection back to a state 1601 where new statements may be issued. 1602 `, 1603 }, 1604 //line sql.y: 8147 1605 `SHOW CONSTRAINTS`: { 1606 ShortDescription: `list constraints`, 1607 //line sql.y: 8148 1608 Category: hDDL, 1609 //line sql.y: 8149 1610 Text: `SHOW CONSTRAINTS FROM <tablename> 1611 `, 1612 //line sql.y: 8150 1613 SeeAlso: `WEBDOCS/show-constraints.html 1614 `, 1615 }, 1616 //line sql.y: 8163 1617 `SHOW STATEMENTS`: { 1618 ShortDescription: `list running statements`, 1619 //line sql.y: 8164 1620 Category: hMisc, 1621 //line sql.y: 8165 1622 Text: `SHOW [ALL] [CLUSTER | LOCAL] STATEMENTS 1623 `, 1624 //line sql.y: 8166 1625 SeeAlso: `CANCEL QUERIES 1626 `, 1627 }, 1628 //line sql.y: 8193 1629 `SHOW JOBS`: { 1630 ShortDescription: `list background jobs`, 1631 //line sql.y: 8194 1632 Category: hMisc, 1633 //line sql.y: 8195 1634 Text: ` 1635 SHOW [AUTOMATIC | CHANGEFEED] JOBS [select clause] [WITH EXECUTION DETAILS] 1636 SHOW JOBS FOR SCHEDULES [select clause] 1637 SHOW [CHANGEFEED] JOB <jobid> [WITH EXECUTION DETAILS] 1638 `, 1639 //line sql.y: 8199 1640 SeeAlso: `CANCEL JOBS, PAUSE JOBS, RESUME JOBS 1641 `, 1642 }, 1643 //line sql.y: 8309 1644 `SHOW SCHEDULES`: { 1645 ShortDescription: `list periodic schedules`, 1646 //line sql.y: 8310 1647 Category: hMisc, 1648 //line sql.y: 8311 1649 Text: ` 1650 SHOW [RUNNING | PAUSED] SCHEDULES [FOR BACKUP] 1651 SHOW SCHEDULE <schedule_id> 1652 `, 1653 //line sql.y: 8314 1654 SeeAlso: `PAUSE SCHEDULES, RESUME SCHEDULES, DROP SCHEDULES 1655 `, 1656 }, 1657 //line sql.y: 8369 1658 `SHOW TRACE`: { 1659 ShortDescription: `display an execution trace`, 1660 //line sql.y: 8370 1661 Category: hMisc, 1662 //line sql.y: 8371 1663 Text: ` 1664 SHOW [COMPACT] [KV] TRACE FOR SESSION 1665 `, 1666 //line sql.y: 8373 1667 SeeAlso: `EXPLAIN 1668 `, 1669 }, 1670 //line sql.y: 8396 1671 `SHOW SESSIONS`: { 1672 ShortDescription: `list open client sessions`, 1673 //line sql.y: 8397 1674 Category: hMisc, 1675 //line sql.y: 8398 1676 Text: `SHOW [ALL] [CLUSTER | LOCAL] SESSIONS 1677 `, 1678 //line sql.y: 8399 1679 SeeAlso: `CANCEL SESSIONS 1680 `, 1681 }, 1682 //line sql.y: 8412 1683 `SHOW TABLES`: { 1684 ShortDescription: `list tables`, 1685 //line sql.y: 8413 1686 Category: hDDL, 1687 //line sql.y: 8414 1688 Text: `SHOW TABLES [FROM <databasename> [ . <schemaname> ] ] [WITH COMMENT] 1689 `, 1690 //line sql.y: 8415 1691 SeeAlso: `WEBDOCS/show-tables.html 1692 `, 1693 }, 1694 //line sql.y: 8443 1695 `SHOW FUNCTIONS`: { 1696 ShortDescription: `list functions`, 1697 //line sql.y: 8444 1698 Category: hDDL, 1699 //line sql.y: 8445 1700 Text: `SHOW FUNCTIONS [FROM <databasename> [ . <schemaname> ] ] 1701 `, 1702 }, 1703 //line sql.y: 8471 1704 `SHOW PROCEDURES`: { 1705 ShortDescription: `list procedures`, 1706 //line sql.y: 8472 1707 Category: hDDL, 1708 //line sql.y: 8473 1709 Text: `SHOW PROCEDURES [FROM <databasename> [ . <schemaname> ] ] 1710 `, 1711 }, 1712 //line sql.y: 8499 1713 `SHOW TRANSACTIONS`: { 1714 ShortDescription: `list open client transactions across the cluster`, 1715 //line sql.y: 8500 1716 Category: hMisc, 1717 //line sql.y: 8501 1718 Text: `SHOW [ALL] [CLUSTER | LOCAL] TRANSACTIONS 1719 `, 1720 }, 1721 //line sql.y: 8518 1722 `SHOW SCHEMAS`: { 1723 ShortDescription: `list schemas`, 1724 //line sql.y: 8519 1725 Category: hDDL, 1726 //line sql.y: 8520 1727 Text: `SHOW SCHEMAS [FROM <databasename> ] 1728 `, 1729 }, 1730 //line sql.y: 8532 1731 `SHOW SEQUENCES`: { 1732 ShortDescription: `list sequences`, 1733 //line sql.y: 8533 1734 Category: hDDL, 1735 //line sql.y: 8534 1736 Text: `SHOW SEQUENCES [FROM <databasename> ] 1737 `, 1738 }, 1739 //line sql.y: 8546 1740 `SHOW SYNTAX`: { 1741 ShortDescription: `analyze SQL syntax`, 1742 //line sql.y: 8547 1743 Category: hMisc, 1744 //line sql.y: 8548 1745 Text: `SHOW SYNTAX <string> 1746 `, 1747 }, 1748 //line sql.y: 8586 1749 `SHOW SAVEPOINT`: { 1750 ShortDescription: `display current savepoint properties`, 1751 //line sql.y: 8587 1752 Category: hCfg, 1753 //line sql.y: 8588 1754 Text: `SHOW SAVEPOINT STATUS 1755 `, 1756 }, 1757 //line sql.y: 8596 1758 `SHOW TRANSACTION`: { 1759 ShortDescription: `display current transaction properties`, 1760 //line sql.y: 8597 1761 Category: hCfg, 1762 //line sql.y: 8598 1763 Text: `SHOW TRANSACTION {ISOLATION LEVEL | PRIORITY | STATUS} 1764 `, 1765 //line sql.y: 8599 1766 SeeAlso: `WEBDOCS/show-vars.html 1767 `, 1768 }, 1769 //line sql.y: 8618 1770 `SHOW TRANSFER`: { 1771 ShortDescription: `display session state for connection migration`, 1772 //line sql.y: 8619 1773 Category: hMisc, 1774 //line sql.y: 8620 1775 Text: `SHOW TRANSFER STATE [ WITH '<transfer_key>' ] 1776 `, 1777 }, 1778 //line sql.y: 8632 1779 `SHOW CREATE`: { 1780 ShortDescription: `display the CREATE statement for a table, sequence, view, or database`, 1781 //line sql.y: 8633 1782 Category: hDDL, 1783 //line sql.y: 8634 1784 Text: ` 1785 SHOW CREATE [ TABLE | SEQUENCE | VIEW | DATABASE ] <object_name> 1786 SHOW CREATE [ SECONDARY ] INDEXES FROM <table_name> 1787 SHOW CREATE ALL SCHEMAS 1788 SHOW CREATE ALL TABLES 1789 SHOW CREATE ALL TYPES 1790 `, 1791 //line sql.y: 8640 1792 SeeAlso: `WEBDOCS/show-create.html 1793 `, 1794 }, 1795 //line sql.y: 8729 1796 `SHOW CREATE SCHEDULES`: { 1797 ShortDescription: `list CREATE statements for scheduled jobs`, 1798 //line sql.y: 8730 1799 Category: hDDL, 1800 //line sql.y: 8731 1801 Text: ` 1802 SHOW CREATE ALL SCHEDULES 1803 SHOW CREATE SCHEDULE <schedule_id> 1804 `, 1805 //line sql.y: 8734 1806 SeeAlso: `SHOW SCHEDULES, PAUSE SCHEDULES, RESUME SCHEDULES, DROP SCHEDULES 1807 `, 1808 }, 1809 //line sql.y: 8747 1810 `SHOW CREATE EXTERNAL CONNECTIONS`: { 1811 ShortDescription: `list CREATE statements for external connections`, 1812 //line sql.y: 8748 1813 Category: hDDL, 1814 //line sql.y: 8749 1815 Text: ` 1816 SHOW CREATE ALL EXTERNAL CONNECTIONS 1817 SHOW CREATE EXTERNAL CONNECTION <connection_name> 1818 `, 1819 }, 1820 //line sql.y: 8764 1821 `SHOW USERS`: { 1822 ShortDescription: `list defined users`, 1823 //line sql.y: 8765 1824 Category: hPriv, 1825 //line sql.y: 8766 1826 Text: `SHOW USERS 1827 `, 1828 //line sql.y: 8767 1829 SeeAlso: `CREATE USER, DROP USER, WEBDOCS/show-users.html 1830 `, 1831 }, 1832 //line sql.y: 8775 1833 `SHOW ROLES`: { 1834 ShortDescription: `list defined roles`, 1835 //line sql.y: 8776 1836 Category: hPriv, 1837 //line sql.y: 8777 1838 Text: `SHOW ROLES 1839 `, 1840 //line sql.y: 8778 1841 SeeAlso: `CREATE ROLE, ALTER ROLE, DROP ROLE 1842 `, 1843 }, 1844 //line sql.y: 8786 1845 `SHOW ZONE CONFIGURATION`: { 1846 ShortDescription: `display current zone configuration`, 1847 //line sql.y: 8787 1848 Category: hCfg, 1849 //line sql.y: 8788 1850 Text: `SHOW ZONE CONFIGURATION FROM [ RANGE | DATABASE | TABLE | INDEX ] <name> 1851 SHOW ZONE CONFIGURATION FROM PARTITION OF [ INDEX | TABLE ] <name> 1852 SHOW [ALL] ZONE CONFIGURATIONS 1853 `, 1854 //line sql.y: 8791 1855 SeeAlso: `WEBDOCS/show-zone-configurations.html 1856 `, 1857 }, 1858 //line sql.y: 8847 1859 `SHOW RANGE`: { 1860 ShortDescription: `show range information for a row`, 1861 //line sql.y: 8848 1862 Category: hMisc, 1863 //line sql.y: 8849 1864 Text: ` 1865 SHOW RANGE FROM TABLE <tablename> FOR ROW (value1, value2, ...) 1866 SHOW RANGE FROM INDEX [ <tablename> @ ] <indexname> FOR ROW (value1, value2, ...) 1867 `, 1868 }, 1869 //line sql.y: 8870 1870 `SHOW RANGES`: { 1871 ShortDescription: `list ranges`, 1872 //line sql.y: 8871 1873 Category: hMisc, 1874 //line sql.y: 8872 1875 Text: ` 1876 SHOW CLUSTER RANGES [ WITH <options...> ] 1877 SHOW RANGES FROM DATABASE <databasename> [ WITH <options...> ] 1878 SHOW RANGES FROM CURRENT_CATALOG [ WITH <options...> ] 1879 SHOW RANGES FROM TABLE <tablename> [ WITH <options...> ] 1880 SHOW RANGES FROM INDEX [ <tablename> @ ] <indexname> [ WITH <options...> ] 1881 1882 Options: 1883 INDEXES: list indexes contained per range 1884 TABLES: list tables contained per range 1885 DETAILS: add range size, leaseholder and other details 1886 KEYS: include binary start/end keys 1887 EXPLAIN: show the SQL queries that produces the result 1888 1889 Note: the availability of some of the options listed above is subject 1890 to cluster configuration. See the documentation for details. 1891 1892 `, 1893 //line sql.y: 8889 1894 SeeAlso: `WEBDOCS/show-ranges.html 1895 `, 1896 }, 1897 //line sql.y: 8965 1898 `SHOW SURVIVAL GOAL`: { 1899 ShortDescription: `list survival goals`, 1900 //line sql.y: 8966 1901 Category: hDDL, 1902 //line sql.y: 8967 1903 Text: ` 1904 SHOW SURVIVAL GOAL FROM DATABASE 1905 SHOW SURVIVAL GOAL FROM DATABASE <database> 1906 `, 1907 }, 1908 //line sql.y: 8982 1909 `SHOW REGIONS`: { 1910 ShortDescription: `list regions`, 1911 //line sql.y: 8983 1912 Category: hDDL, 1913 //line sql.y: 8984 1914 Text: ` 1915 SHOW REGIONS 1916 SHOW REGIONS FROM ALL DATABASES 1917 SHOW REGIONS FROM CLUSTER 1918 SHOW REGIONS FROM DATABASE 1919 SHOW REGIONS FROM DATABASE <database> 1920 `, 1921 }, 1922 //line sql.y: 9356 1923 `PAUSE`: { 1924 ShortDescription: `pause background tasks`, 1925 //line sql.y: 9357 1926 Category: hGroup, 1927 //line sql.y: 9358 1928 Text: `PAUSE JOBS, PAUSE SCHEDULES, PAUSE ALL JOBS 1929 `, 1930 }, 1931 //line sql.y: 9365 1932 `RESUME`: { 1933 ShortDescription: `resume background tasks`, 1934 //line sql.y: 9366 1935 Category: hGroup, 1936 //line sql.y: 9367 1937 Text: `RESUME JOBS, RESUME SCHEDULES, RESUME ALL BACKUP JOBS 1938 `, 1939 }, 1940 //line sql.y: 9374 1941 `RESUME ALL JOBS`: { 1942 ShortDescription: `resume background jobs`, 1943 //line sql.y: 9375 1944 Category: hMisc, 1945 //line sql.y: 9376 1946 Text: ` 1947 RESUME ALL {BACKUP|CHANGEFEED|IMPORT|RESTORE} JOBS 1948 `, 1949 }, 1950 //line sql.y: 9385 1951 `PAUSE JOBS`: { 1952 ShortDescription: `pause selected background jobs`, 1953 //line sql.y: 9386 1954 Category: hMisc, 1955 //line sql.y: 9387 1956 Text: ` 1957 PAUSE JOBS <selectclause> 1958 PAUSE JOB <jobid> 1959 `, 1960 //line sql.y: 9390 1961 SeeAlso: `SHOW JOBS, CANCEL JOBS, RESUME JOBS 1962 `, 1963 }, 1964 //line sql.y: 9439 1965 `PAUSE SCHEDULES`: { 1966 ShortDescription: `pause scheduled jobs`, 1967 //line sql.y: 9440 1968 Category: hMisc, 1969 //line sql.y: 9441 1970 Text: ` 1971 PAUSE SCHEDULES <selectclause> 1972 select clause: select statement returning schedule id to pause. 1973 PAUSE SCHEDULE <scheduleID> 1974 `, 1975 //line sql.y: 9445 1976 SeeAlso: `RESUME SCHEDULES, SHOW JOBS, CANCEL JOBS 1977 `, 1978 }, 1979 //line sql.y: 9466 1980 `PAUSE ALL JOBS`: { 1981 ShortDescription: `pause all background jobs`, 1982 //line sql.y: 9467 1983 Category: hMisc, 1984 //line sql.y: 9468 1985 Text: ` 1986 PAUSE ALL {BACKUP|CHANGEFEED|IMPORT|RESTORE} JOBS 1987 `, 1988 }, 1989 //line sql.y: 9478 1990 `CREATE SCHEMA`: { 1991 ShortDescription: `create a new schema`, 1992 //line sql.y: 9479 1993 Category: hDDL, 1994 //line sql.y: 9480 1995 Text: ` 1996 CREATE SCHEMA [IF NOT EXISTS] { [<databasename>.]<schemaname> | [[<databasename>.]<schemaname>] AUTHORIZATION <rolename> } 1997 `, 1998 }, 1999 //line sql.y: 9513 2000 `ALTER SCHEMA`: { 2001 ShortDescription: `alter an existing schema`, 2002 //line sql.y: 9514 2003 Category: hDDL, 2004 //line sql.y: 9515 2005 Text: ` 2006 2007 Commands: 2008 ALTER SCHEMA ... RENAME TO <newschemaname> 2009 ALTER SCHEMA ... OWNER TO {<newowner> | CURRENT_USER | SESSION_USER } 2010 `, 2011 }, 2012 //line sql.y: 9541 2013 `CREATE TABLE`: { 2014 ShortDescription: `create a new table`, 2015 //line sql.y: 9542 2016 Category: hDDL, 2017 //line sql.y: 9543 2018 Text: ` 2019 CREATE [[GLOBAL | LOCAL] {TEMPORARY | TEMP}] TABLE [IF NOT EXISTS] <tablename> ( <elements...> ) [<on_commit>] 2020 CREATE [[GLOBAL | LOCAL] {TEMPORARY | TEMP}] TABLE [IF NOT EXISTS] <tablename> [( <colnames...> )] AS <source> [<on commit>] 2021 2022 Table elements: 2023 <name> <type> [<qualifiers...>] 2024 [UNIQUE | INVERTED] INDEX [<name>] ( <colname> [ASC | DESC] [, ...] ) 2025 [USING HASH] [{STORING | INCLUDE | COVERING} ( <colnames...> )] 2026 FAMILY [<name>] ( <colnames...> ) 2027 [CONSTRAINT <name>] <constraint> 2028 2029 Table constraints: 2030 PRIMARY KEY ( <colnames...> ) [USING HASH] 2031 FOREIGN KEY ( <colnames...> ) REFERENCES <tablename> [( <colnames...> )] [ON DELETE {NO ACTION | RESTRICT}] [ON UPDATE {NO ACTION | RESTRICT}] 2032 UNIQUE ( <colnames...> ) [{STORING | INCLUDE | COVERING} ( <colnames...> )] 2033 CHECK ( <expr> ) 2034 2035 Column qualifiers: 2036 [CONSTRAINT <constraintname>] {NULL | NOT NULL | NOT VISIBLE | UNIQUE | PRIMARY KEY | CHECK (<expr>) | DEFAULT <expr> | ON UPDATE <expr> | GENERATED { ALWAYS | BY DEFAULT } AS IDENTITY [( <opt_sequence_option_list> )]} 2037 FAMILY <familyname>, CREATE [IF NOT EXISTS] FAMILY [<familyname>] 2038 REFERENCES <tablename> [( <colnames...> )] [ON DELETE {NO ACTION | RESTRICT}] [ON UPDATE {NO ACTION | RESTRICT}] 2039 COLLATE <collationname> 2040 AS ( <expr> ) { STORED | VIRTUAL } 2041 2042 On commit clause: 2043 ON COMMIT {PRESERVE ROWS | DROP | DELETE ROWS} 2044 2045 `, 2046 //line sql.y: 9570 2047 SeeAlso: `SHOW TABLES, CREATE VIEW, SHOW CREATE, 2048 WEBDOCS/create-table.html 2049 WEBDOCS/create-table-as.html 2050 `, 2051 }, 2052 //line sql.y: 10534 2053 `CREATE SEQUENCE`: { 2054 ShortDescription: `create a new sequence`, 2055 //line sql.y: 10535 2056 Category: hDDL, 2057 //line sql.y: 10536 2058 Text: ` 2059 CREATE [TEMPORARY | TEMP] SEQUENCE <seqname> 2060 [AS <typename>] 2061 [INCREMENT <increment>] 2062 [MINVALUE <minvalue> | NO MINVALUE] 2063 [MAXVALUE <maxvalue> | NO MAXVALUE] 2064 [START [WITH] <start>] 2065 [CACHE <cache>] 2066 [NO CYCLE] 2067 [VIRTUAL] 2068 2069 `, 2070 //line sql.y: 10547 2071 SeeAlso: `CREATE TABLE 2072 `, 2073 }, 2074 //line sql.y: 10630 2075 `TRUNCATE`: { 2076 ShortDescription: `empty one or more tables`, 2077 //line sql.y: 10631 2078 Category: hDML, 2079 //line sql.y: 10632 2080 Text: `TRUNCATE [TABLE] <tablename> [, ...] [CASCADE | RESTRICT] 2081 `, 2082 //line sql.y: 10633 2083 SeeAlso: `WEBDOCS/truncate.html 2084 `, 2085 }, 2086 //line sql.y: 10657 2087 `CREATE ROLE`: { 2088 ShortDescription: `define a new role`, 2089 //line sql.y: 10658 2090 Category: hPriv, 2091 //line sql.y: 10659 2092 Text: `CREATE ROLE [IF NOT EXISTS] <name> [ [WITH] <OPTIONS...> ] 2093 `, 2094 //line sql.y: 10660 2095 SeeAlso: `ALTER ROLE, DROP ROLE, SHOW ROLES 2096 `, 2097 }, 2098 //line sql.y: 10672 2099 `ALTER ROLE`: { 2100 ShortDescription: `alter a role`, 2101 //line sql.y: 10673 2102 Category: hPriv, 2103 //line sql.y: 10674 2104 Text: ` 2105 ALTER ROLE <name> [WITH] <options...> 2106 ALTER ROLE { name | ALL } [ IN DATABASE database_name ] SET var { TO | = } { value | DEFAULT } 2107 ALTER ROLE { name | ALL } [ IN DATABASE database_name ] RESET { var | ALL } 2108 `, 2109 //line sql.y: 10678 2110 SeeAlso: `CREATE ROLE, DROP ROLE, SHOW ROLES 2111 `, 2112 }, 2113 //line sql.y: 10756 2114 `CREATE VIEW`: { 2115 ShortDescription: `create a new view`, 2116 //line sql.y: 10757 2117 Category: hDDL, 2118 //line sql.y: 10758 2119 Text: ` 2120 CREATE [TEMPORARY | TEMP] VIEW [IF NOT EXISTS] <viewname> [( <colnames...> )] AS <source> 2121 CREATE [TEMPORARY | TEMP] MATERIALIZED VIEW [IF NOT EXISTS] <viewname> [( <colnames...> )] AS <source> [WITH [NO] DATA] 2122 `, 2123 //line sql.y: 10761 2124 SeeAlso: `CREATE TABLE, SHOW CREATE, WEBDOCS/create-view.html 2125 `, 2126 }, 2127 //line sql.y: 10983 2128 `CREATE TYPE`: { 2129 ShortDescription: `create a type`, 2130 //line sql.y: 10984 2131 Category: hDDL, 2132 //line sql.y: 10985 2133 Text: `CREATE TYPE [IF NOT EXISTS] <type_name> AS ENUM (...) 2134 `, 2135 }, 2136 //line sql.y: 11083 2137 `CREATE INDEX`: { 2138 ShortDescription: `create a new index`, 2139 //line sql.y: 11084 2140 Category: hDDL, 2141 //line sql.y: 11085 2142 Text: ` 2143 CREATE [UNIQUE | INVERTED] INDEX [CONCURRENTLY] [IF NOT EXISTS] [<idxname>] 2144 ON <tablename> ( <colname> [ASC | DESC] [, ...] ) 2145 [USING HASH] [STORING ( <colnames...> )] 2146 [PARTITION BY <partition params>] 2147 [WITH <storage_parameter_list] [WHERE <where_conds...>] 2148 2149 `, 2150 //line sql.y: 11092 2151 SeeAlso: `CREATE TABLE, SHOW INDEXES, SHOW CREATE, 2152 WEBDOCS/create-index.html 2153 `, 2154 }, 2155 //line sql.y: 11617 2156 `ALTER DEFAULT PRIVILEGES`: { 2157 ShortDescription: `alter default privileges on an object`, 2158 //line sql.y: 11618 2159 Category: hDDL, 2160 //line sql.y: 11619 2161 Text: ` 2162 2163 Commands: 2164 ALTER DEFAULT PRIVILEGES [ FOR { ROLE | USER } target_roles... ] [ IN SCHEMA schema_name...] abbreviated_grant_or_revoke 2165 `, 2166 }, 2167 //line sql.y: 11766 2168 `RELEASE`: { 2169 ShortDescription: `complete a sub-transaction`, 2170 //line sql.y: 11767 2171 Category: hTxn, 2172 //line sql.y: 11768 2173 Text: `RELEASE [SAVEPOINT] <savepoint name> 2174 `, 2175 //line sql.y: 11769 2176 SeeAlso: `SAVEPOINT, WEBDOCS/savepoint.html 2177 `, 2178 }, 2179 //line sql.y: 11777 2180 `RESUME JOBS`: { 2181 ShortDescription: `resume selected background jobs`, 2182 //line sql.y: 11778 2183 Category: hMisc, 2184 //line sql.y: 11779 2185 Text: ` 2186 RESUME JOBS <selectclause> 2187 RESUME JOB <jobid> 2188 `, 2189 //line sql.y: 11782 2190 SeeAlso: `SHOW JOBS, CANCEL JOBS, PAUSE JOBS 2191 `, 2192 }, 2193 //line sql.y: 11804 2194 `RESUME SCHEDULES`: { 2195 ShortDescription: `resume executing scheduled jobs`, 2196 //line sql.y: 11805 2197 Category: hMisc, 2198 //line sql.y: 11806 2199 Text: ` 2200 RESUME SCHEDULES <selectclause> 2201 selectclause: select statement returning schedule IDs to resume. 2202 2203 RESUME SCHEDULE <scheduleID> 2204 2205 `, 2206 //line sql.y: 11812 2207 SeeAlso: `PAUSE SCHEDULES, SHOW JOBS, RESUME JOBS 2208 `, 2209 }, 2210 //line sql.y: 11833 2211 `DROP SCHEDULES`: { 2212 ShortDescription: `destroy specified schedules`, 2213 //line sql.y: 11834 2214 Category: hMisc, 2215 //line sql.y: 11835 2216 Text: ` 2217 DROP SCHEDULES <selectclause> 2218 selectclause: select statement returning schedule IDs to resume. 2219 2220 DROP SCHEDULE <scheduleID> 2221 2222 `, 2223 //line sql.y: 11841 2224 SeeAlso: `PAUSE SCHEDULES, SHOW JOBS, CANCEL JOBS 2225 `, 2226 }, 2227 //line sql.y: 11862 2228 `SAVEPOINT`: { 2229 ShortDescription: `start a sub-transaction`, 2230 //line sql.y: 11863 2231 Category: hTxn, 2232 //line sql.y: 11864 2233 Text: `SAVEPOINT <savepoint name> 2234 `, 2235 //line sql.y: 11865 2236 SeeAlso: `RELEASE, WEBDOCS/savepoint.html 2237 `, 2238 }, 2239 //line sql.y: 11880 2240 `BEGIN`: { 2241 ShortDescription: `start a transaction`, 2242 //line sql.y: 11881 2243 Category: hTxn, 2244 //line sql.y: 11882 2245 Text: ` 2246 BEGIN [TRANSACTION] [ <txnparameter> [[,] ...] ] 2247 START TRANSACTION [ <txnparameter> [[,] ...] ] 2248 2249 Transaction parameters: 2250 ISOLATION LEVEL { READ COMMITTED | SERIALIZABLE } 2251 PRIORITY { LOW | NORMAL | HIGH } 2252 2253 `, 2254 //line sql.y: 11890 2255 SeeAlso: `COMMIT, ROLLBACK, WEBDOCS/begin-transaction.html 2256 `, 2257 }, 2258 //line sql.y: 11900 2259 `COMMIT`: { 2260 ShortDescription: `commit the current transaction`, 2261 //line sql.y: 11901 2262 Category: hTxn, 2263 //line sql.y: 11902 2264 Text: ` 2265 COMMIT [TRANSACTION] 2266 END [TRANSACTION] 2267 `, 2268 //line sql.y: 11905 2269 SeeAlso: `BEGIN, ROLLBACK, WEBDOCS/commit-transaction.html 2270 `, 2271 }, 2272 //line sql.y: 11924 2273 `ROLLBACK`: { 2274 ShortDescription: `abort the current (sub-)transaction`, 2275 //line sql.y: 11925 2276 Category: hTxn, 2277 //line sql.y: 11926 2278 Text: ` 2279 ROLLBACK [TRANSACTION] 2280 ROLLBACK [TRANSACTION] TO [SAVEPOINT] <savepoint name> 2281 `, 2282 //line sql.y: 11929 2283 SeeAlso: `BEGIN, COMMIT, SAVEPOINT, WEBDOCS/rollback-transaction.html 2284 `, 2285 }, 2286 //line sql.y: 12065 2287 `CREATE DATABASE`: { 2288 ShortDescription: `create a new database`, 2289 //line sql.y: 12066 2290 Category: hDDL, 2291 //line sql.y: 12067 2292 Text: `CREATE DATABASE [IF NOT EXISTS] <name> 2293 `, 2294 //line sql.y: 12068 2295 SeeAlso: `WEBDOCS/create-database.html 2296 `, 2297 }, 2298 //line sql.y: 12273 2299 `INSERT`: { 2300 ShortDescription: `create new rows in a table`, 2301 //line sql.y: 12274 2302 Category: hDML, 2303 //line sql.y: 12275 2304 Text: ` 2305 INSERT INTO <tablename> [[AS] <name>] [( <colnames...> )] 2306 <selectclause> 2307 [ON CONFLICT { 2308 [( <colnames...> )] [WHERE <arbiter_predicate>] DO NOTHING | 2309 ( <colnames...> ) [WHERE <index_predicate>] DO UPDATE SET ... [WHERE <expr>] 2310 } 2311 [RETURNING <exprs...>] 2312 `, 2313 //line sql.y: 12283 2314 SeeAlso: `UPSERT, UPDATE, DELETE, WEBDOCS/insert.html 2315 `, 2316 }, 2317 //line sql.y: 12302 2318 `UPSERT`: { 2319 ShortDescription: `create or replace rows in a table`, 2320 //line sql.y: 12303 2321 Category: hDML, 2322 //line sql.y: 12304 2323 Text: ` 2324 UPSERT INTO <tablename> [AS <name>] [( <colnames...> )] 2325 <selectclause> 2326 [RETURNING <exprs...>] 2327 `, 2328 //line sql.y: 12308 2329 SeeAlso: `INSERT, UPDATE, DELETE, WEBDOCS/upsert.html 2330 `, 2331 }, 2332 //line sql.y: 12438 2333 `UPDATE`: { 2334 ShortDescription: `update rows of a table`, 2335 //line sql.y: 12439 2336 Category: hDML, 2337 //line sql.y: 12440 2338 Text: ` 2339 UPDATE <tablename> [[AS] <name>] 2340 SET ... 2341 [FROM <source>] 2342 [WHERE <expr>] 2343 [ORDER BY <exprs...>] 2344 [LIMIT <expr>] 2345 [RETURNING <exprs...>] 2346 `, 2347 //line sql.y: 12448 2348 SeeAlso: `INSERT, UPSERT, DELETE, WEBDOCS/update.html 2349 `, 2350 }, 2351 //line sql.y: 12504 2352 `REASSIGN OWNED BY`: { 2353 ShortDescription: `change ownership of all objects`, 2354 //line sql.y: 12505 2355 Category: hPriv, 2356 //line sql.y: 12506 2357 Text: `REASSIGN OWNED BY {<name> | CURRENT_USER | SESSION_USER}[,...] 2358 TO {<name> | CURRENT_USER | SESSION_USER} 2359 `, 2360 //line sql.y: 12508 2361 SeeAlso: `DROP OWNED BY 2362 `, 2363 }, 2364 //line sql.y: 12519 2365 `DROP OWNED BY`: { 2366 ShortDescription: `remove database objects owned by role(s).`, 2367 //line sql.y: 12520 2368 Category: hPriv, 2369 //line sql.y: 12521 2370 Text: `DROP OWNED BY {<name> | CURRENT_USER | SESSION_USER}[,...] 2371 [RESTRICT | CASCADE] 2372 `, 2373 //line sql.y: 12523 2374 SeeAlso: `REASSIGN OWNED BY 2375 `, 2376 }, 2377 //line sql.y: 12703 2378 `<SELECTCLAUSE>`: { 2379 ShortDescription: `access tabular data`, 2380 //line sql.y: 12704 2381 Category: hDML, 2382 //line sql.y: 12705 2383 Text: ` 2384 Select clause: 2385 TABLE <tablename> 2386 VALUES ( <exprs...> ) [ , ... ] 2387 SELECT ... [ { INTERSECT | UNION | EXCEPT } [ ALL | DISTINCT ] <selectclause> ] 2388 `, 2389 }, 2390 //line sql.y: 12716 2391 `SELECT`: { 2392 ShortDescription: `retrieve rows from a data source and compute a result`, 2393 //line sql.y: 12717 2394 Category: hDML, 2395 //line sql.y: 12718 2396 Text: ` 2397 SELECT [DISTINCT [ ON ( <expr> [ , ... ] ) ] ] 2398 { <expr> [[AS] <name>] | [ [<dbname>.] <tablename>. ] * } [, ...] 2399 [ FROM <source> ] 2400 [ WHERE <expr> ] 2401 [ GROUP BY <expr> [ , ... ] ] 2402 [ HAVING <expr> ] 2403 [ WINDOW <name> AS ( <definition> ) ] 2404 [ { UNION | INTERSECT | EXCEPT } [ ALL | DISTINCT ] <selectclause> ] 2405 [ ORDER BY <expr> [ ASC | DESC ] [, ...] ] 2406 [ LIMIT { <expr> | ALL } ] 2407 [ OFFSET <expr> [ ROW | ROWS ] ] 2408 `, 2409 //line sql.y: 12730 2410 SeeAlso: `WEBDOCS/select-clause.html 2411 `, 2412 }, 2413 //line sql.y: 12805 2414 `TABLE`: { 2415 ShortDescription: `select an entire table`, 2416 //line sql.y: 12806 2417 Category: hDML, 2418 //line sql.y: 12807 2419 Text: `TABLE <tablename> 2420 `, 2421 //line sql.y: 12808 2422 SeeAlso: `SELECT, VALUES, WEBDOCS/table-expressions.html 2423 `, 2424 }, 2425 //line sql.y: 13209 2426 `VALUES`: { 2427 ShortDescription: `select a given set of values`, 2428 //line sql.y: 13210 2429 Category: hDML, 2430 //line sql.y: 13211 2431 Text: `VALUES ( <exprs...> ) [, ...] 2432 `, 2433 //line sql.y: 13212 2434 SeeAlso: `SELECT, TABLE, WEBDOCS/table-expressions.html 2435 `, 2436 }, 2437 //line sql.y: 13353 2438 `<SOURCE>`: { 2439 ShortDescription: `define a data source for SELECT`, 2440 //line sql.y: 13354 2441 Category: hDML, 2442 //line sql.y: 13355 2443 Text: ` 2444 Data sources: 2445 <tablename> [ @ { <idxname> | <indexflags> } ] 2446 <tablefunc> ( <exprs...> ) 2447 ( { <selectclause> | <source> } ) 2448 <source> [AS] <alias> [( <colnames...> )] 2449 <source> [ <jointype> ] JOIN <source> ON <expr> 2450 <source> [ <jointype> ] JOIN <source> USING ( <colnames...> ) 2451 <source> NATURAL [ <jointype> ] JOIN <source> 2452 <source> CROSS JOIN <source> 2453 <source> WITH ORDINALITY 2454 '[' EXPLAIN ... ']' 2455 '[' SHOW ... ']' 2456 2457 Index flags: 2458 '{' FORCE_INDEX = <idxname> [, ...] '}' 2459 '{' NO_INDEX_JOIN [, ...] '}' 2460 '{' NO_ZIGZAG_JOIN [, ...] '}' 2461 '{' NO_FULL_SCAN [, ...] '}' 2462 '{' IGNORE_FOREIGN_KEYS [, ...] '}' 2463 '{' FORCE_ZIGZAG = <idxname> [, ...] '}' 2464 2465 Join types: 2466 { INNER | { LEFT | RIGHT | FULL } [OUTER] } [ { HASH | MERGE | LOOKUP | INVERTED } ] 2467 2468 `, 2469 //line sql.y: 13380 2470 SeeAlso: `WEBDOCS/table-expressions.html 2471 `, 2472 }, 2473 }