ClickHouse/docs/_description_templates/template-table-engine.md

51 lines
810 B
Markdown
Raw Normal View History

# EngineName {#enginename}
- What the engine does.
- Relations with other engines if they exist.
## Creating a Table {#creating-a-table}
2020-03-27 05:28:48 +00:00
``` sql
CREATE TABLE ...
```
**Engine Parameters**
**Query Clauses**
## Virtual columns {#virtual-columns}
2020-03-27 05:28:48 +00:00
List and virtual columns with description, if they exist.
## Specifics and recommendations {#specifics-and-recommendations}
Algorithms
2020-03-27 05:28:48 +00:00
Specifics of read and write processes
Examples of tasks
Recommendations for usage
Specifics of data storage
## Usage Example {#usage-example}
2020-03-27 05:28:48 +00:00
The example must show usage and use cases. The following text contains the recommended parts of this section.
Input table:
``` text
```
Query:
``` sql
```
Result:
``` text
```
2020-03-27 05:28:48 +00:00
Follow up with any text to clarify the example.
## See Also {#see-also}
- [link](#)