Merge pull request #19 from usernameisnull/remove-pg-env

remove pg_ and PG env

Author: liubao68

.github/workflows/ci.yml

@@ -67,17 +67,17 @@ jobs:
       - name: Run tests
         env:
           IS_OPENGAUSS: true
-          PGDATABASE: pgx_test
-          PGPORT: 5432
-          PGUSER: gaussdb
-          PGHOST: localhost
-          POSTGRESQL_DATA_DIR: /var/lib/opengauss/data
-          GAUSSDB_TEST_CRATEDB_CONN_STRING: "host=localhost port=${{ env.PORT }} user=gaussdb dbname=pgx_test password=${{ env.OPENGAUSS_PASSWORD }}"
-          GAUSSDB_TEST_DATABASE: "host=localhost database=pgx_test user=pgx_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
-          GAUSSDB_TEST_MD5_PASSWORD_CONN_STRING: "host=localhost database=pgx_test user=pgx_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
-          GAUSSDB_TEST_PLAIN_PASSWORD_CONN_STRING: "host=localhost user=pgx_pw password=${{ env.OPENGAUSS_PASSWORD }}"
-          GAUSSDB_TEST_SCRAM_PASSWORD_CONN_STRING: "host=localhost user=pgx_scram database=pgx_test password=${{ env.OPENGAUSS_PASSWORD }}"
-          GAUSSDB_TEST_TCP_CONN_STRING: "host=localhost database=pgx_test user=pgx_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_DATABASE: gaussdbgo_test
+          GAUSSDB_PORT: 5432
+          GAUSSDB_USER: gaussdb
+          GAUSSDB_HOST: localhost
+          GAUSSDB_DATA_DIR: /var/lib/opengauss/data
+          GAUSSDB_TEST_CRATEDB_CONN_STRING: "host=localhost port=${{ env.PORT }} user=gaussdb dbname=gaussdbgo_test password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_TEST_DATABASE: "host=localhost database=gaussdbgo_test user=gaussdbgo_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_TEST_MD5_PASSWORD_CONN_STRING: "host=localhost database=gaussdbgo_test user=gaussdbgo_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_TEST_PLAIN_PASSWORD_CONN_STRING: "host=localhost user=gaussdbgo_pw password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_TEST_SCRAM_PASSWORD_CONN_STRING: "host=localhost user=gaussdbgo_scram database=gaussdbgo_test password=${{ env.OPENGAUSS_PASSWORD }}"
+          GAUSSDB_TEST_TCP_CONN_STRING: "host=localhost database=gaussdbgo_test user=gaussdbgo_md5 password=${{ env.OPENGAUSS_PASSWORD }}"
         # parallel testing is disabled because somehow parallel testing causes Github Actions to kill the runner.
         run: go test -parallel=1 -race ./...
 

CONTRIBUTING.md

@@ -14,8 +14,7 @@ that adds a dependency is no.
 
 gaussdb-go tests naturally require a GaussDB database. It will connect to the database specified in the `GAUSSDB_TEST_DATABASE`
 environment variable. The `GAUSSDB_TEST_DATABASE` environment variable can either be a URL or key-value pairs. In addition,
-the standard `PG*` environment variables will be respected. Consider using [direnv](https://github.com/direnv/direnv) to
-simplify environment variable handling.
+the standard `GAUSSDB_*` environment variables will be respected. 
 
 ### Using an Existing GaussDB Cluster
 
@@ -26,14 +25,14 @@ authentication methods).
 Create and setup a test database:
 
 ```
-gsql -c 'create database pgx_test DBCOMPATIBILITY 'PG'; create extension hstore;'
+gsql -c 'create database gaussdbgo_test DBCOMPATIBILITY 'PG'; create extension hstore;'
 ```
 
 ```
 Ensure your `GAUSSDB_TEST_DATABASE` environment variable points to the database you just created and run the tests.
 
 ```
