Skip to content

Commit

Permalink
docs: add note that startLocalProxy does not support SQL Server (#365)
Browse files Browse the repository at this point in the history
  • Loading branch information
jackwotherspoon authored Jun 20, 2024
1 parent 5c90de6 commit 9f3381b
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -211,6 +211,11 @@ local proxy server that tunnels to the secured connection established
using the `Connector.startLocalProxy()` method instead of
`Connector.getOptions()`.

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

0 comments on commit 9f3381b

Please sign in to comment.