Permalink
Find file
Fetching contributors…
Cannot retrieve contributors at this time
1288 lines (1082 sloc) 49.5 KB
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN" "http://www.w3.org/TR/html4/strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>Postmodern reference manual</title>
<link rel="stylesheet" type="text/css" href="style.css"/>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
</head>
<body>
<h1>Postmodern reference manual</h1>
<p>This is the reference manual for the component named
<code>postmodern</code>, which is part of a <a
href="index.html">library</a> of the same name.</p>
<p>Note that this package also exports the <a
href="cl-postgres.html#database-connection"><code>database-connection</code></a>
and <a
href="cl-postgres.html#database-error"><code>database-error</code></a>
types from <a href="cl-postgres.html">CL-postgres</a> and a few
operators from <a href="s-sql.html">S-SQL</a>.</p>
<p><a href="#query"><code>query</code></a>, <a
href="#execute"><code>execute</code></a>, and any other function
that would logically need to communicate with the database will
raise a condition of the type <a
href="cl-postgres.html#conditions"><code>database-error</code></a>
when something goes wrong. As a special case, errors that break
the connection (socket errors, database shutdowns) will be raised
as subtypes of <a
href="cl-postgres.html#database-connection-error"><code>database-connection-error</code></a>,
providing a <code>:reconnect</code> restart to re-try the
operation that encountered to the error.</p>
<h2>Contents</h2>
<ol>
<li><a href="#connecting">Connecting</a></li>
<li><a href="#querying">Querying</a></li>
<li><a href="#inspect">Inspecting the database</a></li>
<li><a href="#daos">Database access objects</a></li>
<li><a href="#tabledef">Table definition and creation</a></li>
<li><a href="#schemata">Schemata</a></li>
<li><a href="#index">Symbol-index</a></li>
</ol>
<h2><a name="connecting"></a>Connecting</h2>
<p class="def">
<span>class</span>
<a name="database-connection"></a>
database-connection
</p>
<p class="desc">Objects of this type represent database connections.</p>
<p class="def">
<span>function</span>
<a name="connect"></a>
connect (database user password host &amp;key (port 5432) pooled-p use-ssl)
<br/>&#8594; database-connection
</p>
<p class="desc">Create a new database connection for the given
<code>user</code> and the <code>database</code>. Port will default
to 5432, which is where most PostgreSQL servers are running. If
<code>pooled-p</code> is <code>T</code>, a connection will be taken
from a pool of connections of this type, if one is available there,
and when the connection is disconnected it will be put back into this
pool instead. <code>use-ssl</code> can be <code>:no</code>,
<code>:yes</code>, or <code>:try</code>, as in <a
href="cl-postgres.html#open-database"><code>open-database</code></a>,
and defaults to the value of <a
href="#*default-use-ssl*"><code>*default-use-ssl*</code></a>.</p>
<p class="def">
<span>variable</span>
<a name="*default-use-ssl*"></a>
*default-use-ssl*
</p>
<p class="desc">The default for <a
href="#connect"><code>connect</code></a>'s <code>use-ssl</code>
argument. This starts at <code>:no</code>. If you set it to
anything else, be sure to also load the <a
href="http://common-lisp.net/project/cl-plus-ssl/">CL+SSL</a>
library.</p>
<p class="def">
<span>method</span>
<a name="disconnect"></a>
disconnect (database-connection)
</p>
<p class="desc">Disconnects a normal database connection, or moves
a pooled connection into the pool.</p>
<p class="def">
<span>function</span>
<a name="connected-p"></a>
connected-p (database-connection)
<br/>&#8594; boolean
</p>
<p class="desc">Returns a boolean indicating whether the given
connection is still connected to the server.</p>
<p class="def">
<span>method</span>
<a name="reconnect"></a>
reconnect (database-connection)
</p>
<p class="desc">Reconnect a disconnected database connection. This
is not allowed for pooled connections &#x2015; after they are
disconnected they might be in use by some other process, and
should no longer be used.</p>
<p class="def">
<span>variable</span>
<a name="*database*"></a>
*database*
</p>
<p class="desc">Special variable holding the current database.
Most functions and macros operating on a database assume this
binds to a connected database.</p>
<p class="def">
<span>macro</span>
<a name="with-connection"></a>
with-connection (spec &amp;body body)
</p>
<p class="desc">Evaluates the <code>body</code> with <a
href="#*database*"><code>*database*</code></a> bound to a
connection as specified by <code>spec</code>, which should be list
that <a href="#connect"><code>connect</code></a> can be applied
to.</p>
<p class="def">
<span>macro</span>
<a name="call-with-connection"></a>
call-with-connection (spec thunk)
</p>
<p class="desc">The functional backend to <a
href="#with-connection"><code>with-connection</code></a>. Binds <a
href="#*database*"><code>*database*</code></a> to a new connection
as specified by <code>spec</code>, which should be a list that <a
href="#connect"><code>connect</code></a> can be applied to, and
runs the zero-argument function given as second argument in the
new environment. When the function returns or throws, the new
connection is disconnected.</p>
<p class="def">
<span>function</span>
<a name="connect-toplevel"></a>
connect-toplevel (database user password host &amp;key (port 5432))
</p>
<p class="desc">Bind the <a
href="#*database*"><code>*database*</code></a> to a new
connection. Use this if you only need one connection, or if you
want a connection for debugging from the REPL.</p>
<p class="def">
<span>function</span>
<a name="disconnect-toplevel"></a>
disconnect-toplevel ()
</p>
<p class="desc">Disconnect the <a
href="#*database*"><code>*database*</code></a>.</p>
<p class="def">
<span>function</span>
<a name="clear-connection-pool"></a>
clear-connection-pool ()
</p>
<p class="desc">Disconnect and remove all connections from the
connection pools.</p>
<p class="def">
<span>variable</span>
<a name="*max-pool-size*"></a>
*max-pool-size*
</p>
<p class="desc">Set the maximum amount of connections kept in a
<em>single</em> connection pool, where a pool consists of all the
stored connections with the exact same connect arguments. Defaults
to <code>NIL</code>, which means there is no maximum.</p>
<h2><a name="querying"></a>Querying</h2>
<p class="def">
<span>macro</span>
<a name="query"></a>
query (query &amp;rest args/format)
<br/>&#8594; result
</p>
<p class="desc">Execute the given <code>query</code>, which can be
either a string or an <a href="s-sql.html">S-SQL</a> form (list starting
with a keyword). If the query contains placeholders
(<code>$1</code>, <code>$2</code>, etc) their values can be given
as extra arguments. If one of these arguments is a keyword
occurring in the table below, it will not be used as a <code>query</code>
argument, but will determine the <code>format</code> in which the results
are returned instead. Any of the following formats can be used, with
the default being <code>:rows</code>:</p>
<table class="desc">
<tr><td><code>:none</code></td><td>Ignore the result values.</td></tr>
<tr><td><code>:lists</code>, <code>:rows</code></td><td>Return a
list of lists, each list containing the values for a
row.</td></tr>
<tr><td><code>:list</code>, <code>:row</code></td><td>Return a
single row as a list.</td></tr>
<tr><td><code>:alists</code></td><td>Return a list of alists which map column
names to values, with the names represented as
keywords.</td></tr>
<tr><td><code>:alist</code></td><td>Return a single row as an alist.</td></tr>
<tr><td><code>:str-alists</code></td><td>Like
<code>:alists</code>, but use the original column
names.</td></tr>
<tr><td><code>:str-alist</code></td><td>Return a single row as an alist, with
strings for names.</td></tr>
<tr><td><code>:plists</code></td><td>Return a list of plists which map column
names to values,with the names represented as keywords.</td></tr>
<tr><td><code>:plist</code></td><td>Return a single row as a plist.</td></tr>
<tr><td><code>:column</code></td><td>Return a single column as a list.</td></tr>
<tr><td><code>:single</code></td><td>Return a single value.</td></tr>
<tr><td><code>:single!</code></td><td>Like <code>:single</code>,
but raise an error when the number of selected rows is not equal
to 1.</td></tr>
<tr><td><code>(:dao type)</code></td><td>Return a list of DAOs of the given type. The names of the fields returned by the query must match slots in the DAO class the same way as with <a href="#query-dao"><code>query-dao</code></a>.</td></tr>
<tr><td><code>(:dao type :single)</code></td><td>Return a single DAO of the given type.</td></tr>
</table>
<p class="desc">If the database returns information about the
amount rows that were affected, such as with updating or deleting
queries, this is returned as a second value.</p>
<p class="def">
<span>macro</span>
<a name="execute"></a>
execute (query &amp;rest args)
</p>
<p class="desc">Like <a href="#query"><code>query</code></a>
called with <code>format :none</code>. Returns the amount of
affected rows as its first returned value. (Also returns this
amount as the second returned value, but use of this is
deprecated.)</p>
<p class="def">
<span>macro</span>
<a name="doquery"></a>
doquery (query (&amp;rest names) &amp;body body)
</p>
<p class="desc">Execute the given <code>query</code> (a string or a list
starting with a keyword), iterating over the rows in the result.
The <code>body</code> will be executed with the values in the row bound to the
symbols given in <code>names</code>. To iterate over a
parameterised query, one can specify a list whose <em>car</em> is the
query, and whose <em>cdr</em> contains the arguments. For example:</p>
<pre class="code">
(doquery (:select 'name 'score :from 'scores) (n s)
(incf (gethash n *scores*) s))
(doquery ((:select 'name :from 'scores :where (:> 'score '$1)) 100) (name)
(print name))</pre>
<p class="def">
<span>macro</span>
<a name="prepare"></a>
prepare (query &amp;optional (format :rows))
<br/>&#8594; function
</p>
<p class="desc">Creates a function that can be used as the
interface to a prepared statement. The given <code>query</code>
(either a string or an <a href="s-sql.html">S-SQL</a> form) may contain
placeholders, which look like <code>$1</code>, <code>$2</code>,
etc. The resulting function takes one argument for every
placeholder in the <code>query</code>, executes the prepared query,
and returns the result in the <code>format</code> specified. (Allowed
formats are the same as for <a href="#query"><code>query</code></a>.)</p>
<p class="desc">For queries that have to be run very often,
especially when they are complex, it may help performance since the
server only has to plan them once. See <a
href="http://www.postgresql.org/docs/current/static/sql-prepare.html">the
PostgreSQL manual</a> for details.</p>
<p class="desc">In some cases, the server will complain about not
being able to deduce the type of the arguments in a statement. In
that case you should add type declarations (either with the PostgreSQL's
<code>CAST</code> SQL-conforming syntax or historical <code>::</code>
syntax, or with S-SQL's <a href="s-sql.html#type"><code>:type</code></a>
construct) to help it out.</p>
<p class="def">
<span>macro</span>
<a name="defprepared"></a>
defprepared (name query &amp;optional (format :rows))
</p>
<p class="desc">This is the <code>defun</code>-style variant of <a
href="#prepare"><code>prepare</code></a>. It will define a
top-level function for the prepared statement.</p>
<p class="def">
<span>macro</span>
<a name="defprepared-with-names"></a>
defprepared-with-names (name (&amp;rest args) (query &amp;rest query-args) &amp;optional (format :rows))
</p>
<p class="desc">Like <a href="#defprepared"><code>defprepared</code></a>,
but allows to specify names of the function arguments as well as arguments
supplied to the <code>query</code>.</p>
<pre class="code">
(defprepared-with-names user-messages (user &amp;key (limit 10))
("select * from messages
where user_id = $1
order by date desc
limit $2" (user-id user) limit)
:plists)
</pre>
<p class="def">
<span>macro</span>
<a name="with-transaction"></a>
with-transaction ((&amp;optional name) &amp;body body)
</p>
<p class="desc">Execute the given <code>body</code> within a database
transaction, committing it when the <code>body</code> exits normally, and
aborting otherwise. An optional <code>name</code> can be given to the
transaction, which can be used to force a commit or abort before
the <code>body</code> unwinds.</p>
<p class="def">
<span>function</span>
<a name="commit-transaction"></a>
commit-transaction (transaction)
</p>
<p class="desc">Commit the given <code>transaction</code>.</p>
<p class="def">
<span>function</span>
<a name="abort-transaction"></a>
abort-transaction (transaction)
</p>
<p class="desc">Roll back the given <code>transaction</code>.</p>
<p class="def">
<span>macro</span>
<a name="with-savepoint"></a>
with-savepoint (name &amp;body body)
</p>
<p class="desc">Can only be used within a transaction. Establishes
a savepoint with the given <code>name</code> at the start of
<code>body</code>, and binds the same <code>name</code> to a handle
for that savepoint. At the end of <code>body</code>, the savepoint
is released, unless a condition is thrown, in which case it is rolled
back.</p>
<p class="def">
<span>function</span>
<a name="release-savepoint"></a>
release-savepoint (savepoint)
</p>
<p class="desc">Release the given <code>savepoint</code>.</p>
<p class="def">
<span>function</span>
<a name="rollback-savepoint"></a>
rollback-savepoint (savepoint)
</p>
<p class="desc">Roll back the given <code>savepoint</code>.</p>
<p class="def">
<span>function</span>
<a name="commit-hooks"></a>
commit-hooks (transaction-or-savepoint),
setf (commit-hooks transaction-or-savepoint)
</p>
<p class="desc">An accessor for the transaction or savepoint's list
of commit hooks, each of which should be a function with no required
arguments. These functions will be executed when a transaction is
committed or a savepoint released.</p>
<p class="def">
<span>function</span>
<a name="abort-hooks"></a>
abort-hooks (transaction-or-savepoint),
setf (abort-hooks transaction-or-savepoint)
</p>
<p class="desc">An accessor for the transaction or savepoint's list
of abort hooks, each of which should be a function with no required
arguments. These functions will be executed when a transaction is
aborted or a savepoint rolled back (whether via a non-local transfer
of control or explicitly by either <a href="#abort-transaction">
<code>abort-transaction</code></a> or <a href="#rollback-savepoint">
<code>rollback-savepoint</code></a>).
<p class="def">
<span>macro</span>
<a name="with-logical-transaction"></a>
with-logical-transaction ((&amp;optional name) &amp;body body)
</p>
<p class="desc">Executes <code>body</code> within
a <a href="#with-transaction"><code>with-transaction</code></a>
form if no transaction is currently in progress, otherwise simulates
a nested transaction by executing it within a <code>with-savepoint</code>
form. The transaction or savepoint is bound to <code>name</code> if one is
supplied.</p>
<p class="def">
<span>function</span>
<a name="abort-logical-transaction"></a>
abort-logical-transaction (transaction-or-savepoint)
</p>
<p class="desc">Roll back the given logical transaction, regardless of
whether it is an actual transaction or a savepoint.</p>
<p class="def">
<span>function</span>
<a name="commit-logical-transaction"></a>
commit-logical-transaction (transaction-or-savepoint)
</p>
<p class="desc">Commit the given logical transaction, regardless of
whether it is an actual transaction or a savepoint.</p>
<p class="def">
<a name="*current-logical-transaction*"></a>
<span>variable</span>
*current-logical-transaction*
</p>
<p class="desc">This is bound to the
current <code>transaction-handle</code>
or <code>savepoint-handle</code> instance representing the
innermost open logical transaction.</p>
<p class="def">
<span>macro</span>
<a name="ensure-transaction"></a>
ensure-transaction (&amp;body body)
</p>
<p class="desc">Ensures that <code>body</code> is executed within
a transaction, but does not begin a new transaction if one is
already in progress.</p>
<p class="def">
<span>macro</span>
<a name="with-schema"></a>
with-schema ((namespace &amp;key :strict t :if-not-exist
:create :drop-after) &amp;body body)
</p>
<p class="desc">Sets the current schema to <code>namespace</code> and
executes the <code>body</code>. Before executing <code>body</code> the
PostgreSQL's session variable <code>search_path</code> is set to
the given <code>namespace</code>. After executing <code>body</code> the
<code>search_path</code> variable is restored to the original value.
If the keyword <code>:strict</code> is set to <code>T</code> then
the <code>namespace</code> is only the scheme on the search path upon
the <code>body</code> execution. Otherwise the <code>namespace</code> is
just first schema on the search path upon the the <code>body</code>
execution. If <code>:if-not-exist</code> is <code>NIL</code>,
an error is signaled. If <code>:drop-after</code> is <code>T</code>
the <code>namespace</code> is dropped from the database after the
<code>body</code> execution.
</p>
<p class="def">
<span>function</span>
<a name="sequence-next"></a>
sequence-next (sequence)
<br/>&#8594; integer
</p>
<p class="desc">Get the next value from a <code>sequence</code>.
The sequence identifier can be either a string or a symbol, in the latter
case it will be converted to a string according to <a
href="s-sql.html">S-SQL</a> rules.</p>
<p class="def">
<span>function</span>
<a name="coalesce"></a>
coalesce (&amp;rest arguments)
<br/>&#8594; value
</p>
<p class="desc">Returns the first non-<code>NIL</code>, non-NULL
(as in <code>:null</code>) argument, or <code>NIL</code> if none
are present. Useful for providing a fall-back value for the result
of a query, or, when given only one argument, for transforming
<code>:null</code>s to <code>NIL</code>.</p>
<h2><a name="inspect"></a>Inspecting the database</h2>
<p class="def">
<span>function</span>
<a name="list-tables"></a>
list-tables (&amp;optional strings-p)
<br/>&#8594; list
</p>
<p class="desc">Returns a list of the tables in the current
database. When <code>strings-p</code> is <code>T</code>, the
names will be given as strings, otherwise as keywords.</p>
<p class="def">
<span>function</span>
<a name="table-exists-p"></a>
table-exists-p (name)
<br/>&#8594; boolean
</p>
<p class="desc">Tests whether a table with the given <code>name</code>
exists. The <code>name</code> can be either a string or a symbol.</p>
<p class="def">
<span>function</span>
<a name="table-description"></a>
table-description (name &amp;optional schema-name)
<br/>&#8594; list
</p>
<p class="desc">Returns a list of the fields in the named table.
Each field is represented by a list of three elements: the field
name, the type, and a boolean indicating whether the field may be
NULL. Optionally, <code>schema-name</code> can be specified to
restrict the result to fields from the named schema. Without it,
all fields in the table are returned, regardless of their schema.</p>
<p class="def">
<span>function</span>
<a name="list-sequences"></a>
list-sequences (&amp;optional strings-p)
<br/>&#8594; list
</p>
<p class="desc">Returns a list of the sequences in the current
database. When <code>strings-p</code> is <code>T</code>, the names
will be given as strings, otherwise as keywords.</p>
<p class="def">
<span>function</span>
<a name="sequence-exists-p"></a>
sequence-exists-p (name)
<br/>&#8594; boolean
</p>
<p class="desc">Tests whether a sequence with the given <code>name</code>
exists. The <code>name</code> can be either a string or a symbol.</p>
<p class="def">
<span>function</span>
<a name="list-views"></a>
list-views (&amp;optional strings-p)
<br/>&#8594; list
</p>
<p class="desc">Returns list of the user defined views in the current
database. When <code>strings-p</code> is <code>T</code>, the names will
be returned as strings, otherwise as keywords.</p>
<p class="def">
<span>function</span>
<a name="view-exists-p"></a>
view-exists-p (name)
<br/>&#8594; boolean
</p>
<p class="desc">Tests whether a view with the given <code>name</code>
exists. The <code>name</code> can be either a string or a symbol.</p>
<p class="def">
<span>function</span>
<a name="list-schemata"></a>
list-schemata ()
<br/>&#8594; list
</p>
<p class="desc">Returns list of the user defined schemata (as strings)
and the quantity of existing schemata.</p>
<p class="def">
<span>function</span>
<a name="schema-exist-p"></a>
schema-exist-p (schema)
<br/>&#8594; boolean
</p>
<p class="desc">Tests the existence of a given <code>schema</code>.
Returns <code>T</code> if the schema exists or <code>NIL</code>
otherwise.</p>
<h2><a name="daos"></a>Database access objects</h2>
<p>Postmodern contains a simple system for defining CLOS classes
that represent rows in the database. This is not intended as a
full-fledged object-relational magic system &#x2015; while serious
ORM systems have their place, they are notoriously hard to get
right, and are outside of the scope of a humble SQL library like
this.</p>
<p class="def">
<span>metaclass</span>
<a name="dao-class"></a>
dao-class
</p>
<p class="desc">At the heart of Postmodern's DAO system is the
<code>dao-class</code> metaclass. It allows you to define classes
for your database-access objects as regular CLOS classes. Some of
the slots in these classes will refer to columns in the database.
To specify that a slot refers to a column, give it a
<code>:col-type</code> option containing
an <a href="s-sql.html">S-SQL</a> type expression (useful if you
want to be able to derive a table definition from the class
definition), or simply a <code>:column</code> option with
value <code>T</code>. Such slots can also take
a <code>:col-default</code> option, used to provide a
database-side default value as an S-SQL expression. You can use
the <code>:col-name</code> initarg (whose unevaluated value will
be passed to <code>to-sql-name</code>) to specify the slot's column's
name.</p>
<p class="desc">DAO class definitions support two extra class
options: <code>:table-name</code> to give the name of the table
that the class refers to (defaults to the class name), and
<code>:keys</code> to provide a set of primary keys for the table.
When no primary keys are defined, operations such as <a
href="#update-dao"><code>update-dao</code></a> and <a
href="#get-dao"><code>get-dao</code></a> will not work.</p>
<p class="desc">Simple example:</p>
<pre class="code">
(defclass user ()
((name :col-type string :initarg :name :accessor user-name)
(creditcard :col-type (or db-null integer) :initarg :card :col-default :null)
(score :col-type bigint :col-default 0 :accessor user-score))
(:metaclass dao-class)
(:keys name))</pre>
<p class="desc">The <code>(or db-null integer)</code> form is used
to indicate a column can have NULL values.</p>
<p class="desc">When inheriting from DAO classes, a subclass' set
of columns also contains all the columns of its superclasses. The
primary key for such a class is the union of its own keys and all
the keys from its superclasses. Classes inheriting from DAO
classes should probably always use the <code>dao-class</code>
metaclass themselves.</p>
<p class="desc">When a DAO is created with
<code>make-instance</code>, the <code>:fetch-defaults</code> keyword
argument can be passed, which, when <code>T</code>, will cause a query
to fetch the default values for all slots that refers to columns with
defaults and were not bound through initargs. In some cases, such as
<code>serial</code> columns, which have an implicit default, this will
not work. You can work around this by creating your own sequence, e.g.
<code>"my_sequence"</code>, and defining a
<code>(:nextval "my_sequence")</code> default.</p>
<p class="desc">Finally, DAO class slots can have an option
<code>:ghost t</code> to specify them as ghost slots. These are
selected when retrieving instances, but not written when updating
or inserting, or even included in the table definition. The only
known use for this to date is for creating the table with
<code>(oids=true)</code>, and specify a slot like this:</p>
<pre class="code">
(oid :col-type integer :ghost t :accessor get-oid)</pre>
<p class="def">
<span>method</span>
<a name="dao-keys"></a>
dao-keys (class)
<br/>&#8594; list
</p>
<p class="desc">
Returns list of slot names that are the primary key of DAO
<code>class</code>.
</p>
<p class="def">
<span>method</span>
dao-keys (dao)
<br/>&#8594; list
</p>
<p class="desc">
Returns list of values that are the primary key of <code>dao</code>.
</p>
<p class="def">
<span>method</span>
<a name="dao-exists-p"></a>
dao-exists-p (dao)
<br/>&#8594; boolean
</p>
<p class="desc">Test whether a row with the same primary key as
the given <code>dao</code> exists in the database. Will also return
<code>NIL</code> when any of the key slots in the object are
unbound.</p>
<p class="def">
<span>method</span>
<a name="make-dao"></a>
make-dao (type &amp;rest args &amp;key &amp;allow-other-keys)
<br/>&#8594; dao
</p>
<p class="desc">Combines <code>make-instance</code> with
<a href="#insert-dao"><code>insert-dao</code></a>. Return the
created dao.</p>
<p class="def">
<span>macro</span>
<a name="define-dao-finalization"></a>
define-dao-finalization (((dao-name class) &amp;rest keyword-args) &amp;body body)
</p>
<p class="desc">Create an <code>:around</code>-method for <a href="#make-dao">
<code>make-dao</code></a>. The <code>body</code> is executed in
a lexical environment where <code>dao-name</code> is bound
to a freshly created and inserted DAO. The representation of the DAO in the
database is then updated to reflect changes that <code>body</code> might
have introduced. Useful for processing values of slots with the type
<code>serial</code>, which are unknown before <a href="#insert-dao">
<code>insert-dao</code></a>.</p>
<p class="def">
<span>method</span>
<a name="get-dao"></a>
get-dao (type &amp;rest keys)
<br/>&#8594; dao
</p>
<p class="desc">Select the DAO object from the row that has the
given primary key values, or <code>NIL</code> if no such row
exists. Objects created by this function will have
<code>initialize-instance</code> called on them (after loading in
the values from the database) without any arguments &#x2015; even
<code>:default-initargs</code> are skipped. The same goes for <a
href="#select-dao"><code>select-dao</code></a> and <a
href="#query-dao"><code>query-dao</code></a>.</p>
<p class="def">
<span>macro</span>
<a name="select-dao"></a>
select-dao (type &amp;optional (test t) &amp;rest sort)
<br/>&#8594; list
</p>
<p class="desc">Select DAO objects for the rows in the associated
table for which the given <code>test</code> (either an <a
href="s-sql.html">S-SQL</a> expression or a string) holds. When
sorting arguments are given, which can also be S-SQL forms or
strings, these are used to sort the result. (Note that, if you
want to sort, you <em>have</em> to pass the <code>test</code>
argument.)</p>
<pre class="code">(select-dao 'user (:> 'score 10000) 'name)</pre>
<p class="def">
<span>macro</span>
<a name="do-select-dao"></a>
do-select-dao (((type type-var) &amp;optional (test t) &amp;rest sort) &amp;body body)
</p>
<p class="desc">Like <a href="#select-dao"><code>select-dao</code></a>,
but iterates over the results rather than returning them. For each matching
DAO, <code>body</code> is evaluated with <code>type-var</code> bound to the
DAO instance.</p>
<pre class="code">(do-select-dao (('user user) (:> 'score 10000) 'name)
(pushnew user high-scorers))</pre>
<p class="def">
<span>function</span>
<a name="query-dao"></a>
query-dao (type query &amp;rest args)
<br/>&#8594; list
</p>
<p class="desc">Execute the given <code>query</code> (which can be either
a string or an <a href="s-sql.html">S-SQL</a> expression) and return
the result as DAOs of the given <code>type</code>. If the <code>query</code>
contains placeholders ($1, $2, etc) their values can be given as extra
arguments. The names of the fields returned by the <code>query</code> must
either match slots in the DAO class, or be bound through <a
href="#with-column-writers"><code>with-column-writers</code></a>.</p>
<p class="def">
<span>function</span>
<a name="do-query-dao"></a>
do-query-dao (((type type-var) query &amp;rest args) &body body)
<br/>&#8594; list
</p>
<p class="desc">Like <a href="#query-dao"><code>query-dao</code></a>, but
iterates over the results rather than returning them. For each matching DAO,
<code>body</code> is evaluated with <code>type-var</code> bound to the
instance.</p>
<pre class="code">(do-query-dao (('user user) (:order-by (:select '* :from 'user :where (:> 'score 10000)) 'name))
(pushnew user high-scorers))</pre>
<p class="def">
<span>variable</span>
<a name="*ignore-unknown-columns*"></a>
*ignore-unknown-columns*
</p>
<p class="desc">Normally,
when <code><a href="#get-dao">get-dao</a></code>,
<code><a href="#select-dao">select-dao</a></code>,
or <code><a href="#query-dao">query-dao</a></code> finds a column
in the database that's not in the DAO class, it will raise an
error. Setting this variable to a non-<code>NIL</code> will cause it to
simply ignore the unknown column.</p>
<p class="def">
<span>method</span>
<a name="insert-dao"></a>
insert-dao (dao)
<br/>&#8594; dao
</p>
<p class="desc">Insert the given <code>dao</code> into the database.
Column slots of the object which are unbound implies the database defaults.
Hence, if these columns has no defaults defined in the database, the
the insertion of the <code>dao</code> will be failed.
(This feature only works on PostgreSQL 8.2 and up.)</p>
<p class="def">
<span>method</span>
<a name="update-dao"></a>
update-dao (dao)
<br/>&#8594; dao
</p>
<p class="desc">Update the representation of the given <code>dao</code>
in the database to the values in the object. This is not defined for
tables that do not have any non-primary-key columns. Raises an
error when no row matching the <code>dao</code> exists.</p>
<p class="def">
<span>function</span>
<a name="save-dao"></a>
save-dao (dao)
<br/>&#8594; boolean
</p>
<p class="desc">Tries to insert the given <code>dao</code> using <a
href="#insert-dao"><code>insert-dao</code></a>. If this raises a
unique key violation error, it tries to update it by using <a
href="#update-dao"><code>update-dao</code></a> instead. Be aware
that there is a possible race condition here &#x2015; if some
other process deletes the row at just the right moment, the update
fails as well. Returns a boolean telling you whether a new row was
inserted.</p>
<p class="desc">This function is unsafe to use inside of a
transaction &#x2015; when a row with the given keys already
exists, the transaction will be aborted. Use <a
href="#save-dao/transaction"><code>save-dao/transaction</code></a>
instead in such a situation.</p>
<p class="desc"><b>See also:</b> <a href="#upsert-dao">
<code>upsert-dao</code></a>.</p>
<p class="def">
<span>function</span>
<a name="save-dao/transaction"></a>
save-dao/transaction (dao)
<br/>&#8594; boolean
</p>
<p class="desc">Acts exactly like <a
href="#save-dao"><code>save-dao</code></a>, except that it
protects its attempt to insert the object with a rollback point,
so that a failure will not abort the transaction.</p>
<p class="desc"><b>See also:</b> <a href="#upsert-dao">
<code>upsert-dao</code></a>.</p>
<p class="def">
<span>method</span>
<a name="upsert-dao"></a>
upsert-dao (dao)
<br/>&#8594; dao
</p>
<p class="desc">
Like <a href="#save-dao"><code>save-dao</code></a>
or <a href="#save-dao/transaction"><code>save-dao/transaction</code></a>
but using a different method that doesn't involve a database
exception. This is safe to use both in and outside a transaction,
though it's advisable to always do it in a transaction to prevent a
race condition. The way it works is:
</p>
<ol class="desc">
<li>If the object contains unbound slots, we
call <a href="#insert-dao"><code>insert-dao</code></a> directly, thus
the behavior is like <code>save-dao</code>.</li>
<li>Otherwise we try to update a record with the same primary key. If
the PostgreSQL returns a non-zero number of rows updated it
<em>treated</em> as the record is already exists in the database, and
we stop here.</li>
<li>If the PostgreSQL returns a zero number of rows updated, it
<em>treated</em> as the record does not exist and we call
<code>insert-dao</code>.</li>
</ol>
<p class="desc">
The race condition might occur at step 3 <em>if there's no
transaction:</em> if UPDATE returns zero number of rows updated and
another thread inserts the record at that moment, the insertion
implied by step 3 will fail.
</p>
<p class="desc">
Note, that triggers and rules may affect the number of inserted or
updated rows returned by PostgreSQL, so zero or non-zero number of
affected rows may not <em>actually</em> indicate the existence of
record in the database.
</p>
<p class="desc">
This method returns two values: the DAO object and a boolean
(<code>T</code> if the object was inserted, <code>NIL</code> if
it was updated).
</p>
<p class="def">
<span>method</span>
<a name="delete-dao"></a>
delete-dao (dao)
</p>
<p class="desc">Delete the given <code>dao</code> from the database.</p>
<p class="def">
<span>function</span>
<a name="dao-table-name"></a>
dao-table-name (class)
<br/>&#8594; string
</p>
<p class="desc">Get the name of the <code>table</code> associated with
the given DAO <code>class</code> (or symbol naming such a class).</p>
<p class="def">
<span>function</span>
<a name="dao-table-definition"></a>
dao-table-definition (class)
<br/>&#8594; string
</p>
<p class="desc">Given a DAO <code>class</code>, or the name of one,
this will produce an SQL query string with a definition of the table.
This is just the bare simple definition, so if you need any extra
indices or or constraints, you'll have to write your own queries
to add them.</p>
<p class="def">
<span>macro</span>
<a name="with-column-writers"></a>
with-column-writers ((&amp;rest writers) &amp;body body)
</p>
<p class="desc">Provides control over the way <code><a
href="#get-dao">get-dao</a></code>, <code><a
href="#select-dao">select-dao</a></code>, and <code><a
href="#query-dao">query-dao</a></code> read values from the
database. This is not commonly needed, but can be used to reduce
the amount of queries a system makes. <code>writers</code> should
be a list of alternating column names (strings or symbols) and
writers, where writers are either symbols referring to a slot in
the objects, or functions taking two arguments &#x2015; an
instance and a value &#x2015; which can be used to somehow store
the value in the new instance. When any DAO-fetching function is
called in the <code>body</code>, and columns matching the given
names are encountered in the result, the writers are used instead
of the default behaviour (try and store the value in the slot that
matches the column name).</p>
<p class="desc">An example of using this is to add some non-column
slots to a DAO class, and use <code><a
href="#query-dao">query-dao</a></code> within a
<code>with-column-writers</code> form to pull in extra information
about the objects, and immediately store it in the new
instances.</p>
<h2 id="tabledef">Table definition and creation</h2>
<p>It can be useful to have the SQL statements needed to build an
application's tables available from the source code, to do things like
automatically deploying a database. The following macro and
functions allow you to group sets of SQL statements under symbols,
with some shortcuts for common elements in table definitions.</p>
<p class="def" id="deftable">
<span>macro</span>
deftable (name &amp;body definition)
</p>
<p class="desc">Define a table. <code>name</code> can be either a symbol
or a <code>(symbol string)</code> list. In the first case, the table
name is derived from the symbol's name by <a
href="s-sql.html">S-SQL</a>'s rules. In the second case, the
<code>name</code> is given explicitly. The body of definitions can contain
anything that evaluates to a string, as well as S-SQL expressions. The
variables <a href="#*table-name*"><code>*table-name*</code></a> and
<a href="#*table-name*"><code>*table-symbol*</code></a> are bound to
the relevant values in the body. Note that the evaluation of the
<code>definition</code> is ordered, so you'll generally want to create your
table first and then define indices on it.</p>
<p class="def">
<a name="!dao-def"></a>
<span>function</span>
!dao-def ()
</p>
<p class="desc">Should only be used inside <a
href="#deftable"><code>deftable</code></a>'s body. Adds the result
of calling <a
href="#dao-table-definition"><code>dao-table-definition</code></a>
on <a href="#*table-symbol*"><code>*table-symbol*</code></a> to
the <code>definition</code>.</p>
<p class="def">
<a name="!index"></a>
<span>function</span>
!index (&amp;rest columns), !unique-index (&amp;rest columns)
</p>
<p class="desc">Define an index on the table being defined. The
<code>columns</code> can be given as symbols or strings.</p>
<p class="def">
<a name="!foreign"></a>
<span>function</span>
!foreign (target-table columns &amp;optional target-columns &amp;key on-delete on-update deferrable initially-deferred)
</p>
<p class="desc">Add a foreign key to the table being defined.
<code>target-table</code> is the referenced table.
<code>columns</code> is a list of column names or single name in
<em>this</em> table, and, if the columns have different names in
the referenced table, <code>target-columns</code> must be
another list of column names or single column name of the
<code>target-table</code>, or <code>:primary-key</code> to denote
the column(s) of the <code>target-table</code>'s primary key
as referenced column(s).
</p>
<p class="desc">The <code>on-delete</code> and
<code>on-update</code> arguments can be used to specify ON DELETE
and ON UPDATE actions, as per the keywords allowed in <a
href="s-sql.html#create-table"><code>create-table</code></a>. In
addition, the <code>deferrable</code> and <code>initially-deferred</code>
arguments can be used to indicate whether constraint checking can be
deferred until the current transaction completed, and whether this should
be done by default. Note that none of these are really &amp;key
arguments, but rather are picked out of a &amp;rest arg at
runtime, so that they can be specified even when
<code>target-columns</code> is not given.</p>
<p class="def">
<a name="!unique"></a>
<span>function</span>
!unique (target-fields &amp;key deferrable initially-deferred)
</p>
<p class="desc">Constrains one or more columns to only contain
unique (combinations of) values, with <code>deferrable</code> and
<code>initially-deferred</code> defined as in <a
href="#!foreign"><code>!foreign</code></a></p>
<p class="def" id="create-table">
<span>function</span>
create-table (symbol)
</p>
<p class="desc">Creates the table identified by
<code>symbol</code> by <a href="#execute">executing</a> all forms in
its definition.</p>
<p class="def" id="create-all-tables">
<span>function</span>
create-all-tables ()
</p>
<p class="desc">Creates all defined tables.</p>
<p class="def" id="create-package-tables">
<span>function</span>
create-package-tables (package)
</p>
<p class="desc">Creates all tables identified by symbols
interned in the given <code>package</code>.</p>
<p class="def">
<a name="*table-name*"></a>
<span>variables</span>
*table-name*, *table-symbol*
</p>
<p class="desc">These variables are bound to the relevant name and
symbol while the forms of a table definition are evaluated. Can be
used to define shorthands like the ones below.</p>
<h2 id="schemata">Schemata</h2>
Schema allow you to separate tables into differnet name spaces. In
different schemata two tables with the same name are allowed to
exists. The tables can be referred by fully qualified names or
with the macro <a href="#with-schema">with-schema</a>. You could
also set the search path
with <a href="#set-search-path">set-search-path<a/>. For listing
end checking there are also the
functions <a href="#list-schemata">list-schemata</a>
and <a href="#schema-exist-p">schema-exist-p</a>. The following
functions allow you to create, drop schemata and to set the search
path.
<p class="def">
<span>function</span>
<a name="create-schema"></a>
create-schema (schema)
</p>
<p class="desc">
Creates a new schema. Raises an error if the schema is already exists.
</p>
<p class="def">
<span>function</span>
<a name="drop-schema"></a>
drop-schema (schema)
</p>
<p class="desc">
Removes a schema. Raises an error if the schema is not empty.
</p>
<p class="def">
<span>function</span>
<a name="get-search-path"></a>
get-search-path ()
</p>
<p class="desc">
Retrieve the current search path.
</p>
<p class="def">
<span>function</span>
<a name="set-search-path"></a>
set-search-path (path)
</p>
<p class="desc">
Sets the search path to the <code>path</code>. This function is used
by <a href="#with-schema">with-schema</a>.
</p>
<h2 id="index">Symbol-index</h2>
<ul class="symbol-index">
<li><a href="#abort-transaction">abort-transaction</a></li>
<li><a href="#deftable">deftable</a></li>
<li><a href="#call-with-connection">call-with-connection</a></li>
<li><a href="#clear-connection-pool">clear-connection-pool</a></li>
<li><a href="#clear-template">clear-template</a></li>
<li><a href="#commit-transaction">commit-transaction</a></li>
<li><a href="#connect">connect</a></li>
<li><a href="#connect-toplevel">connect-toplevel</a></li>
<li><a href="#connected-p">connected-p</a></li>
<li><a href="#create-all-tables">create-all-tables</a></li>
<li><a href="#create-package-tables">create-package-tables</a></li>
<li><a href="#create-schema">create-schema</a></li>
<li><a href="#create-table">create-table</a></li>
<li><a href="#dao-class">dao-class</a></li>
<li><a href="#!dao-def">!dao-def</a></li>
<li><a href="#dao-exists-p">dao-exists-p</a></li>
<li><a href="#dao-keys">dao-keys</a></li>
<li><a href="#dao-table-definition">dao-table-definition</a></li>
<li><a href="#dao-table-name">dao-table-name</a></li>
<li><a href="#*database*">*database*</a></li>
<li><a href="#database-connection">database-connection</a></li>
<li><a href="#define-dao-finalization">define-dao-finalization</a></li>
<li><a href="cl-postgres.html#database-connection-lost">database-connection-lost</a></li>
<li><a href="cl-postgres.html#database-error">database-error</a></li>
<li><a href="cl-postgres.html#database-error-cause">database-error-cause</a></li>
<li><a href="cl-postgres.html#database-error-code">database-error-code</a></li>
<li><a href="cl-postgres.html#database-error-detail">database-error-detail</a></li>
<li><a href="cl-postgres.html#database-error-query">database-error-query</a></li>
<li><a href="cl-postgres.html#database-error-message">database-error-message</a></li>
<li><a href="#*default-use-ssl*">*default-use-ssl*</a></li>
<li><a href="#defprepared">defprepared</a></li>
<li><a href="#defprepared">defprepared-with-names</a></li>
<li><a href="#delete-dao">delete-dao</a></li>
<li><a href="#disconnect">disconnect</a></li>
<li><a href="#disconnect-toplevel">disconnect-toplevel</a></li>
<li><a href="#doquery">doquery</a></li>
<li><a href="#drop-schema">drop-schema</a></li>
<li><a href="#execute">execute</a></li>
<li><a href="#!foreign">!foreign</a></li>
<li><a href="#!unique">!unique</a></li>
<li><a href="#get-dao">get-dao</a></li>
<li><a href="#get-search-path">get-search-path</a></li>
<li><a href="#*ignore-unknown-columns*">*ignore-unknown-columns*</a></li>
<li><a href="#!index">!index</a></li>
<li><a href="#insert-dao">insert-dao</a></li>
<li><a href="#list-sequences">list-sequences</a></li>
<li><a href="#list-schemata">list-schemata</a></li>
<li><a href="#list-tables">list-tables</a></li>
<li><a href="#list-views">list-views</a></li>
<li><a href="#make-dao">make-dao</a></li>
<li><a href="#*max-pool-size*">*max-pool-size*</a></li>
<li><a href="#prepare">prepare</a></li>
<li><a href="#query">query</a></li>
<li><a href="#query-dao">query-dao</a></li>
<li><a href="#reconnect">reconnect</a></li>
<li><a href="#release-savepoint">release-savepoint</a></li>
<li><a href="#reset-table">reset-table</a></li>
<li><a href="#rollback-savepoint">rollback-savepoint</a></li>
<li><a href="#save-dao">save-dao</a></li>
<li><a href="#save-dao/transaction">save-dao/transaction</a></li>
<li><a href="#select-dao">select-dao</a></li>
<li><a href="#set-search-path">set-search-path</a></li>
<li><a href="#schema-exist-p">schema-exist-p</a></li>
<li><a href="#sequence-exists-p">sequence-exists-p</a></li>
<li><a href="#sequence-next">sequence-next</a></li>
<li><a href="#table-description">table-description</a></li>
<li><a href="#table-exists-p">table-exists-p</a></li>
<li><a href="#*table-name*">*table-name*</a></li>
<li><a href="#*table-name*">*table-symbol*</a></li>
<li><a href="#!index">!unique-index</a></li>
<li><a href="#update-dao">update-dao</a></li>
<li><a href="#view-exists-p">view-exists-p</a></li>
<li><a href="#with-column-writers">with-column-writers</a></li>
<li><a href="#with-connection">with-connection</a></li>
<li><a href="#with-savepoint">with-savepoint</a></li>
<li><a href="#with-schema">with-schema</a></li>
<li><a href="#with-transaction">with-transaction</a></li>
</ul>
</body>
</html>