psql.core — net.clojars.savya/psql-clj 2.3.0

Use PostgreSQL from Clojure with connection parameter defaults from PGDATABASE, PGHOST, PGPORT, and PGUSER. Read the password from ~/.pgpass when it is available.

box clj

(box obj)

(box p1 p2)

(box x1 y1 x2 y2)

Create a PGbox object.

circle clj

(circle obj)

(circle center-point r)

(circle x y r)

Create a PGcircle object.

close! clj

(close! {:keys [datasource]})

Close db-spec if possible. Return true if the datasource can close and is closed.

default-spec clj

(default-spec)

Set defaults like the psql command line tool. Use the username for the user and dbname. Do not set a host.

env-spec clj

(env-spec {:keys [PGDATABASE PGHOST PGPORT PGUSER PGTARGETSESSIONATTRS]
           :as env})

Get a db spec from libpq PG* environment variables. Use pgjdbc property names where needed. PGHOSTADDR, PGCLIENTENCODING, PGREQUIREPEER, PGSSLCRL/SNI/min-max-proto, and the Unix-socket default host are unsupported.

getenv->map clj

(getenv->map)

(getenv->map env)

Keywordize an environment-style map. With no argument, read (System/getenv). Accept any map-like input. Callers can pass a plain map in tests.

interval clj

(interval &
          {:keys [years months days hours minutes seconds]
           :or {years 0 months 0 days 0 hours 0 minutes 0 seconds 0.0}})

Create a PGinterval. Example: (pg/interval :hours 2)

jsonpath clj

(jsonpath s)

Create a PostgreSQL jsonpath value.

line clj

(line obj)

(line p1 p2)

(line x1 y1 x2 y2)

Create a PGline object.

lseg clj

(lseg obj)

(lseg p1 p2)

(lseg x1 y1 x2 y2)

Create a PGlseg object.

macaddr clj

(macaddr s)

Create a PostgreSQL macaddr (6-byte MAC address) value.

macaddr8 clj

(macaddr8 s)

Create a PostgreSQL macaddr8 (8-byte EUI-64 MAC address) value.

money clj

(money amount)

Create a PGmoney object.

object clj

(object type value)

Create a custom PGobject. Example: (pg/object "json" "{}")

path clj

(path obj)

(path points open?)

Create a PGpath object.

pg-lsn clj

(pg-lsn s)

Create a PostgreSQL pg_lsn (log sequence number) value.

point clj

(point obj)

(point x y)

Create a PGpoint object.

polygon clj

(polygon points-or-str)

Create a PGpolygon object.

pool clj

(pool & rest)

spec clj

(spec & {:keys [password service env] :as opts})

Create a PostgreSQL database spec with libpq-style layers. Explicit options override a :service/PGSERVICE definition. The service definition overrides ordinary PG* environment values. Environment values override built-in defaults. Accept overrides: (spec :dbname ... :host ... :port ... :user ... :password ...)

Password precedence uses the same layers, then uses ~/.pgpass. Pass :env with a plain environment map for repeatable tests.

tables clj

(tables db)

Return the set of table names (as keywords) visible in the database DB.

tsquery clj

(tsquery s)

Create a PostgreSQL tsquery (full-text query) value.

tsvector clj

(tsvector s)

Create a PostgreSQL tsvector (full-text document) value.

xml clj

(xml s)

Create a PostgreSQL XML object.