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

Add docs for connecting to postgres with keyword/value connection

Browse source 
strings.
This commit is contained in:
Hitesh Jasani 2013-12-03 20:13:40 -05:00
commit 20661c9c46
1 changed files with 15 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

15
lib/impure/db_postgres.nim
View file

@ -180,6 +180,21 @@ proc Open*(connection, user, password, database: string): TDbConn {.
tags: [FDb].} = tags: [FDb].} =
## opens a database connection. Raises `EDb` if the connection could not ## opens a database connection. Raises `EDb` if the connection could not
## be established. ## be established.
##
## Clients can also use Postgres keyword/value connection strings to
## connect.
##
## Example:
##
## .. code-block:: nimrod
##
## con = Open("", "", "", "host=localhost port=5432 dbname=mydb")
##
## See http://www.postgresql.org/docs/current/static/libpq-connect.html#LIBPQ-CONNSTRING
## for more information.
##
## Note that the connection parameter is not used but exists to maintain
## the nimrod db api.
result = PQsetdbLogin(nil, nil, nil, nil, database, user, password) result = PQsetdbLogin(nil, nil, nil, nil, database, user, password)
if PQStatus(result) != CONNECTION_OK: dbError(result) # result = nil if PQStatus(result) != CONNECTION_OK: dbError(result) # result = nil