mirror of
https://github.com/ClickHouse/ClickHouse.git
synced 2024-09-24 10:40:49 +00:00
5c1b4b1c7b
* CLICKHOUSEDOCS-716: Added the template for SQL-statement description. * Update docs/_description_templates/template-statement.md Co-authored-by: Ivan Blinkov <github@blinkov.ru> * Update docs/_description_templates/template-statement.md Co-authored-by: Ivan Blinkov <github@blinkov.ru> * CLICKHOUSEDOCS-716: Updated by comments. Co-authored-by: Sergei Shtykov <bayonet@yandex-team.ru> Co-authored-by: emironyuk <em@don.ru> Co-authored-by: Ivan Blinkov <github@blinkov.ru>
25 lines
532 B
Markdown
25 lines
532 B
Markdown
# Statement name (for example, SHOW USER)
|
|
|
|
Brief description of what the statement does.
|
|
|
|
Syntax:
|
|
|
|
```sql
|
|
Syntax of the statement.
|
|
```
|
|
|
|
## Other necessary sections of the description (Optional)
|
|
|
|
Examples of descriptions with a complicated structure:
|
|
|
|
- https://clickhouse.tech/docs/en/sql-reference/statements/grant/
|
|
- https://clickhouse.tech/docs/en/sql-reference/statements/revoke/
|
|
- https://clickhouse.tech/docs/en/sql-reference/statements/select/join/
|
|
|
|
|
|
## See Also (Optional)
|
|
|
|
Links to related topics as a list.
|
|
|
|
- [link](#)
|