X-Git-Url: http://git.kpe.io/?p=clsql.git;a=blobdiff_plain;f=doc%2Fref-connect.xml;h=84b33e519faaeb34355a07f122fcf3913d70908e;hp=4bc296b3fa843278fd26b9d80963f55a4dec18f5;hb=fdd069770e32d0cfa4b66d6e5cfd4540197660ba;hpb=bf2c17ae4cb07adab3bbff036228572287936d75
diff --git a/doc/ref-connect.xml b/doc/ref-connect.xml
index 4bc296b..84b33e5 100644
--- a/doc/ref-connect.xml
+++ b/doc/ref-connect.xml
@@ -137,12 +137,12 @@
Value Type
- Any object of type database, or nil to
+ Any object of type database, or &nil; to
indicate no default database.
Initial Value
- nil
+ &nil;
Description
@@ -160,13 +160,13 @@
*default-database* to the first database
that remains in the list of active databases as returned by
connected-databases, or
- nil if no further active databases
+ &nil; if no further active databases
exist.
The user may change *default-database*
at any time to a valid value of his choice.
If the value of *default-database* is
- nil, then all calls to &clsql; functions on
+ &nil;, then all calls to &clsql; functions on
databases must provide a suitable
database parameter, or an error will be
signalled.
@@ -248,11 +248,11 @@
Value Type
Any keyword representing a valid database back-end of
- &clsql;, or nil.
+ &clsql;, or &nil;.
Initial Value
- nil
+ &nil;
Description
@@ -261,7 +261,7 @@
connect as the default value of the
database-type parameter.
- If the value of this variable is nil,
+ If the value of this variable is &nil;,
then all calls to
initialize-database-type or
connect will have to specify the
@@ -311,7 +311,7 @@
Initial Value
- nil
+ &nil;
Description
@@ -406,8 +406,7 @@
A boolean flag. If &t;, acquire connection from a
pool of open connections. If the pool is empty, a new
- connection is created. The default is &nil;. This is a
- &clsql; extension.
+ connection is created. The default is &nil;.
@@ -417,8 +416,7 @@
A boolean flag. If &t;,
*default-database* is set to the new
connection, otherwise *default-database*
- is not changed. The default is &t;. This is a &clsql;
- extension.
+ is not changed. The default is &t;.
@@ -580,7 +578,9 @@
Notes
- None.
+ The pool and
+ make-default keyword arguments to
+ connect are &clsql; extensions.
@@ -1015,7 +1015,7 @@
error
A boolean flag indicating whether to signal an error
- if database is non-nil but cannot
+ if database is non-&nil; but cannot
be found.
@@ -1044,8 +1044,8 @@
returned by connect, and closes the
connection. If no matching database is found and
error and
- database are both non-nil an error is
- signaled, otherwise nil is returned. If the database is from a
+ database are both non-&nil; an error is
+ signaled, otherwise &nil; is returned. If the database is from a
pool it will be released to this pool.
@@ -1077,7 +1077,7 @@
*default-database*, then
*default-database* is set to the first
remaining database from
- connected-databases or to nil if no
+ connected-databases or to &nil; if no
further active database exists.
@@ -1209,8 +1209,7 @@
db-type
- A keyword symbol denoting a known database back-end. This
- is a &clsql; extension.
+ A keyword symbol denoting a known database back-end.
@@ -1218,8 +1217,8 @@
result
Either a database object, or, if
- errorp is nil,
- possibly nil.
+ errorp is &nil;,
+ possibly &nil;.
@@ -1240,11 +1239,11 @@
database. If it succeeds, it returns
the first database found.
- If db-type is nil all databases
+ If db-type is &nil; all databases
matching the string database are
considered. If no matching databases are found and
- errorp is nil then nil is
- returned. If errorp is nil and one or
+ errorp is &nil; then &nil; is
+ returned. If errorp is &nil; and one or
more matching databases are found, then the most recently
connected database is returned as a first value and the
number of matching databases is returned as a second
@@ -1321,7 +1320,9 @@
Notes
- None.
+ The db-type keyword argument to
+ find-database is a &clsql;
+ extension.
@@ -1354,7 +1355,7 @@
result
- Either nil if the initialization
+ Either &nil; if the initialization
attempt fails, or t otherwise.
@@ -1373,7 +1374,7 @@
*initialized-database-types*, if not
already present.
If initialization fails, the function returns
- nil, and/or signals an error of type
+ &nil;, and/or signals an error of type
clsql-error. The kind of action
taken depends on the back-end and the cause of the
problem.
@@ -1503,13 +1504,13 @@
database whose name matches database is
sought in the list of connected databases. If no matching
database is found and error and
- database are both non-nil an error is
- signaled, otherwise nil is returned.
+ database are both non-&nil; an error is
+ signaled, otherwise &nil; is returned.
When the current database connection has been lost, if
- force is non-nil as it is by default, the
+ force is non-&nil; as it is by default, the
connection is closed and errors are suppressed. If
- force is nil and the database connection
+ force is &nil; and the database connection
cannot be closed, an error is signalled.
@@ -1595,7 +1596,7 @@
Description
Prints information about the currently connected databases
to *STANDARD-OUTPUT*. The argument
- full is nil by default and a value of t
+ full is &nil; by default and a value of t
means that more detailed information about each database is
printed.
@@ -1612,7 +1613,7 @@ CLSQL STATUS: 2004-06-13 15:07:39
localhost/test/petrov mysql nil
localhost/test/petrov postgresql nil
localhost/test/petrov postgresql-socket nil
- mysql-test/petrov odbc nil
+ test/petrov odbc nil
* :memory: sqlite nil
--------------------------------------------------------
@@ -2206,8 +2207,9 @@ Error: While trying to access database localhost/test2/root
Description
- Perform BODY with DATABASE bound as
- *default-database*.
+ Perform body with
+ DATABASE bound as
+ *default-database*.