add documentation

This commit is contained in:
flynn 2022-11-11 02:42:18 +00:00
parent 6f6a1f5d76
commit eebc5349cc
2 changed files with 12 additions and 3 deletions

View File

@ -158,7 +158,12 @@ StoragePtr TableFunctionDelta::executeImpl(
void registerTableFunctionDelta(TableFunctionFactory & factory)
{
factory.registerFunction<TableFunctionDelta>({.documentation = {}, .allow_readonly = true});
factory.registerFunction<TableFunctionDelta>(
{.documentation
= {R"(The table function can be used to read the DeltaLake table stored on object store.)",
Documentation::Examples{{"hudi", "SELECT * FROM deltaLake(url, access_key_id, secret_access_key)"}},
Documentation::Categories{"DataLake"}},
.allow_readonly = true});
}
}

View File

@ -158,9 +158,13 @@ StoragePtr TableFunctionHudi::executeImpl(
void registerTableFunctionHudi(TableFunctionFactory & factory)
{
factory.registerFunction<TableFunctionHudi>({.documentation = {}, .allow_readonly = true});
factory.registerFunction<TableFunctionHudi>(
{.documentation
= {R"(The table function can be used to read the Hudi table stored on object store.)",
Documentation::Examples{{"hudi", "SELECT * FROM hudi(url, access_key_id, secret_access_key)"}},
Documentation::Categories{"DataLake"}},
.allow_readonly = true});
}
}
#endif