Skip to content

Commit 29dd667

Browse files
committed
Document the support of PostgreSQL, MariaDB, MySQL in README
1 parent 697a1bb commit 29dd667

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,9 @@ The plugin provides the following parsers:
8989

9090
- `sqlite`
9191
- `bigquery`
92+
- `postgresql` (**experimental! expect crashes**)
93+
- `mysql` (**experimental! expect crashes**)
94+
- `mariadb` (**experimental! expect crashes**)
9295

9396
## Configuration
9497

@@ -107,6 +110,18 @@ Currently this plugin supports two SQL dialects:
107110
- **SQLite** - full support.
108111
- **BigQuery** - full support.
109112

113+
It also has experimental support for the following dialects:
114+
115+
- PostgreSQL
116+
- MySQL
117+
- MariaDB
118+
119+
The main limitation is that [the parser][sql-parser-cst] does not support full syntax of
120+
these dialects. One should expect the parser to crash for syntax that's more specific to
121+
these dialects. But as long as the parsing succeeds, the formatting should also succeed.
122+
Mainly one can expect the formatting of SELECT statements to work. But beyond that you should
123+
keep your expectations low. You have been warned.
124+
110125
The specifics of the [SQL formatting style][STYLE_GUIDE] are still very much subject to change.
111126
Though the general principles should be mostly in place by now.
112127

0 commit comments

Comments
 (0)