Back to Clickhouse

Template Function

docs/_description_templates/template-function.md

26.4.1.1-new1.1 KB
Original Source

functionName {#functionname-in-lower-case}

Short description.

Syntax (without SELECT)

sql
<function syntax>

Alias: <alias name>. (Optional)

More text (Optional).

Arguments (Optional)

  • x — Description. Optional (only for optional arguments). Possible values: <values list>. Default value: <value>. Type name.
  • y — Description. Optional (only for optional arguments). Possible values: <values list>.Default value: <value>. Type name.

Parameters (Optional, only for parametric aggregate functions)

  • z — Description. Optional (only for optional parameters). Possible values: <values list>. Default value: <value>. Type name.

Returned value(s)

  • Returned values list.

Type: Type name.

Example

The example must show usage and/or a use cases. The following text contains recommended parts of an example.

Input table (Optional):

text

Query:

sql

Result:

text

See Also (Optional)