r9734: Document idiosyncrasies of the individual backends and differences from CommonSQL.
[clsql.git] / doc / global-index.xml
1 <reference id="indexes">
2   <title>Index</title>
3   
4   <refentry id="clsql-index">
5     <refnamediv>
6       <refname>Alphabetical Index for package CLSQL</refname>  
7       <refpurpose>Clickable index of all symbols</refpurpose>
8     </refnamediv>
9     
10     <refsect1>
11       <simplelist columns="2">
12     
13     <!-- VARIABLES --> 
14
15     <member><link hovertext="variable *BACKEND-WARNING-BEHAVIOR* is of type T" linkend="backend-warning-behavior">*BACKEND-WARNING-BEHAVIOR*</link></member>
16     <member><link hovertext="variable *CACHE-TABLE-QUERIES-DEFAULT* is of type T" linkend="cache-table-queries-default">*CACHE-TABLE-QUERIES-DEFAULT*</link></member>
17     <member><link hovertext="variable *CONNECT-IF-EXISTS* is of type T" linkend="connect-if-exists">*CONNECT-IF-EXISTS*</link></member>
18     <member><link hovertext="variable *DB-AUTO-SYNC* is of type T" linkend="db-auto-sync">*DB-AUTO-SYNC*</link></member>
19     <member><link hovertext="variable *DEFAULT-DATABASE* is of type T" linkend="default-database">*DEFAULT-DATABASE*</link></member>
20     <member><link hovertext="variable *DEFAULT-DATABASE-TYPE* is of type T" linkend="default-database-type">*DEFAULT-DATABASE-TYPE*</link></member>
21     <member><link hovertext="variable *DEFAULT-UPDATE-OBJECTS-MAX-LEN* is of type T" linkend="default-update-objects-max-len">*DEFAULT-UPDATE-OBJECTS-MAX-LEN*</link></member>
22     <member><link hovertext="variable *DEFAULT-STRING-LENGTH* is of type T [parameter]" linkend="default-varchar-length">*DEFAULT-STRING-LENGTH*</link></member>
23     <member><link hovertext="variable *INITIALIZED-DATABASE-TYPES* is of type T" linkend="initialized-database-types">*INITIALIZED-DATABASE-TYPES*</link></member>
24
25     <!-- OTHER SYMBOLS IN ALPHABETICAL ORDER --> 
26
27     <member><link hovertext="(ADD-SQL-STREAM STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="add-sql-stream">ADD-SQL-STREAM</link></member>
28     <member><link hovertext="(ADD-TRANSACTION-COMMIT-HOOK DATABASE COMMIT-HOOK) [function]" linkend="add-transaction-commit-hook">ADD-TRANSACTION-COMMIT-HOOK</link></member>
29     <member><link hovertext="(ADD-TRANSACTION-ROLLBACK-HOOK DATABASE ROLLBACK-HOOK) [function]" linkend="add-transaction-rollback-hook">ADD-TRANSACTION-ROLLBACK-HOOK</link></member>
30     <member><link hovertext="(ATTRIBUTE-TYPE ATTRIBUTE TABLE &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="attribute-type">ATTRIBUTE-TYPE</link></member>
31     <member><link hovertext="(CACHE-TABLE-QUERIES TABLE &amp;KEY (ACTION NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="cache-table-queries">CACHE-TABLE-QUERIES</link></member>
32     <member><link hovertext="(COMMIT &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="commit">COMMIT</link></member>
33     <member><link hovertext="(CONNECT CONNECTION-SPEC &amp;KEY (IF-EXISTS *CONNECT-IF-EXISTS*) (MAKE-DEFAULT T) (POOL NIL) (DATABASE-TYPE *DEFAULT-DATABASE-TYPE*)) [function]" linkend="connect">CONNECT</link></member>
34     <member><link hovertext="(CONNECTED-DATABASES ) [function]" linkend="connected-databases">CONNECTED-DATABASES</link></member>
35     <member><link hovertext="(CREATE-DATABASE CONNECTION-SPEC &amp;KEY DATABASE-TYPE) [function]" linkend="create-database">CREATE-DATABASE</link></member>
36     <member><link hovertext="(CREATE-INDEX NAME &amp;KEY ON (UNIQUE NIL) ATTRIBUTES (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="create-index">CREATE-INDEX</link></member>
37     <member><link hovertext="(CREATE-SEQUENCE NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="create-sequence">CREATE-SEQUENCE</link></member>
38     <member><link hovertext="(CREATE-TABLE NAME DESCRIPTION &amp;KEY (DATABASE *DEFAULT-DATABASE*) (CONSTRAINTS NIL) (TRANSACTIONS T)) [function]" linkend="create-table">CREATE-TABLE</link></member>
39     <member><link hovertext="(CREATE-VIEW NAME &amp;KEY AS COLUMN-LIST (WITH-CHECK-OPTION NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="create-view">CREATE-VIEW</link></member>
40     <member><link hovertext="(CREATE-VIEW-FROM-CLASS VIEW-CLASS-NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="create-view-from-class">CREATE-VIEW-FROM-CLASS</link></member>
41     <member><link hovertext="(defclass DATABASE ()(...))" linkend="database">DATABASE</link></member>
42     <member><link hovertext="(DATABASE-NAME (OBJ DATABASE)) [reader]" linkend="database-name">DATABASE-NAME</link></member>
43     <member><link hovertext="(DATABASE-NAME-FROM-SPEC CONNECTION-SPEC DATABASE-TYPE) [generic function]" linkend="database-name-from-spec">DATABASE-NAME-FROM-SPEC</link></member>
44     <member><link hovertext="(DATABASE-TYPE (OBJ DATABASE)) [reader]" linkend="database-type">DATABASE-TYPE</link></member>
45     <member><link hovertext="(DEF-VIEW-CLASS CLASS SUPERS SLOTS &amp;REST CL-OPTIONS) [macro]" linkend="def-view-class">DEF-VIEW-CLASS</link></member>
46     <member><link hovertext="(DELETE-INSTANCE-RECORDS OBJECT) [generic]" linkend="delete-instance-records">DELETE-INSTANCE-RECORDS</link></member>
47     <member><link hovertext="(DELETE-RECORDS &amp;KEY (FROM NIL) (WHERE NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="delete-records">DELETE-RECORDS</link></member>
48     <member><link hovertext="(DELETE-SQL-STREAM STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="delete-sql-stream">DELETE-SQL-STREAM</link></member>
49     <member><link hovertext="(DESTROY-DATABASE CONNECTION-SPEC &amp;KEY DATABASE-TYPE) [function]" linkend="destroy-database">DESTROY-DATABASE</link></member>
50     <member><link hovertext="(DISABLE-SQL-READER-SYNTAX ) [macro]" linkend="disable-sql-reader-syntax">DISABLE-SQL-READER-SYNTAX</link></member>
51     <member><link hovertext="(DISCONNECT &amp;KEY (DATABASE *DEFAULT-DATABASE*) (ERROR NIL)) [function]" linkend="disconnect">DISCONNECT</link></member>
52     <member><link hovertext="(DISCONNECT-POOLED &amp;OPTIONAL CLEAR) [function]" linkend="disconnect-pooled">DISCONNECT-POOLED</link></member>
53     <member><link hovertext="(DO-QUERY &amp;KEY (DATABASE '*DEFAULT-DATABASE*) (RESULT-TYPES :AUTO) &amp;REST QUERY-EXPRESSION &amp;BODY BODY) [macro]" linkend="do-query">DO-QUERY</link></member>
54     <member><link hovertext="(DROP-INDEX NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (ON NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="drop-index">DROP-INDEX</link></member>
55     <member><link hovertext="(DROP-SEQUENCE NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="drop-sequence">DROP-SEQUENCE</link></member>
56     <member><link hovertext="(DROP-TABLE NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="drop-table">DROP-TABLE</link></member>
57     <member><link hovertext="(DROP-VIEW NAME &amp;KEY (IF-DOES-NOT-EXIST :ERROR) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="drop-view">DROP-VIEW</link></member>
58     <member><link hovertext="(DROP-VIEW-FROM-CLASS VIEW-CLASS-NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="drop-view-from-class">DROP-VIEW-FROM-CLASS</link></member>
59     <member><link hovertext="(ENABLE-SQL-READER-SYNTAX ) [macro]" linkend="enable-sql-reader-syntax">ENABLE-SQL-READER-SYNTAX</link></member>
60     <member><link hovertext="(EXECUTE-COMMAND EXPRESSION &amp;KEY DATABASE) [generic]" linkend="execute-command">EXECUTE-COMMAND</link></member>
61     <member><link hovertext="(FIND-DATABASE DATABASE &amp;KEY (ERRORP T) (DB-TYPE NIL)) [function]" linkend="find-database">FIND-DATABASE</link></member>
62     <member><link hovertext="(IN-TRANSACTION-P &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="in-transaction-p">IN-TRANSACTION-P</link></member>
63     <member><link hovertext="(INDEX-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="index-exists-p">INDEX-EXISTS-P</link></member>
64     <member><link hovertext="(INITIALIZE-DATABASE-TYPE &amp;KEY (DATABASE-TYPE *DEFAULT-DATABASE-TYPE*)) [function]" linkend="initialize-database-type">INITIALIZE-DATABASE-TYPE</link></member>
65     <member><link hovertext="(INSERT-RECORDS &amp;KEY (INTO NIL) (ATTRIBUTES NIL) (VALUES NIL) (AV-PAIRS NIL) (QUERY NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="insert-records">INSERT-RECORDS</link></member>
66     <member><link hovertext="(INSTANCE-REFRESHED OBJECT) [generic]" linkend="instance-refreshed">INSTANCE-REFRESHED</link></member>
67     <member><link hovertext="(LIST-ATTRIBUTE-TYPES TABLE &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-attribute-types">LIST-ATTRIBUTE-TYPES</link></member>
68     <member><link hovertext="(LIST-ATTRIBUTES NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-attributes">LIST-ATTRIBUTES</link></member>
69     <member><link hovertext="(LIST-CLASSES &amp;KEY (TEST #'IDENTITY) (ROOT-CLASS (FIND-CLASS 'STANDARD-DB-OBJECT)) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-classes">LIST-CLASSES</link></member>
70     <member><link hovertext="(LIST-DATABASES CONNECTION-SPEC &amp;KEY DATABASE-TYPE) [function]" linkend="list-databases">LIST-DATABASES</link></member>
71     <member><link hovertext="(LIST-INDEXES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-indexes">LIST-INDEXES</link></member>
72     <member><link hovertext="(LIST-SEQUENCES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-sequences">LIST-SEQUENCES</link></member>
73     <member><link hovertext="(LIST-SQL-STREAMS &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-sql-streams">LIST-SQL-STREAMS</link></member>
74     <member><link hovertext="(LIST-TABLES &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-tables">LIST-TABLES</link></member>
75     <member><link hovertext="(LIST-VIEWS &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="list-views">LIST-VIEWS</link></member>
76     <member><link hovertext="(LOCALLY-DISABLE-SQL-READER-SYNTAX ) [macro]" linkend="locally-disable-sql-reader-syntax">LOCALLY-DISABLE-SQL-READER-SYNTAX</link></member>
77     <member><link hovertext="(LOCALLY-ENABLE-SQL-READER-SYNTAX ) [macro]" linkend="locally-enable-sql-reader-syntax">LOCALLY-ENABLE-SQL-READER-SYNTAX</link></member>
78     <member><link hovertext="(LOOP FOR AS TUPLES)" linkend="loop-tuples">LOOP-FOR-AS-TUPLES</link></member>
79     <member><link hovertext="(MAP-QUERY OUTPUT-TYPE-SPEC FUNCTION QUERY-EXPRESSION &amp; DATABASE RESULT-TYPES" linkend="map-query">MAP-QUERY</link></member>
80     <member><link hovertext="(PROBE-DATABASE CONNECTION-SPEC &amp;KEY DATABASE-TYPE) [function]" linkend="probe-database">PROBE-DATABASE</link></member>
81     <member><link hovertext="(QUERY QUERY-EXPRESSION &amp;KEY DATABASE RESULT-TYPES FLATP FIELD-NAMES) [generic]" linkend="query">QUERY</link></member>
82     <member><link hovertext="(RECONNECT &amp;KEY (DATABASE *DEFAULT-DATABASE*) (ERROR NIL) (FORCE T)) [function]" linkend="reconnect">RECONNECT</link></member>
83     <member><link hovertext="(RESTORE-SQL-READER-SYNTAX-STATE ) [macro]" linkend="restore-sql-reader-syntax-state">RESTORE-SQL-READER-SYNTAX-STATE</link></member>
84     <member><link hovertext="(ROLLBACK &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="rollback">ROLLBACK</link></member>
85     <member><link hovertext="(SELECT &amp;REST SELECT-ALL-ARGS) [function]" linkend="select">SELECT</link></member>
86     <member><link hovertext="(SEQUENCE-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="sequence-exists-p">SEQUENCE-EXISTS-P</link></member>
87     <member><link hovertext="(SEQUENCE-LAST NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="sequence-last">SEQUENCE-LAST</link></member>
88     <member><link hovertext="(SEQUENCE-NEXT NAME &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="sequence-next">SEQUENCE-NEXT</link></member>
89     <member><link hovertext="(SET-AUTOCOMMIT VALUE &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="set-autocommit">SET-AUTOCOMMIT</link></member>
90     <member><link hovertext="(SET-SEQUENCE-POSITION NAME POSITION &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="set-sequence-position">SET-SEQUENCE-POSITION</link></member>
91     <member><link hovertext="(SQL &amp;REST ARGS) [function]" linkend="sql">SQL</link></member>
92     <member><link hovertext="SQL-CONDITION" linkend="sql-condition">SQL-CONDITION</link></member>
93     <member><link hovertext="SQL-CONNECTION-ERROR" linkend="sql-connection-error">SQL-CONNECTION-ERROR</link></member>
94     <member><link hovertext="SQL-DATABASE-DATA-ERROR" linkend="sql-database-data-error">SQL-DATABASE-DATA-ERROR</link></member>
95     <member><link hovertext="SQL-DATABASE-ERROR" linkend="sql-database-error">SQL-DATABASE-ERROR</link></member>
96     <member><link hovertext="SQL-DATABASE-WARNING" linkend="sql-database-warning">SQL-DATABASE-WARNING</link></member>
97     <member><link hovertext="SQL-ERROR" linkend="sql-error">SQL-ERROR</link></member>
98     <member><link hovertext="(SQL-EXPRESSION &amp;KEY STRING TABLE ALIAS ATTRIBUTE TYPE) [function]" linkend="sql-expression">SQL-EXPRESSION</link></member>
99     <member><link hovertext="SQL-FATAL-ERROR" linkend="sql-fatal-error">SQL-FATAL-ERROR</link></member>
100     <member><link hovertext="(SQL-OPERATION OPERATOR &amp;REST ARGS) [function]" linkend="sql-operation">SQL-OPERATION</link></member>
101     <member><link hovertext="(SQL-OPERATOR OPERATOR) [function]" linkend="sql-operator">SQL-OPERATOR</link></member>
102     <member><link hovertext="(SQL-RECORDING-P &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="sql-recording-p">SQL-RECORDING-P</link></member>
103     <member><link hovertext="(SQL-STREAM &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="sql-stream">SQL-STREAM</link></member>
104     <member><link hovertext="SQL-TEMPORARY-ERROR" linkend="sql-temporary-error">SQL-TEMPORARY-ERROR</link></member>
105     <member><link hovertext="SQL-TIMEOUT-ERROR" linkend="sql-timeout-error">SQL-TIMEOUT-ERROR</link></member>
106     <member><link hovertext="SQL-USER-ERROR" linkend="sql-user-error">SQL-USER-ERROR</link></member>
107     <member><link hovertext="SQL-WARNING" linkend="sql-warning">SQL-WARNING</link></member>
108     <member><link hovertext="(START-SQL-RECORDING &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="start-sql-recording">START-SQL-RECORDING</link></member>
109     <member><link hovertext="(START-TRANSACTION &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="start-transaction">START-TRANSACTION</link></member>
110     <member><link hovertext="(STATUS &amp;OPTIONAL FULL) [function]" linkend="status">STATUS</link></member>
111     <member><link hovertext="(STOP-SQL-RECORDING &amp;KEY (TYPE :COMMANDS) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="stop-sql-recording">STOP-SQL-RECORDING</link></member>
112     <member><link hovertext="(TABLE-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="table-exists-p">TABLE-EXISTS-P</link></member>
113     <member><link hovertext="(TRUNCATE-DATABASE &amp;KEY (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="truncate-database">TRUNCATE-DATABASE</link></member>
114     <member><link hovertext="(UPDATE-INSTANCE-FROM-RECORDS OBJECT &amp;KEY DATABASE) [generic]" linkend="update-instance-from-records">UPDATE-INSTANCE-FROM-RECORDS</link></member>
115     <member><link hovertext="(UPDATE-OBJECTS-JOINS OBJECTS &amp;KEY (SLOTS T) (FORCE-P T) CLASS-NAME (MAX-LEN *DEFAULT-UPDATE-OBJECTS-MAX-LEN*)) [function]" linkend="update-objects-joins">UPDATE-OBJECTS-JOINS</link></member>
116     <member><link hovertext="(UPDATE-RECORD-FROM-SLOT OBJECT SLOT &amp;KEY DATABASE) [generic]" linkend="update-record-from-slot">UPDATE-RECORD-FROM-SLOT</link></member>
117     <member><link hovertext="(UPDATE-RECORD-FROM-SLOTS OBJECT SLOTS &amp;KEY DATABASE) [generic]" linkend="update-record-from-slots">UPDATE-RECORD-FROM-SLOTS</link></member>
118     <member><link hovertext="(UPDATE-RECORDS TABLE &amp;KEY (ATTRIBUTES NIL) (VALUES NIL) (AV-PAIRS NIL) (WHERE NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="update-records">UPDATE-RECORDS</link></member>
119     <member><link hovertext="(UPDATE-RECORDS-FROM-INSTANCE OBJECT &amp;KEY DATABASE) [generic]" linkend="update-records-from-instance">UPDATE-RECORDS-FROM-INSTANCE</link></member>
120     <member><link hovertext="(UPDATE-SLOT-FROM-RECORD OBJECT SLOT &amp;KEY DATABASE) [generic]" linkend="update-slot-from-record">UPDATE-SLOT-FROM-RECORD</link></member>
121     <member><link hovertext="(VIEW-EXISTS-P NAME &amp;KEY (OWNER NIL) (DATABASE *DEFAULT-DATABASE*)) [function]" linkend="view-exists-p">VIEW-EXISTS-P</link></member>
122     <member><link hovertext="(WITH-DATABASE DB-VAR CONNECTION-SPEC &amp;REST CONNECT-ARGS &amp;BODY BODY) [macro]" linkend="with-database">WITH-DATABASE</link></member>
123     <member><link hovertext="(WITH-DEFAULT-DATABASE DATABASE &amp;REST BODY) [macro]" linkend="with-default-database">WITH-DEFAULT-DATABASE</link></member>
124     <member><link hovertext="(WITH-TRANSACTION &amp;KEY (DATABASE '*DEFAULT-DATABASE*) &amp;REST BODY) [macro]" linkend="with-transaction">WITH-TRANSACTION</link></member>
125   </simplelist>
126 </refsect1>
127 </refentry>
128 </reference>