Skip to content

Commit

Permalink
Merge pull request #2473 from neondatabase/dprice-serverless-driver-l…
Browse files Browse the repository at this point in the history
…ocal-setup

docs: serverless driver local setup
  • Loading branch information
danieltprice authored Nov 15, 2024
2 parents 3faa421 + 5022502 commit 0623b48
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions content/docs/serverless/serverless-driver.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,10 +252,6 @@ Note that options **cannot** be supplied for individual queries within a transac
For additional details, see [transaction(...) function](https://github.com/neondatabase/serverless/blob/main/CONFIG.md#transaction-function).
### Advanced configuration options
For advanced configuration options, see [neonConfig configuration](https://github.com/neondatabase/serverless/blob/main/CONFIG.md#neonconfig-configuration), in the Neon serverless driver GitHub readme.
## Use the driver over WebSockets
The Neon serverless driver supports the [Pool and Client](https://github.com/neondatabase/serverless?tab=readme-ov-file#pool-and-client) constructors for querying over WebSockets.
Expand Down Expand Up @@ -375,6 +371,12 @@ For examples that demonstrate these points, see [Pool and Client](https://github
For advanced configuration options, see [neonConfig configuration](https://github.com/neondatabase/serverless/blob/main/CONFIG.md#neonconfig-configuration), in the Neon serverless driver GitHub readme.
## Developing locally with the Neon serverless driver
The Neon serverless driver enables you to query data over **HTTP** or **WebSockets** instead of TCP, even though Postgres does not natively support these connection methods. To use the Neon serverless driver locally, you must run a local instance of Neon's proxy and configure it to connect to your local Postgres database.
For a step-by-step guide to setting up a local environment, refer to this community guide: [Local Development with Neon](https://neon.tech/guides/local-development-with-neon). The guide demonstrates how to use a [community-developed Docker Compose file](https://github.com/TimoWilhelm/local-neon-http-proxy) to configure a local Postgres database and a Neon proxy service. This setup allows connections over both WebSockets and HTTP.
## Example applications
Explore the example applications that use the Neon serverless driver.
Expand Down

0 comments on commit 0623b48

Please sign in to comment.