CLSQL Users' Guide Kevin M. Rosenberg Marcus T. Pearce Pierre R. Mai onShore Development, Inc. CLSQL Users' Guide by Kevin M. Rosenberg, Marcus T. Pearce, Pierre R. Mai, and onShore Development, Inc. • CLSQL is Copyright © 2002-2004 by Kevin M. Rosenberg, Copyright © 1999-2001 by Pierre R. Mai, and Copyright © 1999-2003 onShore Development, Inc. • Allegro CL® is a registered trademark of Franz Inc. • Common SQL, LispWorks are trademarks or registered trademarks of LispWorks Ltd. • Oracle® is a registered trademark of Oracle Inc. • Microsoft Windows® is a registered trademark of Microsoft Inc. • Other brand or product names are the registered trademarks or trademarks of their respective holders. Table of Contents Preface ................................................................................................................... viii 1. Introduction ............................................................................................................ 1 Purpose .............................................................................................................1 History ..............................................................................................................1 Prerequisites ...................................................................................................... 1 ASDF .......................................................................................................1 UFFI ........................................................................................................1 MD5 .........................................................................................................1 Supported Common Lisp Implementation ........................................................ 2 Supported SQL Implementation ..................................................................... 2 Installation ......................................................................................................... 2 Ensure ASDF is loaded ................................................................................ 2 Build C helper libraries ................................................................................ 2 Add UFFI path ...........................................................................................3 Add MD5 path ...........................................................................................3 Add CLSQL path and load module ................................................................. 3 Run test suite (optional) ................................................................................ 3 2. CommonSQL Tutorial .............................................................................................. 5 Introduction ....................................................................................................... 5 Data Modeling with CLSQL ..................................................................................5 Class Relations ................................................................................................... 7 Object Creation .................................................................................................. 9 Finding Objects ................................................................................................ 11 Deleting Objects ............................................................................................... 12 Conclusion ...................................................................................................... 12 I. Connection and Initialisation .................................................................................... 13 DATABASE .................................................................................................... 14 *CONNECT-IF-EXISTS* .................................................................................. 15 *DEFAULT-DATABASE* ................................................................................ 16 *DEFAULT-DATABASE-TYPE* ....................................................................... 18 *INITIALIZED-DATABASE-TYPES* ................................................................ 19 CONNECT ...................................................................................................... 20 CONNECTED-DATABASES ............................................................................. 23 DATABASE-NAME ......................................................................................... 25 DATABASE-NAME-FROM-SPEC ..................................................................... 27 DATABASE-TYPE .......................................................................................... 29 DISCONNECT ................................................................................................. 31 DISCONNECT-POOLED .................................................................................. 33 FIND-DATABASE ........................................................................................... 34 INITIALIZE-DATABASE-TYPE ........................................................................ 36 RECONNECT .................................................................................................. 38 STATUS ......................................................................................................... 40 CREATE-DATABASE ...................................................................................... 42 DESTROY-DATABASE ................................................................................... 44 PROBE-DATABASE ........................................................................................ 46 LIST-DATABASES .......................................................................................... 47 WITH-DATABASE .......................................................................................... 49 WITH-DEFAULT-DATABASE .......................................................................... 51 II. The Symbolic SQL Syntax ...................................................................................... 53 ENABLE-SQL-READER-SYNTAX .................................................................... 54 DISABLE-SQL-READER-SYNTAX ................................................................... 55 LOCALLY-ENABLE-SQL-READER-SYNTAX ................................................... 56 LOCALLY-DISABLE-SQL-READER-SYNTAX .................................................. 58 iv CLSQL Users' Guide RESTORE-SQL-READER-SYNTAX-STATE ....................................................... 60 SQL ............................................................................................................... 62 SQL-EXPRESSION .......................................................................................... 64 SQL-OPERATION ........................................................................................... 66 SQL-OPERATOR ............................................................................................. 68 III. Functional Data Definition Language (FDDL) ........................................................... 71 CREATE-TABLE ............................................................................................. 72 DROP-TABLE ................................................................................................. 74 LIST-TABLES ................................................................................................. 76 TABLE-EXISTS-P ............................................................................................ 78 CREATE-VIEW ............................................................................................... 80 DROP-VIEW ................................................................................................... 82 LIST-VIEWS ................................................................................................... 84 VIEW-EXISTS-P .............................................................................................. 86 CREATE-INDEX ............................................................................................. 88 DROP-INDEX ................................................................................................. 90 LIST-INDEXES ............................................................................................... 92 INDEX-EXISTS-P ............................................................................................ 94 ATTRIBUTE-TYPE .......................................................................................... 96 LIST-ATTRIBUTE-TYPES ................................................................................ 98 LIST-ATTRIBUTES ....................................................................................... 100 CREATE-SEQUENCE .................................................................................... 102 DROP-SEQUENCE ........................................................................................ 104 LIST-SEQUENCES ........................................................................................ 106 SEQUENCE-EXISTS-P ................................................................................... 108 SEQUENCE-LAST ......................................................................................... 110 SEQUENCE-NEXT ........................................................................................ 112 SET-SEQUENCE-POSITION ........................................................................... 114 TRUNCATE-DATABASE ..............................................................................