Minor: document syntax of CREATE EXTERNAL TABLE #6247
Conversation
github-actions
bot
added
sql
|
|
||
| <ordered_column_list> := (<column_name> <sort_clause>, ...) | ||
|
|
||
| <key_value_list> := (<literal> <literal, <literal> <literal>, ...) |
There was a problem hiding this comment.
Is there a collection of available options? If someone were to implement a mechanism based on options, how should it be documented?
There was a problem hiding this comment.
I don't think any option is (yet) handled by datafusion core
I believe datafusion-cli handles some: https://arrow.apache.org/datafusion/user-guide/cli.html#registering-s3-data-sources
@r4ntix maybe knows more
There was a problem hiding this comment.
If someone were to implement a mechanism based on options, how should it be documented?
I recommend anything meant to be used by users of datafusion should be explicitly in the CREATE TABLE syntax -- e.g. #6248)
If we do want to do something with options, perhaps it could be documented in https://arrow.apache.org/datafusion/user-guide/sql/ddl.html
There was a problem hiding this comment.
I don't think any option is (yet) handled by datafusion core
I believe datafusion-cli handles some: https://arrow.apache.org/datafusion/user-guide/cli.html#registering-s3-data-sources
@r4ntix maybe knows more
@alamb Yes, not all options are supported in datafusion-core. There is no actual [ OPTIONS (<key_value_list>) ] support in the current datafusion-core.
@metesynnada Do you mean that for all the [ ... ] options, do we need to be more detailed in the documentation? 🤔️
github-actions
bot
removed
the
documentation
Which issue does this PR close?
Rationale for this change
When writing tests yesterday it was quite challenging to remember the exact CREATE EXTERNAL table syntax so I want to document it for next time
What changes are included in this PR?
add doc comments and update DDL user guide
Are these changes tested?
N/A
Are there any user-facing changes?
Docs