Guide on how to connect to PostgreSQL Server (not Docker Image) #87
Conversation
Added guide on how to connect to PostgreSQL standalone server
| @@ -4,9 +4,14 @@ In Serverpod the connection details and password for the database are stored ins | |||
|
|
|||
| Serverpod automatically establishes a connection to the Postgresql instance by using these configuration details when you start the server. | |||
|
|
|||
|
|
|||
| ## Connecting to a Postgresql Docker Image | |||
There was a problem hiding this comment.
Suggestion: Remove this header.
The details in this section are general for all connection types regardless of whether we are connecting to a Postgres instance in a docker container or if it is running somewhere else.
The information about how to connect to the Postgresql docker image is outlined in the Development database header.
This section should still be kept general.
|
|
||
| ## Connecting to a Postgresql Server Instance | ||
|
|
||
| Connecting to a Postgresql Server Instance is similar to connecting to a Docker Image, but there are some prerequisites to take into account: |
There was a problem hiding this comment.
NIT (Non blocking):
| Connecting to a Postgresql Server Instance is similar to connecting to a Docker Image, but there are some prerequisites to take into account: | |
| Connecting to a Postgresql Server Instance is similar to connecting to a Docker Image, but there are some prerequisites to take into consideration: |
| - Making sure that the machine/server allows incoming traffic | ||
| - Creating a Postgresql user and database | ||
|
|
||
| You can connect to Postgresql server that you have installed on your local machine, a self-hosted one, Google Cloud SQL, AWS RDS or SQL Server, or any other 3rd party service. |
There was a problem hiding this comment.
Suggestion: Improve the start of the sentence and clarify that any service is supported.
The start of this sentence seems a little strange. How about:
Serverpod supports connecting to any running Postgresql server, whether hosted on your local machine in Google Cloud SQL or any other 3rd party service.
There was a problem hiding this comment.
Maybe this sentence should be directly under the Connecting to a Postgresql Server Instance header as well, and then we list the prerequisites below. "Sales pitch" before instructions?
|
|
||
| ### Connecting to a Local Postgresql | ||
|
|
||
| If you want to connect to a local Postgresql Server (with the default setup) then the `development.yaml` will work just fine. The only thing you need to do is change the password in the `passwords.yaml`. |
There was a problem hiding this comment.
Suggestion: Add instructions around the specifying port.
The default port for Postgres is 5432; whenever I have a local instance of Postgres, it usually occupies that port. I think that needs to be changed as the default development.yaml specifies port 8090.
| Connecting to a Postgresql Server Instance is similar to connecting to a Docker Image, but there are some prerequisites to take into account: | ||
|
|
||
| - Making sure that the machine/server allows incoming traffic | ||
| - Creating a Postgresql user and database |
There was a problem hiding this comment.
Suggestion: Add instructions for how to create a user and a database.
This is the step that many people get stuck on, I think it would be good to have instructions on creating a database with a user with the right permissions.
That obsticle that Craig Labenz was fighting with in observable flutter
There was a problem hiding this comment.
I would recommend watching that part of the video and ensuring we answer all those questions.
| - Make sure to open any necessary ports on that machine | ||
| - Configure Postgresql Server to listen to all other connections (not only local once) in `postgresql.conf`: | ||
| ```bash | ||
| listen_addresses = '*' |
There was a problem hiding this comment.
Question: Are there any safety considerations to take into account here?
There was a problem hiding this comment.
Could you add a reference to instructions on best practices here?
| You can connect to a Google Cloud SQL Postgresql Instance in 2 ways: | ||
|
|
||
| - Setting up the Public IP Authorized networks (with your Serverpod server IP) and changing the database host string to the `Cloud SQL public IP` | ||
| - Using the Connection String if you are hosting your Serverpod server on Google Cloud Run and changing the database host string to the Cloud SQL: `/cloudsql/my-project:server-location:database-name/.s.PGSQL.5432` |
There was a problem hiding this comment.
Question: Most parts of the link that should be used are configured by the user. Does it make sense to clarify that these are user-provided as opposed to the constant parts such as .s.PGSQL.5432?
We could provide a small explanation on the user provided parts as well.
| - Using the Connection String if you are hosting your Serverpod server on Google Cloud Run and changing the database host string to the Cloud SQL: `/cloudsql/my-project:server-location:database-name/.s.PGSQL.5432` | |
| - Using the Connection String if you are hosting your Serverpod server on Google Cloud Run and changing the database host string to the Cloud SQL: `/cloudsql/<my-project>:<server-location>:<database-name>/.s.PGSQL.5432` |
There was a problem hiding this comment.
Same question for the AWS RDS link.
|
|
||
| :::info | ||
|
|
||
| If you are using the `isUnixSocket` don't forget to add **"/.s.PGSQL.5432"** to the end of the `host` IP address *otherwise your Google Cloud Run instance will not be able to connect to the database*. |
There was a problem hiding this comment.
Question: Should we leave /.s.PGSQL.5432 out of the string in the instructions, since it is not always required. Then provide a full link example in the info box here where it is?
| - Update your Serverpod `database` config to use the public IP, database name, and user. Also the database password in `passwords.yaml`. | ||
|
|
||
|
|
||
| ### Connecting to Google Cloud SQL |
There was a problem hiding this comment.
Question: More information around this seems to be explained in: https://github.com/serverpod/serverpod_docs/blob/main/docs/06-deployments/03-deploying-to-gcr-console.md#setup-the-database
Maybe we could refer to that section for more in-depth instructions?
We should also ensure that the information is matching in style.
Added guide on how to connect to PostgreSQL standalone server.
Files affected:
Update 01-connection.md
Solving Issue serverpod/serverpod#2015 (comment)