-export GAUSSDB_TEST_DATABASE="host='your gaussdb host' database=pgx_test"
+export GAUSSDB_TEST_DATABASE="host='your gaussdb host' database=gaussdbgo_test"
 go test ./...
 ```
 
@@ -45,20 +44,20 @@ The following environment variables need to be set both for initial setup and wh
 highly recommended). Depending on your platform, you may need to change the host for `GAUSSDB_TEST_UNIX_SOCKET_CONN_STRING`.
 
 ```
-export PGPORT=5015
-export PGUSER=root
-export PGDATABASE=pgx_test
-export POSTGRESQL_DATA_DIR=GaussDB
-
-export GAUSSDB_TEST_DATABASE="host=127.0.0.1 database=pgx_test user=pgx_md5 password=secret"
-export GAUSSDB_TEST_UNIX_SOCKET_CONN_STRING="host=/private/tmp database=pgx_test"
-export GAUSSDB_TEST_TCP_CONN_STRING="host=127.0.0.1 database=pgx_test user=pgx_md5 password=secret"
-export GAUSSDB_TEST_SCRAM_PASSWORD_CONN_STRING="host=127.0.0.1 user=pgx_scram password=secret database=pgx_test"
-export GAUSSDB_TEST_MD5_PASSWORD_CONN_STRING="host=127.0.0.1 database=pgx_test user=pgx_md5 password=secret"
-export GAUSSDB_TEST_PLAIN_PASSWORD_CONN_STRING="host=127.0.0.1 user=pgx_pw password=secret"
-export GAUSSDB_TEST_TLS_CONN_STRING="host=localhost user=pgx_ssl password=secret sslmode=verify-full sslrootcert=`pwd`/.testdb/ca.pem"
+export GAUSSDB_PORT=5015
+export GAUSSDB_USER=root
+export GAUSSDB_DATABASE=gaussdbgo_test
+export GAUSSDB_DATA_DIR=/var/lib/opengauss/data
+
+export GAUSSDB_TEST_DATABASE="host=127.0.0.1 database=gaussdbgo_test user=gaussdbgo_md5 password=secret"
+export GAUSSDB_TEST_UNIX_SOCKET_CONN_STRING="host=/private/tmp database=gaussdbgo_test"
+export GAUSSDB_TEST_TCP_CONN_STRING="host=127.0.0.1 database=gaussdbgo_test user=gaussdbgo_md5 password=secret"
+export GAUSSDB_TEST_SCRAM_PASSWORD_CONN_STRING="host=127.0.0.1 user=gaussdbgo_scram password=secret database=gaussdbgo_test"
+export GAUSSDB_TEST_MD5_PASSWORD_CONN_STRING="host=127.0.0.1 database=gaussdbgo_test user=gaussdbgo_md5 password=secret"
+export GAUSSDB_TEST_PLAIN_PASSWORD_CONN_STRING="host=127.0.0.1 user=gaussdbgo_pw password=secret"
+export GAUSSDB_TEST_TLS_CONN_STRING="host=localhost user=gaussdbgo_ssl password=secret sslmode=verify-full sslrootcert=`pwd`/.testdb/ca.pem"
 export GAUSSDB_SSL_PASSWORD=certpw
