Skip to content

Commit f07fb10

Browse files
marvelshanalamb
andauthored
Improve documentation for format OPTIONS clause (#15708)
* doc:Add documentation for OPTIONS clause syntax * doc:rename write_options.md to format_options.md and clarify its scope for both reading and writing * doc: change dml.md, cuz still have wrong write_options filename * doc: update doctest reference to renamed format_options.md * docs: update and correct format options documentation * doc: add more information of options content * remove execution settings, move note about insert * wordsmith example --------- Co-authored-by: Andrew Lamb <[email protected]>
1 parent 1d3c592 commit f07fb10

File tree

6 files changed

+185
-132
lines changed

6 files changed

+185
-132
lines changed

datafusion/core/src/lib.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1027,8 +1027,8 @@ doc_comment::doctest!(
10271027

10281028
#[cfg(doctest)]
10291029
doc_comment::doctest!(
1030-
"../../../docs/source/user-guide/sql/write_options.md",
1031-
user_guide_sql_write_options
1030+
"../../../docs/source/user-guide/sql/format_options.md",
1031+
user_guide_sql_format_options
10321032
);
10331033

10341034
#[cfg(doctest)]

docs/source/user-guide/sql/ddl.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ LOCATION <literal>
7474
<key_value_list> := (<literal> <literal, <literal> <literal>, ...)
7575
```
7676

77-
For a detailed list of write related options which can be passed in the OPTIONS key_value_list, see [Write Options](write_options).
77+
For a comprehensive list of format-specific options that can be specified in the `OPTIONS` clause, see [Format Options](format_options.md).
7878

7979
`file_type` is one of `CSV`, `ARROW`, `PARQUET`, `AVRO` or `JSON`
8080

docs/source/user-guide/sql/dml.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ The output format is determined by the first match of the following rules:
4949
1. Value of `STORED AS`
5050
2. Filename extension (e.g. `foo.parquet` implies `PARQUET` format)
5151

52-
For a detailed list of valid OPTIONS, see [Write Options](write_options).
52+
For a detailed list of valid OPTIONS, see [Format Options](format_options.md).
5353

5454
### Examples
5555

0 commit comments

Comments
 (0)