Skip to content

Commit 9f3381b

Browse files
docs: add note that startLocalProxy does not support SQL Server (#365)
1 parent 5c90de6 commit 9f3381b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -211,6 +211,11 @@ local proxy server that tunnels to the secured connection established
211211
using the `Connector.startLocalProxy()` method instead of
212212
`Connector.getOptions()`.
213213

214+
> [!NOTE]
215+
>
216+
> The `startLocalProxy()` method is currently only supported for MySQL and PostgreSQL
217+
> as it uses a Unix domain socket which SQL Server does not currently support.
218+
214219
This alternative approach enables usage of the Connector library with
215220
unsupported drivers such as [Prisma](https://www.prisma.io/). Here is an
216221
example on how to use it with its PostgreSQL driver:

0 commit comments

Comments
 (0)