X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;ds=sidebyside;f=doc%2Fref-conditions.xml;fp=doc%2Fref-conditions.xml;h=650dd98343a1e3a5fb3be0bfd36866e77c32e6cb;hb=5248ae9f94d2022596ef8846e0581ea716607a84;hp=0000000000000000000000000000000000000000;hpb=23a10375f83c89c138369e05c8f57f679bb43ec9;p=clsql.git diff --git a/doc/ref-conditions.xml b/doc/ref-conditions.xml new file mode 100644 index 0000000..650dd98 --- /dev/null +++ b/doc/ref-conditions.xml @@ -0,0 +1,634 @@ + + +%myents; +]> + + + + CLSQL Condition System + + + + + + + + + *BACKEND-WARNING-BEHAVIOR* + + Variable + + + Value Type + + + + + + Initial Value + nil + + + Description Action to perform on warning messages + from backend. Default is to :warn. May also be set to :error to + signal an error or :ignore/nil to silently ignore the warning. + + + Examples + + + + + + Affected By + None. + + + See Also + None. + + + Notes + None. + + + + + + SQL-CONDITION + the super-type of all + &clsql;-specific + conditions + Condition Type + + + Class Precedence List + + + sql-condition + condition + t + + + + + Description + This is the super-type of all + &clsql;-specific conditions + defined by &clsql;, or any of it's + database-specific interfaces. There are no defined + initialization arguments nor any accessors. + + + + + + SQL-ERROR + the super-type of all + &clsql;-specific + errors + Condition Type + + + Class Precedence List + + + sql-error + error + serious-condition + sql-condition + condition + t + + + + + Description + This is the super-type of all + &clsql;-specific conditions that + represent errors, as defined by + &clsql;, or any of it's + database-specific interfaces. There are no defined + initialization arguments nor any accessors. + + + + + + SQL-WARNING + the super-type of all + &clsql;-specific + warnings + Condition Type + + + Class Precedence List + + + sql-warning + warning + sql-condition + condition + t + + + + + Description + This is the super-type of all + &clsql;-specific conditions that + represent warnings, as defined by + &clsql;, or any of it's + database-specific interfaces. There are no defined + initialization arguments nor any accessors. + + + + + + SQL-DATABASE-WARNING + Used to warn while accessing a + &clsql; database. + Condition Type + + + Class Precedence List + + + sql-database-warning + sql-warning + warning + sql-condition + condition + t + + + + + Description + + This condition represents warnings signalled while accessing + a database. The following initialization arguments and + accessors exist: + + + Initarg + Accessor + Description + + :database + sql-warning-database + The database object that was involved in the + incident. + + + + + + + + + + SQL-USER-ERROR + condition representing errors because of invalid + parameters from the library user. + Condition Type + + + Class Precedence List + + + sql-user-error + sql-error + sql-condition + condition + t + + + + + Description + This condition represents errors that occur because the + user supplies invalid data to &clsql;. This includes errors such as + an invalid format connection specification or an error in the syntax + for the LOOP macro extensions. + The following initialization arguments and + accessors exist: + + + Initarg + Accessor + Description + + :message + sql-user-error-message + The error message. + + + + + + + + SQL-DATABASE-ERROR + condition representing errors during query or + command execution + Condition Type + + + Class Precedence List + + + sql-database-error + sql-error + error + serious-condition + sql-condition + condition + t + + + + + Description + This condition represents errors that occur while + executing SQL statements, either as part of query operations + or command execution, either explicitly or implicitly, as + caused e.g. by with-transaction. + The following initialization arguments and accessors exist: + + Initarg + Accessor + Description + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-error-database-message + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + + + + SQL-CONNECTION-ERROR + condition representing errors during + connection + Condition Type + + + Class Precedence List + + + sql-connection-error + sql-database-error + sql-error + sql-condition + condition + t + + + + + Description + This condition represents errors that occur while trying + to connect to a database. The following initialization + arguments and accessors exist: + + Initarg + Accessor + Description + + :database-type + sql-connection-error-database-type + Database type for the connection attempt + + + :connection-spec + sql-connection-error-connection-spec + The connection specification used in the + connection attempt. + + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-database-error-error + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + + + + SQL-DATABASE-DATA-ERROR + Used to signal an error with the SQL data passed + to a database. + Condition Type + + + Class Precedence List + + + sql-database-data-error + sql-database-error + sql-error + error + serious-condition + sql-condition + condition + t + + + + + Description + This condition represents errors that occur while + executing SQL statements, specifically as a result of + malformed SQL expressions. The following initialization + arguments and accessors exist: + + Initarg + Accessor + Description + + :expression + sql-database-error-expression + The SQL expression whose execution caused the error. + + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-error-database-message + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + + + + SQL-TEMPORARY-ERROR + Used to signal a temporary error in the database + backend. + Condition Type + + + Class Precedence List + + + sql-database-error + sql-error + error + serious-condition + sql-condition + condition + t + + + + + Description + This condition represents errors occurring when the + database cannot currently process a valid interaction because, + for example, it is still executing another command possibly + issued by another user. The following initialization arguments + and accessors exist: + + Initarg + Accessor + Description + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-error-database-message + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + + + + SQL-TIMEOUT-ERROR + condition representing errors when a connection + times out. + Condition Type + + + Class Precedence List + + + sql-connection-error + sql-database-error + sql-error + sql-condition + condition + t + + + + + Description + This condition represents errors that occur when the + database times out while processing some operation. The + following initialization arguments and accessors exist: + + Initarg + Accessor + Description + + :database-type + sql-connection-error-database-type + Database type for the connection attempt + + + :connection-spec + sql-connection-error-connection-spec + The connection specification used in the + connection attempt. + + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-error-database-message + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + + + + SQL-FATAL-ERROR + condition representing a fatal error in a database + connection + Condition Type + + + Class Precedence List + + + sql-connection-error + sql-database-error + sql-error + sql-condition + condition + t + + + + + Description + This condition represents errors occurring when the + database connection is no longer usable. The following + initialization arguments and accessors exist: + + Initarg + Accessor + Description + + :database-type + sql-connection-error-database-type + Database type for the connection attempt + + + :connection-spec + sql-connection-error-connection-spec + The connection specification used in the + connection attempt. + + + :database + sql-database-error-database + The database object that was involved in the + incident. + + + :error-id + sql-error-error-id + The numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :secondary-error-id + sql-error-secondary-error-id + The secondary numeric or symbolic error specification + returned by the database back-end. The values and + semantics of this are interface specific. + + + :message + sql-error-database-message + A string describing the problem that occurred, + possibly one returned by the database back-end. + + + + + +