thevar1able/ClickHouse
1
0
Fork 0
mirror of https://github.com/ClickHouse/ClickHouse.git synced 2024-12-15 19:02:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Better docs

Browse Source
This commit is contained in:
avogar 2023-03-09 20:27:14 +00:00
parent 746d12e7cc
commit 48d701f0e7
1 changed files with 9 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/Functions/generateRandomStructure.cpp
View File

@ -422,13 +422,19 @@ REGISTER_FUNCTION(GenerateRandomStructure)
{
R"(
Generates a random table structure.
This function takes an optional constant argument, the number of column in the result structure.
If argument is now specified, the number of columns is random. The maximum number of columns is 1024.
This function takes 4 optional constant arguments: the number of column in the result structure (random by default),
random seed (random by default), flag that indicates if big number types can be used (true by default),
flag that indicates if enum types can be used (true by default).
The maximum number of columns is 128.
The function returns a value of type String.
)",
Documentation::Examples{
{"random", "SELECT generateRandomStructure()"},
{"with specified number of arguments", "SELECT generateRandomStructure(10)"}},
{"with specified number of arguments", "SELECT generateRandomStructure(10)"},
{"with specified seed", "SELECT generateRandomStructure(10, 42)"},
{"without big number types", "SELECT generateRandomStructure(10, NULL, false)"},
{"without enum types", "SELECT generateRandomStructure(10, NULL, false, false)"},
},
Documentation::Categories{"Random"}
},
FunctionFactory::CaseSensitive);