X-Git-Url: http://git.kpe.io/?a=blobdiff_plain;f=doc%2Fref_clsql_sys.xml;fp=doc%2Fref_clsql_sys.xml;h=0000000000000000000000000000000000000000;hb=d7c392377a80fa24d746692eadbb5ae0f8dcdd88;hp=9a141bfb4f7d21483dd8e19da712ae12ff72153a;hpb=4acd394aa304abb683270f8ce6979e7efc423e23;p=clsql.git diff --git a/doc/ref_clsql_sys.xml b/doc/ref_clsql_sys.xml deleted file mode 100644 index 9a141bf..0000000 --- a/doc/ref_clsql_sys.xml +++ /dev/null @@ -1,103 +0,0 @@ - - -%myents; -]> - - - <symbol>CLSQL-BASE</symbol> - - This part gives a reference to the symbols exported from - the package CLSQL-BASE, which are not exported - from CLSQL package.. These symbols are part of - the interface for database back-ends, but not part of the normal - user-interface of &clsql;. - - - - DATABASE-INITIALIZE-DATABASE-TYPE - Back-end part of initialize-database-type. - Generic Function - - - Syntax - database-initialize-database-type database-type => result - - - Arguments and Values - - - database-type - - A keyword indicating the database type to - initialize. - - - - result - - Either t if the initialization - succeeds or nil if it fails. - - - - - - Description - This generic function implements the main part of the - database type initialization performed by - initialize-database-type. After - initialize-database-type has checked - that the given database type has not been initialized - before, as indicated by - *initialized-database-types*, it will call - this function with the database type as it's sole - parameter. Database back-ends are required to define a - method on this generic function which is specialized via an - eql-specializer to the keyword representing their database - type. - Database back-ends shall indicate successful - initialization by returning t from their - method, and nil otherwise. Methods for - this generic function are allowed to signal errors of type - clsql-error or subtypes thereof. - They may also signal other types of conditions, if - appropriate, but have to document this. - - - Examples - - - - Side Effects - All necessary side effects to initialize the database - instance. - - - Affected By - None. - - - Exceptional Situations - Conditions of type clsql-error - or other conditions may be signalled, depending on the - database back-end. - - - See Also - - - initialize-database-type - *initialized-database-types* - - - - - Notes - None. - - -