Table of Contents

connection

Usage: (connection)

Returns the current database connection (or throws if there is none)

create-table

Usage: (create-table name & specs)

Creates a table on the open database connection given a table name and
specs. Each spec is either a column spec: a vector containing a column
name and optionally a type and other constraints, or a table-level
constraint: a vector containing words that express the constraint. All
words used to describe the table may be supplied as strings or keywords.

delete-rows

Usage: (delete-rows table where-params)

Deletes rows from a table. where-params is a vector containing a string
providing the (optionally parameterized) selection criteria followed by
values for any parameters.

do-commands

Usage: (do-commands & commands)

Executes SQL commands on the open database connection.

do-prepared

Usage: (do-prepared sql & param-groups)

Executes an (optionally parameterized) SQL prepared statement on the
open database connection. Each param-group is a seq of values for all of
the parameters.

drop-table

Usage: (drop-table name)

Drops a table on the open database connection given its name, a string
or keyword

find-connection

Usage: (find-connection)

Returns the current database connection (or nil if there is none)

insert-records

Usage: (insert-records table & records)

Inserts records into a table. records are maps from strings or
keywords (identifying columns) to values.

insert-rows

Usage: (insert-rows table & rows)

Inserts complete rows into a table. Each row is a vector of values for
each of the table's columns in order.

insert-values

Usage: (insert-values table column-names & value-groups)

Inserts rows into a table with values for specified columns only.
column-names is a vector of strings or keywords identifying columns. Each
value-group is a vector containing a values for each column in
order. When inserting complete rows (all columns), consider using
insert-rows instead.

is-rollback-only

Usage: (is-rollback-only)

Returns true if the outermost transaction will rollback rather than
commit when complete

set-rollback-only

Usage: (set-rollback-only)

Marks the outermost transaction such that it will rollback rather than
commit when complete

transaction

Usage: (transaction & body)

Evaluates body as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If set-rollback-only is called within scope of the outermost
transaction, the entire transaction will be rolled back rather than
committed when complete.

update-or-insert-values

Usage: (update-or-insert-values table where-params record)

Updates values on selected rows in a table, or inserts a new row when no
existing row matches the selection criteria. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values.

update-values

Usage: (update-values table where-params record)

Updates values on selected rows in a table. where-params is a vector
containing a string providing the (optionally parameterized) selection
criteria followed by values for any parameters. record is a map from
strings or keywords (identifying columns) to updated values.

with-connection

Usage: (with-connection db-spec & body)

Evaluates body in the context of a new connection to a database then
closes the connection. db-spec is a map containing values for one of the
following parameter sets:

Factory:
  :factory     (required) a function of one argument, a map of params
  (others)     (optional) passed to the factory function in a map

DriverManager:
  :classname   (required) a String, the jdbc driver class name
  :subprotocol (required) a String, the jdbc subprotocol
  :subname     (required) a String, the jdbc subname
  (others)     (optional) passed to the driver as properties.

DataSource:
  :datasource  (required) a javax.sql.DataSource
  :username    (optional) a String
  :password    (optional) a String, required if :username is supplied

JNDI:
  :name        (required) a String or javax.naming.Name
  :environment (optional) a java.util.Map

with-query-results

Usage: (with-query-results results sql-params & body)

Executes a query, then evaluates body with results bound to a seq of the
results. sql-params is a vector containing a string providing
the (optionally parameterized) SQL query followed by values for any
parameters.

connection*

Usage: (connection*)

Returns the current database connection (or throws if there is none)

find-connection*

Usage: (find-connection*)

Returns the current database connection (or nil if there is none)

get-connection

Usage: (get-connection {:keys [factory classname subprotocol subname datasource username password name environment], :as db-spec})

Creates a connection to a database. db-spec is a map containing values
for one of the following parameter sets:

Factory:
  :factory     (required) a function of one argument, a map of params
  (others)     (optional) passed to the factory function in a map

DriverManager:
  :classname   (required) a String, the jdbc driver class name
  :subprotocol (required) a String, the jdbc subprotocol
  :subname     (required) a String, the jdbc subname
  (others)     (optional) passed to the driver as properties.

DataSource:
  :datasource  (required) a javax.sql.DataSource
  :username    (optional) a String
  :password    (optional) a String, required if :username is supplied

JNDI:
  :name        (required) a String or javax.naming.Name
  :environment (optional) a java.util.Map

print-sql-exception

Usage: (print-sql-exception stream exception)

Prints the contents of an SQLException to stream

print-sql-exception-chain

Usage: (print-sql-exception-chain stream exception)

Prints a chain of SQLExceptions to stream

print-update-counts

Usage: (print-update-counts stream exception)

Prints the update counts from a BatchUpdateException to stream

rollback

Usage: (rollback)
       (rollback val)

Accessor for the rollback flag on the current connection

throw-rollback

Usage: (throw-rollback e)

Sets rollback and throws a wrapped exception

transaction*

Usage: (transaction* func)

Evaluates func as a transaction on the open database connection. Any
nested transactions are absorbed into the outermost transaction. By
default, all database updates are committed together as a group after
evaluating the outermost body, or rolled back on any uncaught
exception. If rollback is set within scope of the outermost transaction,
the entire transaction will be rolled back rather than committed when
complete.

with-connection*

Usage: (with-connection* db-spec func)

Evaluates func in the context of a new connection to a database then
closes the connection.

with-query-results*

Usage: (with-query-results* [sql & params :as sql-params] func)

Executes a query, then evaluates func passing in a seq of the results as
an argument. The first argument is a vector containing the (optionally
parameterized) sql query string followed by values for any parameters.