X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fref-connect.xml;h=d9c992e62837ec41c69a1966e6d8b2a265b0f197;hb=4c5797c1926bdfb21ca1824408e4aa5bf0d30d19;hp=84b33e519faaeb34355a07f122fcf3913d70908e;hpb=fdd069770e32d0cfa4b66d6e5cfd4540197660ba;p=clsql.git
diff --git a/doc/ref-connect.xml b/doc/ref-connect.xml
index 84b33e5..d9c992e 100644
--- a/doc/ref-connect.xml
+++ b/doc/ref-connect.xml
@@ -22,7 +22,7 @@
DATABASE
- ClassDATABASE
+ DATABASEThe super-type of all &clsql; databasesClass
@@ -71,7 +71,7 @@
*CONNECT-IF-EXISTS*
- Variable*CONNECT-IF-EXISTS*
+ *CONNECT-IF-EXISTS*Default value for the
if-exists parameter of connect.
@@ -80,7 +80,7 @@
Value TypeA valid argument to the if-exists
- parameter of connect, i.e. one of
+ parameter of connect, that is, one of
:new:warn-new
@@ -131,7 +131,7 @@
*DEFAULT-DATABASE*
- Variable*DEFAULT-DATABASE*
+ *DEFAULT-DATABASE*The default database object to use.Variable
@@ -241,7 +241,7 @@
*DEFAULT-DATABASE-TYPE*
- Variable*DEFAULT-DATABASE-TYPE*
+ *DEFAULT-DATABASE-TYPE*The default database type to useVariable
@@ -300,7 +300,7 @@
*INITIALIZED-DATABASE-TYPES*
- Variable*INITIALIZED-DATABASE-TYPES*
+ *INITIALIZED-DATABASE-TYPES*List of all initialized database typesVariable
@@ -365,14 +365,13 @@
CONNECT
- FunctionCONNECT
+ CONNECTcreate a connection to a database.FunctionSyntax
- Syntax
- connectconnection-spec &key if-existsdatabase-typepoolmake-default => database
+ connectconnection-spec &key if-existsdatabase-typepoolmake-default => databaseArguments and Values
@@ -589,7 +588,7 @@
CONNECTED-DATABASES
- FunctionCONNECTED-DATABASES
+ CONNECTED-DATABASESReturn the list of active database objects.Function
@@ -681,7 +680,7 @@
DATABASE-NAME
- Generic FunctionDATABASE-NAME
+ DATABASE-NAMEGet the name of a database objectGeneric Function
@@ -798,7 +797,7 @@
DATABASE-NAME-FROM-SPEC
- Generic FunctionDATABASE-NAME-FROM-SPEC
+ DATABASE-NAME-FROM-SPECReturn the database name string corresponding to
the given connection specification.Generic Function
@@ -911,7 +910,7 @@
DATABASE-TYPE
- Generic FunctionDATABASE-TYPE
+ DATABASE-TYPEGet the type of a database object.Generic Function
@@ -1000,7 +999,7 @@
DISCONNECT
- FunctionDISCONNECT
+ DISCONNECTclose a database connectionFunction
@@ -1115,7 +1114,7 @@
DISCONNECT-POOLED
- FunctionDISCONNECT-POOLED
+ DISCONNECT-POOLEDcloses all pooled database connectionsFunction
@@ -1179,7 +1178,7 @@
FIND-DATABASE
- FunctionFIND-DATABASE
+ FIND-DATABASE>Locate a database object through it's
name.Function
@@ -1331,7 +1330,7 @@
INITIALIZE-DATABASE-TYPE
- FunctionINITIALIZE-DATABASE-TYPE
+ INITIALIZE-DATABASE-TYPEInitializes a database typeFunction
@@ -1445,7 +1444,7 @@
RECONNECT
- FunctionRECONNECT
+ RECONNECTRe-establishes the connection between a database object and its RDBMS.Function
@@ -1570,7 +1569,7 @@
STATUS
- FunctionSTATUS
+ STATUSPrint information about connected databases.Function
@@ -1677,7 +1676,7 @@ CLSQL STATUS: 2004-06-13 15:08:08
CREATE-DATABASE
- FunctionCREATE-DATABASE
+ CREATE-DATABASEcreate a databaseFunction
@@ -1775,7 +1774,7 @@ error: 'Access denied for user: 'root@localhost' (Using password: YES)'
DESTROY-DATABASE
- FunctionDESTROY-DATABASE
+ DESTROY-DATABASEdestroys a databaseFunction
@@ -1826,7 +1825,7 @@ error: 'Access denied for user: 'root@localhost' (Using password: YES)'
=>
Error: While trying to access database localhost/test2/root
using database-type POSTGRESQL:
- Error database-destory failed: dropdb: database removal failed: ERROR: database "test2" does not exist
+ Error database-destroy failed: dropdb: database removal failed: ERROR: database "test2" does not exist
has occurred.
[condition type: CLSQL-ACCESS-ERROR]
@@ -1872,7 +1871,7 @@ Error: While trying to access database localhost/test2/root
PROBE-DATABASE
- FunctionPROBE-DATABASE
+ PROBE-DATABASEtests for existence of a databaseFunction
@@ -1955,7 +1954,7 @@ Error: While trying to access database localhost/test2/root
LIST-DATABASES
- FunctionLIST-DATABASES
+ LIST-DATABASESList databases matching the supplied connection spec
and database type.Function
@@ -2053,7 +2052,7 @@ Error: While trying to access database localhost/test2/root
WITH-DATABASE
- MacroWITH-DATABASE
+ WITH-DATABASEExecute a body of code with a variable bound to a
specified database object.Macro
@@ -2069,7 +2068,7 @@ Error: While trying to access database localhost/test2/root
db-var
- A variable to which the specified database is bound.
+ A variable which is bound to the specified database.
@@ -2083,7 +2082,12 @@ Error: While trying to access database localhost/test2/root
connect-args
- Other optional arguments to connect.
+ Other optional arguments to
+ connect. This macro use a value of
+ &nil; for connect's
+ make-default key, This is in
+ contrast to to the connect function which has a default
+ value of &t; for make-default.
@@ -2169,7 +2173,7 @@ Error: While trying to access database localhost/test2/root
WITH-DEFAULT-DATABASE
- MacroWITH-DEFAULT-DATABASE
+ WITH-DEFAULT-DATABASEExecute a body of code with *default-database* bound to a specified database.Macro