-export GAUSSDB_TEST_TLS_CLIENT_CONN_STRING="host=localhost user=pgx_sslcert sslmode=verify-full sslrootcert=`pwd`/.testdb/ca.pem database=pgx_test sslcert=`pwd`/.testdb/pgx_sslcert.crt sslkey=`pwd`/.testdb/pgx_sslcert.key"
+export GAUSSDB_TEST_TLS_CLIENT_CONN_STRING="host=localhost user=gaussdbgo_sslcert sslmode=verify-full sslrootcert=`pwd`/.testdb/ca.pem database=gaussdbgo_test sslcert=`pwd`/.testdb/gaussdbgo_sslcert.crt sslkey=`pwd`/.testdb/gaussdbgo_sslcert.key"
 ```
 
 Create a new database cluster.
@@ -67,7 +66,7 @@ Create a new database cluster.
 initdb --locale=en_US -E UTF-8 --username=postgres .testdb/$POSTGRESQL_DATA_DIR
 
 echo "listen_addresses = '127.0.0.1'" >> .testdb/$POSTGRESQL_DATA_DIR/GaussDB.conf
-echo "port = $PGPORT" >> .testdb/$POSTGRESQL_DATA_DIR/GaussDB.conf
+echo "port = $GAUSSDB_PORT" >> .testdb/$POSTGRESQL_DATA_DIR/GaussDB.conf
 cat testsetup/postgresql_ssl.conf >> .testdb/$POSTGRESQL_DATA_DIR/GaussDB.conf
 cp testsetup/pg_hba.conf .testdb/$POSTGRESQL_DATA_DIR/pg_hba.conf
 
@@ -101,7 +100,7 @@ psql --no-psqlrc -f testsetup/postgresql_setup.sql
 
 ### Optional Tests
 
-gaussdb-go supports multiple connection types and means of authentication. These tests are optional. They will only run if the
-appropriate environment variables are set. In addition, there may be tests specific to particular GaussDB versions,
+gaussdb-go supports multiple connection types and means of authentication. These tests are optional. They will only run 
+if theappropriate environment variables are set. In addition, there may be tests specific to particular GaussDB versions,
 non-GaussDB servers (e.g. CockroachDB), or connection poolers (e.g. PgBouncer). `go test ./... -v | grep SKIP` to see
 if any tests are being skipped.

ci/initialize_database.sh

@@ -19,7 +19,7 @@ fi
 
 # verify_sql_user_connection: verify that the username and password created using the SQL file can connect to the database.
 function verify_sql_created_user_connection() {
-  docker exec -i ${TTY_FLAG} "${container_name}" bash -c "su - omm -c 'gsql -U pgx_md5 -p ${port} -W${password} -d pgx_test -c \"select version(); show server_version;\"'"
+  docker exec -i ${TTY_FLAG} "${container_name}" bash -c "su - omm -c 'gsql -U gaussdbgo_md5 -p ${port} -W${password} -d gaussdbgo_test -c \"select version(); show server_version;\"'"
 }
 
 sleep ${interval_check_time}
@@ -42,7 +42,7 @@ while [ $retry_count -lt $max_retries ]; do
     if [ $status -eq 0 ]; then
       # replace password
       sudo sed -i "s/'{{OPENGAUSS_PASSWORD}}'/'${password}'/" "${mounted_dir}/${sql_file}"
-      docker exec -i ${TTY_FLAG} "${container_name}" bash -c "su - omm -c 'gsql -U omm -c \"CREATE DATABASE pgx_test DBCOMPATIBILITY 'pg';\" -f ${mounted_dir}/${sql_file}'"
+      docker exec -i ${TTY_FLAG} "${container_name}" bash -c "su - omm -c 'gsql -U omm -c \"CREATE DATABASE gaussdbgo_test DBCOMPATIBILITY 'pg';\" -f ${mounted_dir}/${sql_file}'"
       echo "Database initialization completed."
       verify_sql_created_user_connection
       exit 0

conn_test.go

@@ -1010,15 +1010,15 @@ func TestLoadTypeSameNameInDifferentSchemas(t *testing.T) {
 		require.NoError(t, err)
 		defer tx.Rollback(ctx)
 
-		_, err = tx.Exec(ctx, `create schema pgx_a;
-create type pgx_a.point as (a text, b text);
-create schema pgx_b;
-create type pgx_b.point as (c text);
+		_, err = tx.Exec(ctx, `create schema gaussdbgo_a;
+create type gaussdbgo_a.point as (a text, b text);
+create schema gaussdbgo_b;
+create type gaussdbgo_b.point as (c text);
 `)
 		require.NoError(t, err)
 
 		// Register types
