pgxrequires a username and password in the connection string.
PGAdapter ignores these.
By default, PGAdapter disables SSL.pgxby default first
tries to connect with SSL enabled. Disabling SSL in the connection
request speeds up the connection process, as it requires one fewer round
trip.
connString:="postgres://uid:pwd@APPLICATION_HOST:PORT/DATABASE_NAME?sslmode=disable"ctx:=context.Background()conn,err:=pgx.Connect(ctx,connString)iferr!=nil{returnerr}deferconn.Close(ctx)vargreetingstringerr=conn.QueryRow(ctx,"select 'Hello world!' as hello").Scan(&greeting)iferr!=nil{returnerr}fmt.Printf("Greeting from Cloud Spanner PostgreSQL: %v\n",greeting)
Replace the following:
APPLICATION_HOST: the hostname or IP address of
the machine where PGAdapter is running. If running locally, you
can uselocalhost.
PORT: the port number where PGAdapter is
running. Change this in the connection string if PGAdapter is
running on a custom port. Otherwise, use the default port,5432.
Unix domain sockets
This section explains how to use Unix domain sockets to connect the
PostgreSQL pgx driver to a PostgreSQL-dialect database. Use Unix domain sockets for the lowest
possible latency.
To use Unix domain sockets, PGAdapter must be running on the
same host as the client application.
connString:="host=/tmpport=PORTdatabase=DATABASE_NAME"ctx:=context.Background()conn,err:=pgx.Connect(ctx,connString)iferr!=nil{returnerr}deferconn.Close(ctx)vargreetingstringerr=conn.QueryRow(ctx,"select 'Hello world!' as hello").Scan(&greeting)iferr!=nil{returnerr}fmt.Printf("Greeting from Cloud Spanner PostgreSQL: %v\n",greeting)
Replace the following:
/tmp: the default domain socket directory for
PGAdapter. This can be changed using the-dircommand line
argument.
PORT: the port number where PGAdapter is
running. Change this in the connection string if PGAdapter is
running on a custom port. Otherwise, use the default port,5432.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Connect pgx to a PostgreSQL-dialect database\n\nThis page explains how to connect the PostgreSQL pgx driver to a PostgreSQL-dialect database\nin Spanner. `pgx` is a Golang driver for PostgreSQL.\n\nVerify that PGAdapter is running on the same machine as the\napplication that is connecting using the PostgreSQL pgx driver.\n\nFor more information, see [Start PGAdapter](/spanner/docs/pgadapter-start).\n\n- `pgx` requires a username and password in the connection string. PGAdapter ignores these.\n- By default, PGAdapter disables SSL. `pgx` by default first tries to connect with SSL enabled. Disabling SSL in the connection request speeds up the connection process, as it requires one fewer round trip.\n\n connString := \"postgres://uid:pwd@\u003cvar translate=\"no\"\u003eAPPLICATION_HOST\u003c/var\u003e:\u003cvar translate=\"no\"\u003ePORT\u003c/var\u003e/\u003cvar translate=\"no\"\u003eDATABASE_NAME\u003c/var\u003e?sslmode=disable\"\n ctx := context.Background()\n conn, err := pgx.Connect(ctx, connString)\n if err != nil {\n return err\n }\n defer conn.Close(ctx)\n\n var greeting string\n err = conn.QueryRow(ctx, \"select 'Hello world!' as hello\").Scan(&greeting)\n if err != nil {\n return err\n }\n fmt.Printf(\"Greeting from Cloud Spanner PostgreSQL: %v\\n\", greeting)\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003eAPPLICATION_HOST\u003c/var\u003e: the hostname or IP address of the machine where PGAdapter is running. If running locally, you can use `localhost`.\n- \u003cvar translate=\"no\"\u003ePORT\u003c/var\u003e: the port number where PGAdapter is running. Change this in the connection string if PGAdapter is running on a custom port. Otherwise, use the default port, `5432`.\n\n### Unix domain sockets\n\nThis section explains how to use Unix domain sockets to connect the\nPostgreSQL pgx driver to a PostgreSQL-dialect database. Use Unix domain sockets for the lowest\npossible latency.\n\nTo use Unix domain sockets, PGAdapter must be running on the\nsame host as the client application. \n\n connString := \"host=\u003cvar translate=\"no\"\u003e/tmp\u003c/var\u003e port=\u003cvar translate=\"no\"\u003ePORT\u003c/var\u003e database=\u003cvar translate=\"no\"\u003eDATABASE_NAME\u003c/var\u003e\"\n ctx := context.Background()\n conn, err := pgx.Connect(ctx, connString)\n if err != nil {\n return err\n }\n defer conn.Close(ctx)\n\n var greeting string\n err = conn.QueryRow(ctx, \"select 'Hello world!' as hello\").Scan(&greeting)\n if err != nil {\n return err\n }\n fmt.Printf(\"Greeting from Cloud Spanner PostgreSQL: %v\\n\", greeting)\n\nReplace the following:\n\n- \u003cvar translate=\"no\"\u003e/tmp\u003c/var\u003e: the default domain socket directory for PGAdapter. This can be changed using the `-dir` command line argument.\n- \u003cvar translate=\"no\"\u003ePORT\u003c/var\u003e: the port number where PGAdapter is running. Change this in the connection string if PGAdapter is running on a custom port. Otherwise, use the default port, `5432`.\n\nWhat's next\n-----------\n\n- Learn more about [PGAdapter](/spanner/docs/pgadapter).\n- Learn more about [pgx Connection Options](https://github.com/GoogleCloudPlatform/pgadapter/blob/postgresql-dialect/docs/pgx.md) in the PGAdapter GitHub repository."]]
