Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document CREATE EXTERNAL TABLE ... OPTIONS #10451

Open
alamb opened this issue May 10, 2024 · 0 comments
Open

Document CREATE EXTERNAL TABLE ... OPTIONS #10451

alamb opened this issue May 10, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation enhancement New feature or request

Comments

@alamb
Copy link
Contributor

alamb commented May 10, 2024

Is your feature request related to a problem or challenge?

While reviewing https://github.com/apache/datafusion/pull/10404/files I could not find documentation on what the syntax / available settings are for the OPTIONS clause

For example there are generic options like

CREATE EXTERNAL TABLE 
....
  OPTIONS(
    NULL_VALUE 'NAN',
  )

And then there are format specific options like (the newly added):

CREATE EXTERNAL TABLE 
....
  OPTIONS(
    NULL_VALUE 'NAN',
    'format.has_header' 'true'
  )

Neither appears to be documented

Describe the solution you'd like

It would be great (as another PR) if we can document them similarly to how @devinjdangelo documented the write options:

https://datafusion.apache.org/user-guide/sql/write_options.html#available-options

With a section for the generic options that apply to all formats and then a list of options for each specific format

Describe alternatives you've considered

No response

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant