Skip to content

Commit 2f75da1

Browse files
committed
Tweak config options descriptions some more
1 parent 711567b commit 2f75da1

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -131,6 +131,8 @@ There are also several SQL-specific options:
131131

132132
Enforce case of keywords.
133133

134+
This effects all keywords except literals (see `sqlLiteralCase`) and data types (see `sqlTypeCase`).
135+
134136
For now `preserve` is somewhat incompatible with `sqlCanonicalSyntax: true` (e.g. the added `AS` keywords will always be in uppercase).
135137

136138
- **`sqlLiteralCase`**: `"upper" | "lower" | "preserve"` (default `"upper"`)
@@ -146,19 +148,21 @@ There are also several SQL-specific options:
146148
Enforce case of type names.
147149

148150
In PostgreSQL this will only effect a limited set of builtin data types, the rest will be formatted as identifiers.
149-
Therefore for PostgreSQL the recommended setting of this option is `lower`.
151+
It will effect casing of all the keywords in types like `TIMESTAMP WITH TIME ZONE` and `INTERVAL DAY TO SECOND`,
152+
but it won't effect the casing of `SETOF` and `TABLE` keywords in `SETOF type` and `TABLE (x int, y int)`.
153+
For PostgreSQL the recommended setting of this option is `lower`.
150154

151155
In BigQuery this also effects the names parametric types,
152156
for example `array<struct<x int64>>` will get formatted as `ARRAY<STRUCT<x INT64>>`.
153157

154-
**Experimental:** This option is still new and not thoroughly tested. You have been warned.
155-
156158
_Since 0.17.0_
157159

158160
- **`sqlIdentifierCase`**: `"upper" | "lower" | "preserve"` (default `"preserve"`)
159161

160162
Enforce case of unquoted identifier names.
161163

164+
This effects all identifiers except function names (see `sqlFunctionCase`).
165+
162166
Beware that in BigQuery unquoted identifiers are case-sensitive, so use of this option with BigQuery is not recommended.
163167

164168
**Experimental:** This option is still new and not thoroughly tested. You have been warned.

0 commit comments

Comments
 (0)