universalmind303 opened a new issue, #8366: URL: https://github.com/apache/arrow-datafusion/issues/8366
### Is your feature request related to a problem or challenge? Currently I am working on adding examples & documentation to all sql functions for a database implementation built on datafusion. [GlareDB](https://github.com/GlareDB/glaredb). We are manually providing [examples and docs ](https://github.com/GlareDB/glaredb/pull/2178/files#diff-5465ce3e9dc3e728014534444ea0ea2be837da7e0d77d73756a2282d3f805771)for all of the functions native to datafusion. It'd be nice if these were provided by datafusion out of the box. ### Describe the solution you'd like in addition to `name`, and `signature`, `BuiltinScalarFunction` and `AggregateFunction` should provide methods for description & example usage. ```rust let abs = BuiltinScalarFunction::Abs; abs.name() // "abs" abs.sql_example() // "abs(-1)" abs.description() // "Compute the absolute value of a number." ``` ### Describe alternatives you've considered See above. ### Additional context Considering we've (glaredb) already implemented the examples/descriptions for our own usecase, I'd be happy to submit a PR to add it to datafusion if it's something that would benefit others. One thing to consider is that it may add a bit of bloat to binaries as it'll need to contain all of these additional strings. (maybe we could/should feature flag it?) -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
