From 5edc92aee527621ed13245b5b7892e40c2cd443f Mon Sep 17 00:00:00 2001 From: "Kevin M. Rosenberg" Date: Sat, 10 Jul 2004 19:53:39 +0000 Subject: [PATCH] r9752: 10 Jul 2004 Kevin Rosenberg * doc/*.xml: Midway through docbook schema fixes --- ChangeLog | 3 + doc/entities.inc | 10 +- doc/ref-connect.xml | 46 ++++----- doc/ref-fddl.xml | 46 ++++----- doc/ref-fdml.xml | 155 ++++--------------------------- doc/ref-oodml.xml | 201 +++++++++++++++++++++++++++++++--------- doc/ref-recording.xml | 14 +-- doc/ref-syntax.xml | 18 ++-- doc/ref-transaction.xml | 16 ++-- 9 files changed, 251 insertions(+), 258 deletions(-) diff --git a/ChangeLog b/ChangeLog index 82ea5c1..219ce00 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,6 @@ +10 Jul 2004 Kevin Rosenberg + * doc/*.xml: Midway through docbook schema fixes + 9 Jul 2004 Kevin Rosenberg * Version 2.11.13 * sql/fdml.lisp: Apply patch from Kim Minh Kaplan diff --git a/doc/entities.inc b/doc/entities.inc index 472d090..496d956 100644 --- a/doc/entities.inc +++ b/doc/entities.inc @@ -22,9 +22,9 @@ Lispworks"> AllegroCL"> ANSI Common Lisp"> -T"> -NIL"> +T"> +NIL"> NULL"> -C"> - - +C"> +UNIX"> +Microsoft Windows"> diff --git a/doc/ref-connect.xml b/doc/ref-connect.xml index 84b33e5..e63aae2 100644 --- a/doc/ref-connect.xml +++ b/doc/ref-connect.xml @@ -22,7 +22,7 @@ DATABASE - Class DATABASE + DATABASE The super-type of all &clsql; databases Class @@ -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 Type A 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 use Variable @@ -300,7 +300,7 @@ *INITIALIZED-DATABASE-TYPES* - Variable *INITIALIZED-DATABASE-TYPES* + *INITIALIZED-DATABASE-TYPES* List of all initialized database types Variable @@ -365,7 +365,7 @@ CONNECT - Function CONNECT + CONNECT create a connection to a database. Function @@ -589,7 +589,7 @@ CONNECTED-DATABASES - Function CONNECTED-DATABASES + CONNECTED-DATABASES Return the list of active database objects. Function @@ -681,7 +681,7 @@ DATABASE-NAME - Generic Function DATABASE-NAME + DATABASE-NAME Get the name of a database object Generic Function @@ -798,7 +798,7 @@ DATABASE-NAME-FROM-SPEC - Generic Function DATABASE-NAME-FROM-SPEC + DATABASE-NAME-FROM-SPEC Return the database name string corresponding to the given connection specification. Generic Function @@ -911,7 +911,7 @@ DATABASE-TYPE - Generic Function DATABASE-TYPE + DATABASE-TYPE Get the type of a database object. Generic Function @@ -1000,7 +1000,7 @@ DISCONNECT - Function DISCONNECT + DISCONNECT close a database connection Function @@ -1115,7 +1115,7 @@ DISCONNECT-POOLED - Function DISCONNECT-POOLED + DISCONNECT-POOLED closes all pooled database connections Function @@ -1179,7 +1179,7 @@ FIND-DATABASE - Function FIND-DATABASE + FIND-DATABASE >Locate a database object through it's name. Function @@ -1331,7 +1331,7 @@ INITIALIZE-DATABASE-TYPE - Function INITIALIZE-DATABASE-TYPE + INITIALIZE-DATABASE-TYPE Initializes a database type Function @@ -1445,7 +1445,7 @@ RECONNECT - Function RECONNECT + RECONNECT Re-establishes the connection between a database object and its RDBMS. Function @@ -1570,7 +1570,7 @@ STATUS - Function STATUS + STATUS Print information about connected databases. Function @@ -1677,7 +1677,7 @@ CLSQL STATUS: 2004-06-13 15:08:08 CREATE-DATABASE - Function CREATE-DATABASE + CREATE-DATABASE create a database Function @@ -1775,7 +1775,7 @@ error: 'Access denied for user: 'root@localhost' (Using password: YES)' DESTROY-DATABASE - Function DESTROY-DATABASE + DESTROY-DATABASE destroys a database Function @@ -1872,7 +1872,7 @@ Error: While trying to access database localhost/test2/root PROBE-DATABASE - Function PROBE-DATABASE + PROBE-DATABASE tests for existence of a database Function @@ -1955,7 +1955,7 @@ Error: While trying to access database localhost/test2/root LIST-DATABASES - Function LIST-DATABASES + LIST-DATABASES List databases matching the supplied connection spec and database type. Function @@ -2053,7 +2053,7 @@ Error: While trying to access database localhost/test2/root WITH-DATABASE - Macro WITH-DATABASE + WITH-DATABASE Execute a body of code with a variable bound to a specified database object. Macro @@ -2169,7 +2169,7 @@ Error: While trying to access database localhost/test2/root WITH-DEFAULT-DATABASE - Macro WITH-DEFAULT-DATABASE + WITH-DEFAULT-DATABASE Execute a body of code with *default-database* bound to a specified database. Macro diff --git a/doc/ref-fddl.xml b/doc/ref-fddl.xml index 755f6ce..2fc7c52 100644 --- a/doc/ref-fddl.xml +++ b/doc/ref-fddl.xml @@ -24,7 +24,7 @@ CREATE-TABLE - Function CREATE-TABLE + CREATE-TABLE Create a database table. Function @@ -169,7 +169,7 @@ DROP-TABLE - Function DROP-TABLE + DROP-TABLE Drop a database table. Function @@ -277,7 +277,7 @@ LIST-TABLES - Function LIST-TABLES + LIST-TABLES Returns a list of database tables. Function @@ -383,7 +383,7 @@ TABLE-EXISTS-P - Function TABLE-EXISTS-P + TABLE-EXISTS-P Tests for the existence of a database table. Function @@ -489,7 +489,7 @@ CREATE-VIEW - Function CREATE-VIEW + CREATE-VIEW Create a database view. Function @@ -621,7 +621,7 @@ DROP-VIEW - Function DROP-VIEW + DROP-VIEW Drops a database view. Function @@ -729,7 +729,7 @@ LIST-VIEWS - Function LIST-VIEWS + LIST-VIEWS Returns a list of database views. Function @@ -836,7 +836,7 @@ VIEW-EXISTS-P - Function VIEW-EXISTS-P + VIEW-EXISTS-P Tests for the existence of a database view. Function @@ -942,7 +942,7 @@ CREATE-INDEX - Function CREATE-INDEX + CREATE-INDEX Create a database index. Function @@ -1064,7 +1064,7 @@ DROP-INDEX - Function DROP-INDEX + DROP-INDEX Drop a database index. Function @@ -1189,7 +1189,7 @@ LIST-INDEXES - Function LIST-INDEXES + LIST-INDEXES Returns a list of database indexes. Function @@ -1307,7 +1307,7 @@ INDEX-EXISTS-P - Function INDEX-EXISTS-P + INDEX-EXISTS- Tests for the existence of a database index. Function @@ -1414,7 +1414,7 @@ ATTRIBUTE-TYPE - Function ATTRIBUTE-TYPE + ATTRIBUTE-TYPE Returns the type of the supplied attribute. Function @@ -1564,7 +1564,7 @@ LIST-ATTRIBUTE-TYPES - Function LIST-ATTRIBUTE-TYPES + LIST-ATTRIBUTE-TYPES Returns information about the attribute types of a table. Function @@ -1680,7 +1680,7 @@ LIST-ATTRIBUTES - Function LIST-ATTRIBUTES + LIST-ATTRIBUTES Returns the attributes of a table as a list. Function @@ -1787,7 +1787,7 @@ CREATE-SEQUENCE - Function CREATE-SEQUENCE + CREATE-SEQUENCE Create a database sequence. Function @@ -1879,7 +1879,7 @@ DROP-SEQUENCE - Function DROP-SEQUENCE + DROP-SEQUENCE Drop a database sequence. Function @@ -1989,7 +1989,7 @@ LIST-SEQUENCES - Function LIST-SEQUENCES + LIST-SEQUENCES Returns a list of database sequences. Function @@ -2090,7 +2090,7 @@ SEQUENCE-EXISTS-P - Function SEQUENCE-EXISTS-P + SEQUENCE-EXISTS-P Tests for the existence of a database sequence. Function @@ -2200,7 +2200,7 @@ SEQUENCE-LAST - Function SEQUENCE-LAST + SEQUENCE-LAST Return the last element in a database sequence. Function @@ -2302,7 +2302,7 @@ SEQUENCE-NEXT - Function SEQUENCE-NEXT + SEQUENCE-NEXT Increment the value of a database sequence. Function @@ -2411,7 +2411,7 @@ SET-SEQUENCE-POSITION - Function SET-SEQUENCE-POSITION + SET-SEQUENCE-POSITION Sets the position of a database sequence. Function @@ -2523,7 +2523,7 @@ TRUNCATE-DATABASE - Function TRUNCATE-DATABASE + TRUNCATE-DATABASE Drop all tables, views, indexes and sequences in a database. Function diff --git a/doc/ref-fdml.xml b/doc/ref-fdml.xml index 2908175..e86dd36 100644 --- a/doc/ref-fdml.xml +++ b/doc/ref-fdml.xml @@ -37,7 +37,7 @@ *CACHE-TABLE-QUERIES-DEFAULT* - Variable *CACHE-TABLE-QUERIES-DEFAULT* + *CACHE-TABLE-QUERIES-DEFAULT* Specifies the default behaviour for caching of attribute types. Variable @@ -94,141 +94,17 @@ CACHE-TABLE-QUERIES - Function CACHE-TABLE-QUERIES - Controls the caching of attribute type information for a database table. - Function + CACHE-TABLE-QUERIES + Control the caching of table attribute types. - - Syntax - - cache-table-queries table &key action database) => - - - Arguments and Values - - - table - - - A string representing a database table, &t; or - :default. - - - - - action - - - &t;, &nil; or :flush. - - - - - database - - A - database - object. This will default to the value - of *default-database*. - - - - - - Description - Controls the caching of attribute type information on the - table specified by table in - database which defaults to - *default-database*. action - specifies the caching behaviour to adopt. If its value is &t; - then attribute type information is cached whereas if its value - is &nil; then attribute type information is not cached. If - action is :flush then - all existing type information in the cache for - table is removed, but caching is still - enabled. table may be a string - representing a table for which the caching action is to be taken - while the caching action is applied to all tables if - table is &t;. Alternatively, when - table is :default, the - default caching action specified by - *cache-table-queries-default* is applied to all - tables for which a caching action has not been explicitly set. - - - - Examples - -(setf *cache-table-queries-default* t) -=> T -(create-table [foo] - '(([id] integer) - ([height] float) - ([name] (string 24)) - ([comments] varchar))) -=> -(cache-table-queries "foo") -=> -(list-attribute-types "foo") -=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 24 NIL 1) - ("comments" :VARCHAR 255 NIL 1)) -(drop-table "foo") -=> -(create-table [foo] - '(([id] integer) - ([height] float) - ([name] (string 36)) - ([comments] (string 100)))) -=> -(cache-table-queries "foo" :action :flush) -=> -(list-attribute-types "foo") -=> (("id" :INT4 4 NIL 1) ("height" :FLOAT8 8 NIL 1) ("name" :BPCHAR 36 NIL 1) - ("comments" :BPCHAR 100 NIL 1)) - - - - Side Effects - - The internal attribute cache for - database is modified. - - - - Affected by - - *cache-table-queries-default* - - - - Exceptional Situations - - None. - - - - See Also - - *cache-table-queries-default* - - - - Notes - - None. - - - - - INSERT-RECORDS - Function INSERT-RECORDS + INSERT-RECORDS Insert tuples of data into a database table. Function @@ -391,7 +267,7 @@ UPDATE-RECORDS - Function UPDATE-RECORDS + UPDATE-RECORDS Updates the values of existing records. Function @@ -551,7 +427,7 @@ DELETE-RECORDS - Function DELETE-RECORDS + DELETE-RECORDS Delete records from a database table. Function @@ -665,7 +541,7 @@ EXECUTE-COMMAND - Generic Function EXECUTE-COMMAND + EXECUTE-COMMAND Execute an SQL command which returns no values. Generic Function @@ -769,7 +645,7 @@ QUERY - Generic Function QUERY + QUERY Execute an SQL query and return the tuples as a list. Generic Function @@ -973,7 +849,7 @@ PRINT-QUERY - Function PRINT-QUERY + PRINT-QUERY Prints a tabular report of query results. Function @@ -1129,7 +1005,7 @@ ID FORENAME SURNAME EMAIL SELECT - Function SELECT + SELECT Executes a query given the supplied constraints. Function @@ -1506,7 +1382,7 @@ ID FORENAME SURNAME EMAIL DO-QUERY - Macro DO-QUERY + DO-QUERY Iterate over all the tuples of a query. Macro @@ -1687,9 +1563,10 @@ ID FORENAME SURNAME EMAIL LOOP - Additional clause for LOOP - Iterate over all the tuples of a - query via a loop clause. + LOOP + Extension to Common Lisp + Loop to iterate over all the + tuples of a query via a loop clause. Loop Clause + + *default-update-objects-max-len* + Exceptional Situations - + Database errors. @@ -482,7 +514,30 @@ Arguments and Values - + + object + + + An instance of a view class. + + + + + slot + + + The name of a slot in object. + + + + + database + + + A database connection. + + + @@ -502,36 +557,35 @@ - examples + Examples - side effects + Side Effects - modifies sql database. + Modifies database. - affected by + Affected By - - - + Nothing. - exceptional situations + Exceptional Situations - if a database error occurs. + Database errors. - see also + See Also - + update-record-from-slots + update-records-from-instance @@ -555,14 +609,37 @@ (update-record-from-slots object slots &key (database *default-database*)) => - arguments and values + Arguments and Values - + + object + + + An instance of a view class. + + + + + slots + + + A list of slot names in object. + + + + + database + + + A database connection. + + + - description - updates the values stored in the columns represented by + Description + Updates the values stored in the columns represented by the slots, specified by the clos slot names slots, of view class instance object. database @@ -591,22 +668,21 @@ Affected by - - - + Nothing. Exceptional Situations - + Database errors. See Also - + update-record-from-slot + update-records-from-instance @@ -633,7 +709,22 @@ Arguments and Values - + + object + + + An instance of a view class. + + + + + database + + + A database connection. + + + @@ -659,28 +750,27 @@ Side Effects - + Modifies the database. Affected by - - - + Nothing. Exceptional Situations - + Database errors. See Also - + update-record-from-slot + update-record-from-slots @@ -706,7 +796,30 @@ Arguments and Values - + + object + + + An instance of a view class. + + + + + slot + + + The name of a slot in object. + + + + + database + + + A database connection. + + + @@ -746,7 +859,7 @@ Exceptional Situations - SQL access errors. + Database errors. diff --git a/doc/ref-recording.xml b/doc/ref-recording.xml index c89e059..1057210 100644 --- a/doc/ref-recording.xml +++ b/doc/ref-recording.xml @@ -28,7 +28,7 @@ START-SQL-RECORDING - Function START-SQL-RECORDING + START-SQL-RECORDING Start recording SQL commands or results. Function @@ -139,7 +139,7 @@ STOP-SQL-RECORDING - Function STOP-SQL-RECORDING + STOP-SQL-RECORDING Stop recording SQL commands or results. Function @@ -249,7 +249,7 @@ SQL-RECORDING-P - Function SQL-RECORDING-P + SQL-RECORDING-P Tests whether SQL commands or results are being recorded. Function @@ -357,7 +357,7 @@ SQL-STREAM - Function SQL-STREAM + SQL-STREAM Returns the broadcast stream used for recording SQL commands or results. Function @@ -462,7 +462,7 @@ ADD-SQL-STREAM - Function ADD-SQL-STREAM + ADD-SQL-STREAM Add a component to the broadcast streams used for recording SQL commands or results. Function @@ -592,7 +592,7 @@ DELETE-SQL-STREAM - Function DELETE-SQL-STREAM + DELETE-SQL-STREAM Remove a component from the broadcast streams used for recording SQL commands or results. Function @@ -718,7 +718,7 @@ LIST-SQL-STREAMS - Function LIST-SQL-STREAMS + LIST-SQL-STREAMS List the components of the broadcast streams used for recording SQL commands or results. Function diff --git a/doc/ref-syntax.xml b/doc/ref-syntax.xml index c83cab3..da28038 100644 --- a/doc/ref-syntax.xml +++ b/doc/ref-syntax.xml @@ -23,7 +23,7 @@ ENABLE-SQL-READER-SYNTAX - Macro ENABLE-SQL-READER-SYNTAX + ENABLE-SQL-READER-SYNTAX Globally enable square bracket reader syntax. Macro @@ -97,7 +97,7 @@ DISABLE-SQL-READER-SYNTAX - Macro DISABLE-SQL-READER-SYNTAX + DISABLE-SQL-READER-SYNTAX Globally disable square bracket reader syntax. Macro @@ -171,7 +171,7 @@ LOCALLY-ENABLE-SQL-READER-SYNTAX - Macro LOCALLY-ENABLE-SQL-READER-SYNTAX + LOCALLY-ENABLE-SQL-READER-SYNTAX Globally enable square bracket reader syntax. Macro @@ -249,7 +249,7 @@ LOCALLY-DISABLE-SQL-READER-SYNTAX - Macro LOCALLY-DISABLE-SQL-READER-SYNTAX + LOCALLY-DISABLE-SQL-READER-SYNTAX Locally disable square bracket reader syntax. Macro @@ -330,7 +330,7 @@ RESTORE-SQL-READER-SYNTAX-STATE - Macro RESTORE-SQL-READER-SYNTAX-STATE + RESTORE-SQL-READER-SYNTAX-STATE Restore square bracket reader syntax to its previous state. @@ -414,7 +414,7 @@ SQL - Function SQL + SQL Construct an SQL string from supplied expressions. Function @@ -513,7 +513,7 @@ SQL-EXPRESSION - Function SQL-EXPRESSION + SQL-EXPRESSION Constructs an SQL expression from supplied keyword arguments. Function @@ -671,7 +671,7 @@ SQL-OPERATION - Function SQL-OPERATION + SQL-OPERATION Constructs an SQL expression from a supplied operator and arguments. Function @@ -775,7 +775,7 @@ SQL-OPERATOR - Function SQL-OPERATOR + SQL-OPERATOR Returns the symbol for the supplied SQL operator. Function diff --git a/doc/ref-transaction.xml b/doc/ref-transaction.xml index cbb60c2..77a690d 100644 --- a/doc/ref-transaction.xml +++ b/doc/ref-transaction.xml @@ -31,7 +31,7 @@ START-TRANSACTION - Function START-TRANSACTION + START-TRANSACTION Open a transaction block. Function @@ -132,7 +132,7 @@ COMMIT - Function COMMIT + COMMIT Commit modifications made in the current transaction. Function @@ -236,7 +236,7 @@ ROLLBACK - Function ROLLBACK + ROLLBACK Roll back modifications made in the current transaction. Function @@ -339,7 +339,7 @@ IN-TRANSACTION-P - Function IN-TRANSACTION-P + IN-TRANSACTION-P A predicate for testing whether a transaction is currently in progress. Function @@ -431,7 +431,7 @@ ADD-TRANSACTION-COMMIT-HOOK - Function ADD-TRANSACTION-COMMIT-HOOK + ADD-TRANSACTION-COMMIT-HOOK Specify hooks to be run when committing changes. Function @@ -532,7 +532,7 @@ ADD-TRANSACTION-ROLLBACK-HOOK - Function ADD-TRANSACTION-ROLLBACK-HOOK + ADD-TRANSACTION-ROLLBACK-HOOK Specify hooks to be run when rolling back changes. Function @@ -632,7 +632,7 @@ SET-AUTOCOMMIT - Function SET-AUTOCOMMIT + SET-AUTOCOMMIT Turn on or off autocommit for a database. Function @@ -733,7 +733,7 @@ WITH-TRANSACTION - Macro WITH-TRANSACTION + WITH-TRANSACTION Execute a body of code within a transaction. Macro -- 2.34.1