branch: elpa/pg
commit 9c0c54e02aa3c8a0a0fe3dc1d22bb8276bdf566f
Author: Eric Marsden <[email protected]>
Commit: Eric Marsden <[email protected]>
Documentation: move from pg-connect to pg-connect-plist
---
doc/src/API.md | 2 +-
doc/src/quickstart.md | 6 +++---
doc/src/usage.md | 2 +-
3 files changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/src/API.md b/doc/src/API.md
index 62b3e08d524..092b0d4a1ad 100644
--- a/doc/src/API.md
+++ b/doc/src/API.md
@@ -288,7 +288,7 @@ to do it (thanks to Gene Selkov, Jr. for the description):
2. Now that you have a running ssh session, you can point pg.el to the local
host at the port number
which you specified in step 1. For example,
- (pg-connect "dbname" "user" "password" "localhost" 3333)
+ (pg-connect-plist "dbname" "user" :password "password" :host
"localhost" :port 3333)
You can omit the port argument if you chose 5432 as the local end of the
tunnel, since pg.el
defaults to this value.
diff --git a/doc/src/quickstart.md b/doc/src/quickstart.md
index 18287cf10e6..5a4b325a756 100644
--- a/doc/src/quickstart.md
+++ b/doc/src/quickstart.md
@@ -35,7 +35,7 @@ and authenticate with the database from Emacs:
```lisp
ELISP> (require 'pg)
pg
-ELISP> (defvar *pg* (pg-connect "pgeltestdb" "pgeltestuser" "pgeltest"
"localhost" 5432))
+ELISP> (defvar *pg* (pg-connect-plist "pgeltestdb" "pgeltestuser" :password
"pgeltest" :host "localhost"))
*pg*
```
~~~
@@ -63,7 +63,7 @@ podman run -d --name pgsql \
then connect from Emacs with
- ELISP> (pg-connect "pgeltestdb" "pgeltestuser" "pgeltest" "localhost" 5432)
+ ELISP> (pg-connect-plist "pgeltestdb" "pgeltestuser" :password "pgeltest"
:host "localhost")
or connect over a local Unix socket
@@ -74,7 +74,7 @@ Now some simple interactions with the database:
```lisp
ELISP> (pg-backend-version *pg*)
-"PostgreSQL 16.1 (Debian 16.1-1) on x86_64-pc-linux-gnu, compiled by gcc
(Debian 13.2.0-6) 13.2.0, 64-bit"
+"PostgreSQL 18.1 (Debian 18.1-1) on x86_64-pc-linux-gnu, compiled by gcc
(Debian 15.2.0-8) 15.2.0, 64-bit"
ELISP> (let ((res (pg-exec *pg* "SELECT 42, 1.23")))
(pg-result res :tuple 0))
(42 1.23)
diff --git a/doc/src/usage.md b/doc/src/usage.md
index 5106297a4e9..cea0373e09e 100644
--- a/doc/src/usage.md
+++ b/doc/src/usage.md
@@ -12,7 +12,7 @@ ELISP> (require 'cl-lib)
cl-lib
ELISP> (require 'pg)
pg
-ELISP> (defvar *pg* (pg-connect "pgeltestdb" "pgeltestuser" "pgeltest"
"localhost" 5432))
+ELISP> (defvar *pg* (pg-connect-plist "pgeltestdb" "pgeltestuser" :password
"pgeltest" :host "localhost"))
*pg*
```
~~~
