jyapayne/Nim
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

db_postgres document how to use it with unix socket (#15187)

Browse source
This commit is contained in:
Juan Carlos 2020-08-17 03:39:58 -03:00 • committed by GitHub
commit c9fdad2c21
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 22 additions and 2 deletions
Download patch file Download diff file Expand all files Collapse all files

24
lib/impure/db_postgres.nim
View file

@ -37,6 +37,26 @@
## VALUES ($1, $2, $3)""", ## VALUES ($1, $2, $3)""",
## 3) ## 3)
## ##
##
## Unix Socket
## ===========
##
## Using Unix sockets instead of TCP connection can
## `improve performance up to 30% ~ 175% for some operations <https://momjian.us/main/blogs/pgblog/2012.html#June_6_2012>`_.
##
## To use Unix sockets with `db_postgres`, change the server address to the socket file path:
##
## .. code-block:: Nim
## import db_postgres ## Change "localhost" or "127.0.0.1" to the socket file path
## let db = db_postgres.open("/run/postgresql", "user", "password", "database")
## echo db.getAllRows(sql"SELECT version();")
## db.close()
##
## The socket file path is operating system specific and distribution specific,
## additional configuration may or may not be needed on your `postgresql.conf`.
## The Postgres server must be on the same computer and only works for Unix-like operating systems.
##
##
## Examples ## Examples
## ======== ## ========
## ##
@ -491,7 +511,7 @@ proc tryInsert*(db: DbConn, query: SqlQuery,pkName: string,
args: varargs[string, `$`]): int64 args: varargs[string, `$`]): int64
{.tags: [WriteDbEffect], since: (1, 3).}= {.tags: [WriteDbEffect], since: (1, 3).}=
## executes the query (typically "INSERT") and returns the ## executes the query (typically "INSERT") and returns the
## generated ID for the row or -1 in case of an error. ## generated ID for the row or -1 in case of an error.
var x = pqgetvalue(setupQuery(db, SqlQuery(string(query) & " RETURNING " & pkName), var x = pqgetvalue(setupQuery(db, SqlQuery(string(query) & " RETURNING " & pkName),
args), 0, 0) args), 0, 0)
if not isNil(x): if not isNil(x):
@ -503,7 +523,7 @@ proc insert*(db: DbConn, query: SqlQuery, pkName: string,
args: varargs[string, `$`]): int64 args: varargs[string, `$`]): int64
{.tags: [WriteDbEffect], since: (1, 3).} = {.tags: [WriteDbEffect], since: (1, 3).} =
## executes the query (typically "INSERT") and returns the ## executes the query (typically "INSERT") and returns the
## generated ID ## generated ID
result = tryInsertID(db, query, args) result = tryInsertID(db, query, args)
if result < 0: dbError(db) if result < 0: dbError(db)