-		for _, typename := range []string{"pgx_a.point", "pgx_b.point"} {
+		for _, typename := range []string{"gaussdbgo_a.point", "gaussdbgo_b.point"} {
 			// Obviously using conn while a tx is in use and registering a type after the connection has been established are
 			// really bad practices, but for the sake of convenience we do it in the test here.
 			dt, err := conn.LoadType(ctx, typename)
@@ -1037,7 +1037,7 @@ create type pgx_b.point as (c text);
 
 		var a aPoint
 		var b bPoint
-		err = tx.QueryRow(ctx, `select '(foo,bar)'::pgx_a.point, '(baz)'::pgx_b.point`).Scan(&a, &b)
+		err = tx.QueryRow(ctx, `select '(foo,bar)'::gaussdbgo_a.point, '(baz)'::gaussdbgo_b.point`).Scan(&a, &b)
 		require.NoError(t, err)
 		require.Equal(t, aPoint{"foo", "bar"}, a)
 		require.Equal(t, bPoint{"baz"}, b)

examples/chat/README.md

@@ -8,13 +8,13 @@ between them.
 
 ## Connection configuration
 
-The database connection is configured via DATABASE_URL and standard GaussDB environment variables (PGHOST, PGUSER, etc.)
+The database connection is configured via DATABASE_URL and standard GaussDB environment variables (GAUSSDB_HOST, GAUSSDB_USER, etc.)
 
 You can either export them then run chat:
 
-    export PGHOST=/private/tmp
+    export GAUSSDB_HOST=/private/tmp
     ./chat
 
 Or you can prefix the chat execution with the environment variables:
 
-    PGHOST=/private/tmp ./chat
+    GAUSSDB_HOST=/private/tmp ./chat

examples/todo/README.md

@@ -19,16 +19,16 @@ Build todo:
 
 ## Connection configuration
 
-The database connection is configured via DATABASE_URL and standard GaussDB environment variables (PGHOST, PGUSER, etc.)
+The database connection is configured via DATABASE_URL and standard GaussDB environment variables (GAUSSDB_HOST, GAUSSDB_USER, etc.)
 
 You can either export them then run todo:
 
-    export PGDATABASE=todo
+    export GAUSSDB_DATABASE=todo
     ./todo list
 
 Or you can prefix the todo execution with the environment variables:
 
-    PGDATABASE=todo ./todo list
+    GAUSSDB_DATABASE=todo ./todo list
 
 ## Add a todo item
 
@@ -55,7 +55,7 @@ Or you can prefix the todo execution with the environment variables:
     CREATE TABLE
     Time: 6.363 ms
     jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ go build
-    jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ export PGDATABASE=todo
+    jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ export GAUSSDB_DATABASE=todo
     jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ ./todo list
     jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ ./todo add 'Learn Go'
     jack@hk-47~/dev/go/src/github.com/HuaweiCloudDeveloper/gaussdb-go/examples/todo$ ./todo list

gaussdbconn/config.go

@@ -152,6 +152,7 @@ func isAbsolutePath(path string) bool {
 func NetworkAddress(host string, port uint16) (network, address string) {
 	if isAbsolutePath(host) {
 		network = "unix"
+		// opengauss still use this name, don't change it.
 		address = filepath.Join(host, ".s.PGSQL.") + strconv.FormatInt(int64(port), 10)
 	} else {
 		network = "tcp"
@@ -161,7 +162,7 @@ func NetworkAddress(host string, port uint16) (network, address string) {
 }
 
 // ParseConfig builds a *Config from connString with similar behavior to the GaussDB standard C library libpq. It
-// uses the same defaults as libpq (e.g. port=5432) and understands most PG* environment variables. ParseConfig closely
+// uses the same defaults as libpq (e.g. port=5432) and understands most GAUSSDB_* environment variables. ParseConfig closely
 // matches the parsing behavior of libpq. connString may either be in URL format or keyword = value format.
 //
 //	# Example Keyword/Value
@@ -184,22 +185,22 @@ func NetworkAddress(host string, port uint16) (network, address string) {
 // ParseConfig currently recognizes the following environment variable and their parameter key word equivalents passed
 // via database URL or keyword/value:
 //
-//	PGHOST
-//	PGPORT
-//	PGDATABASE
-//	PGUSER
-//	PGPASSWORD
-//	PGPASSFILE
-//	PGSERVICE
-//	PGSERVICEFILE
-//	PGSSLMODE
-//	PGSSLCERT
-//	PGSSLKEY
-//	PGSSLROOTCERT
-//	PGSSLPASSWORD
-//	PGAPPNAME
-//	PGCONNECT_TIMEOUT
-//	PGTARGETSESSIONATTRS
+//	GAUSSDB_HOST
+//	GAUSSDB_PORT
+//	GAUSSDB_DATABASE
+//	GAUSSDB_USER
+//	GAUSSDB_PASSWORD
+//	GAUSSDB_PASSFILE
+//	GAUSSDB_SERVICE
+//	GAUSSDB_SERVICEFILE
+//	GAUSSDB_SSLMODE
+//	GAUSSDB_SSLCERT
+//	GAUSSDB_SSLKEY
+//	GAUSSDB_SSLROOTCERT
+//	GAUSSDB_SSLPASSWORD
+//	GAUSSDB_APPNAME
+//	GAUSSDB_CONNECT_TIMEOUT
+//	GAUSSDB_TARGETSESSIONATTRS
 //
 // The sslmode "prefer" (the default), sslmode "allow", and multiple hosts are implemented via the Fallbacks field of
 // the Config struct. If TLSConfig is manually changed it will not affect the fallbacks. For example, in the case of
@@ -211,7 +212,7 @@ func NetworkAddress(host string, port uint16) (network, address string) {
 // In addition, ParseConfig accepts the following options:
 //
 //   - servicefile.
-//     libpq only reads servicefile from the PGSERVICEFILE environment variable. ParseConfig accepts servicefile as a
+//     libpq only reads servicefile from the GAUSSDB_SERVICEFILE environment variable. ParseConfig accepts servicefile as a
 //     part of the connection string.
 func ParseConfig(connString string) (*Config, error) {
 	var parseConfigOptions ParseConfigOptions
@@ -420,23 +421,23 @@ func parseEnvSettings() map[string]string {
 	settings := make(map[string]string)
 
 	nameMap := map[string]string{
-		"PGHOST":               "host",
-		"PGPORT":               "port",
-		"PGDATABASE":           "database",
-		"PGUSER":               "user",
-		"PGPASSWORD":           "password",
-		"PGPASSFILE":           "passfile",
-		"PGAPPNAME":            "application_name",
-		"PGCONNECT_TIMEOUT":    "connect_timeout",
-		"PGSSLMODE":            "sslmode",
-		"PGSSLKEY":             "sslkey",
-		"PGSSLCERT":            "sslcert",
-		"PGSSLSNI":             "sslsni",
-		"PGSSLROOTCERT":        "sslrootcert",
-		"PGSSLPASSWORD":        "sslpassword",
-		"PGTARGETSESSIONATTRS": "target_session_attrs",
-		"PGSERVICE":            "service",
-		"PGSERVICEFILE":        "servicefile",
+		"GAUSSDB_HOST":               "host",
+		"GAUSSDB_PORT":               "port",
+		"GAUSSDB_DATABASE":           "database",
+		"GAUSSDB_USER":               "user",
+		"GAUSSDB_PASSWORD":           "password",
+		"GAUSSDB_PASSFILE":           "passfile",
+		"GAUSSDB_APPNAME":            "application_name",
+		"GAUSSDB_CONNECT_TIMEOUT":    "connect_timeout",
+		"GAUSSDB_SSLMODE":            "sslmode",
+		"GAUSSDB_SSLKEY":             "sslkey",
+		"GAUSSDB_SSLCERT":            "sslcert",
+		"GAUSSDB_SSLSNI":             "sslsni",
+		"GAUSSDB_SSLROOTCERT":        "sslrootcert",
+		"GAUSSDB_SSLPASSWORD":        "sslpassword",
+		"GAUSSDB_TARGETSESSIONATTRS": "target_session_attrs",
+		"GAUSSDB_SERVICE":            "service",
+		"GAUSSDB_SERVICEFILE":        "servicefile",
 	}
 
 	for envname, realname := range nameMap {