doc/ref-ooddl.xml

   1 <?xml version='1.0' ?>
   2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
   3 "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd" [
   4 <!ENTITY % myents SYSTEM "entities.inc">
   5 %myents;
   6 ]>
   7
   8 <!-- Object Oriented Data Definition Language -->
   9 <reference id="ref-ooddl">
  10   <title>Object Oriented Data Definition Language (OODDL)</title>
  11   <partintro>
  12     <para>
  13       The Object Oriented Data Definition Language (OODDL) provides
  14       access to relational SQL tables using Common Lisp Object System
  15       (CLOS) objects.  SQL tables are mapped to CLOS objects with the
  16       SQL columns being mapped to slots of the CLOS object.
  17     </para>
  18     <para>
  19       The mapping between SQL tables and CLOS objects is defined with
  20       the macro <link
  21       linkend="def-view-class"><function>def-view-class</function></link>. SQL
  22       tables are created with <link
  23       linkend="create-view-from-class"><function>create-view-from-class</function></link>
  24       and SQL tables can be deleted with <link
  25       linkend="drop-view-from-class"><function>drop-view-from-class</function></link>.
  26     </para>
  27     <note>
  28       <para>The above functions refer to the Lisp
  29       <emphasis>view</emphasis> of the SQL table. This Lisp view
  30       should not be confused with SQL <function>VIEW</function>
  31       statement.</para>
  32     </note>
  33   </partintro>
  34
  35   <refentry id="standard-db-object">
  36     <refnamediv>
  37       <refname>STANDARD-DB-OBJECT</refname>
  38       <refpurpose>Superclass for all &clsql; View Classes.</refpurpose>
  39       <refclass>Class</refclass>
  40     </refnamediv>
  41     <refsect1>
  42       <title>Class Precedence List</title>
  43       <para>
  44         <simplelist type="inline">
  45           <member><type>standard-db-object</type></member>
  46           <member><type>standard-object</type></member>
  47           <member><type>t</type></member>
  48         </simplelist>
  49       </para>
  50     </refsect1>
  51     <refsect1>
  52       <title>Description</title> <para>This class is the superclass
  53       of all &clsql; View Classes.</para>
  54     </refsect1>
  55     <refsect1>
  56       <title>Class details</title>
  57       <programlisting>(defclass STANDARD-DB-OBJECT ()(...))</programlisting>
  58     </refsect1>
  59     <refsect1>
  60       <title>Slots</title>
  61       <para>
  62         <simplelist>
  63           <member>slot VIEW-DATABASE is of type (OR NULL DATABASE)
  64           which stores the associated database for the
  65           instance.</member>
  66         </simplelist>
  67       </para>
  68     </refsect1>
  69   </refentry>
  70
  71   <refentry id="default-string-length">
  72     <refnamediv>
  73       <refname>*DEFAULT-STRING-LENGTH*</refname>
  74       <refpurpose>Default length of SQL strings.</refpurpose>
  75       <refclass>Variable</refclass>
  76     </refnamediv>
  77     <refsect1>
  78       <title>Value Type</title>
  79       <para>
  80         Fixnum
  81       </para>
  82     </refsect1>
  83     <refsect1>
  84       <title>Initial Value</title>
  85       <para><parameter>255</parameter></para>
  86     </refsect1>
  87     <refsect1>
  88       <title>Description</title>
  89       <para>
  90         If a slot of a class defined by
  91         <function>def-view-class</function> is of the type
  92         <parameter>string</parameter> or
  93         <parameter>varchar</parameter> and does not have a length
  94         specified, then the value of this variable is used as SQL
  95         length.
  96       </para>
  97     </refsect1>
  98     <refsect1>
  99       <title>Examples</title>
 100       <screen>
 101 (let ((*default-string-length* 80))
 102   (def-view-class s80 ()
 103     ((a :type string)
 104      (b :type (string 80))
 105      (c :type varchar))))
 106 => #&lt;Standard-Db-Class S80 {480A431D}>
 107
 108 (create-view-from-class 's80)
 109 =>
 110 (table-exists-p [s80])
 111 => T
 112       </screen>
 113       <para>
 114         The above code causes a SQL table to be created with the SQL command
 115       </para>
 116       <screen>CREATE TABLE (A VARCHAR(80), B CHAR(80), C VARCHAR(80))</screen>
 117     </refsect1>
 118     <refsect1>
 119       <title>Affected By</title>
 120       <para>
 121         Some SQL backends do not support
 122         <parameter>varchar</parameter> lengths greater than 255.
 123       </para>
 124     </refsect1>
 125     <refsect1>
 126       <title>See Also</title>
 127       <para>None.</para>
 128     </refsect1>
 129     <refsect1>
 130       <title>Notes</title>
 131       <para>This is a CLSQL extension to the CommonSQL API.</para>
 132     </refsect1>
 133   </refentry>
 134
 135   <refentry id="create-view-from-class">
 136     <refnamediv>
 137       <refname>CREATE-VIEW-FROM-CLASS</refname>
 138       <refpurpose>Create a SQL table from a <glossterm linkend="gloss-view-class">View Class</glossterm>.</refpurpose>
 139       <refclass>Function</refclass>
 140     </refnamediv>
 141     <refsect1>
 142       <title>Syntax</title>
 143       <synopsis>
 144       <function>create-view-from-class</function> <replaceable>view-class-name</replaceable> &amp;key <replaceable>database</replaceable> <replaceable>transactions</replaceable> => <returnvalue><!-- no values --></returnvalue></synopsis>
 145     </refsect1>
 146     <refsect1>
 147       <title>Arguments and Values</title>
 148       <variablelist>
 149         <varlistentry>
 150           <term><parameter>view-class-name</parameter></term>
 151           <listitem>
 152             <para>
 153               The name of a <glossterm linkend="gloss-view-class">View
 154               Class</glossterm> that has been defined with <link
 155               linkend="def-view-class"><function>def-view-class</function></link>.
 156             </para>
 157           </listitem>
 158         </varlistentry>
 159         <varlistentry>
 160           <term><parameter>database</parameter></term>
 161           <listitem>
 162             <para>
 163               The <glossterm
 164               linkend="gloss-database-object">database</glossterm> in
 165               which to create the SQL table. This will default to the
 166               value of <symbol>*default-database*</symbol>.
 167             </para>
 168           </listitem>
 169         </varlistentry>
 170         <varlistentry>
 171           <term><parameter>transactions</parameter></term>
 172           <listitem>
 173             <para>
 174               When &nil; specifies that a table type which does not
 175               support transactions should be used.
 176             </para>
 177           </listitem>
 178         </varlistentry>
 179       </variablelist>
 180     </refsect1>
 181     <refsect1>
 182       <title>Description</title>
 183       <para>
 184         Creates a table as defined by the <glossterm
 185         linkend="gloss-view-class">View Class</glossterm>
 186         <parameter>view-class-name</parameter> in
 187         <parameter>database</parameter>.
 188       </para>
 189     </refsect1>
 190     <refsect1>
 191       <title>Examples</title>
 192       <screen>
 193 (def-view-class foo () ((a :type (string 80))))
 194 => #&lt;Standard-Db-Class FOO {4807F7CD}>
 195 (create-view-from-class 'foo)
 196 =>
 197 (list-tables)
 198 => ("FOO")
 199       </screen>
 200     </refsect1>
 201     <refsect1>
 202       <title>Side Effects</title>
 203       <para>
 204         Causes a table to be created in the SQL database.
 205       </para>
 206     </refsect1>
 207     <refsect1>
 208       <title>Affected by</title>
 209       <para>
 210         Most SQL database systems will signal an error if a table
 211         creation is attempted when a table with the same name already
 212         exists. The SQL user, as specified in the database connection,
 213         must have sufficient permission for table creation.
 214       </para>
 215     </refsect1>
 216     <refsect1>
 217       <title>Exceptional Situations</title>
 218       <para>
 219         A condition will be signaled if the table can not be created
 220         in the SQL database.
 221       </para>
 222     </refsect1>
 223     <refsect1>
 224       <title>See Also</title>
 225       <para>
 226         <simplelist>
 227           <member><link linkend="def-view-class"><function>def-view-class</function></link></member>
 228           <member><link linkend="drop-view-from-class"><function>drop-view-from-class</function></link></member>
 229         </simplelist>
 230       </para>
 231     </refsect1>
 232     <refsect1>
 233       <title>Notes</title>
 234       <para>
 235         Currently, only &mysql; supports transactionless
 236         tables. &clsql; provides the ability to create such tables for
 237         applications which would benefit from faster table access and
 238         do not require transaction support.
 239       </para>
 240       <para>
 241         The case of the table name is determined by the type of the
 242         database. &mysql;, for example, creates databases in upper-case
 243         while &postgresql; uses lowercase.
 244       </para>
 245     </refsect1>
 246   </refentry>
 247
 248   <refentry id="def-view-class">
 249     <refnamediv>
 250       <refname>DEF-VIEW-CLASS</refname>
 251       <refpurpose>Defines CLOS classes with mapping to SQL database.</refpurpose>
 252       <refclass>Macro</refclass>
 253     </refnamediv>
 254     <refsect1>
 255       <title>Syntax</title>
 256       <synopsis>
 257       <function>def-view-class</function> <replaceable>name</replaceable> <replaceable>superclasses</replaceable> <replaceable>slots</replaceable> &amp;rest <replaceable>class-options</replaceable> => <returnvalue>class</returnvalue></synopsis>
 258     </refsect1>
 259     <refsect1>
 260       <title>Arguments and Values</title>
 261       <variablelist>
 262         <varlistentry>
 263           <term><parameter>name</parameter></term>
 264           <listitem>
 265             <para>
 266               The class name.
 267             </para>
 268           </listitem>
 269         </varlistentry>
 270         <varlistentry>
 271           <term><parameter>superclasses</parameter></term>
 272           <listitem>
 273             <para>
 274               The superclasses for the defined class.
 275             </para>
 276           </listitem>
 277         </varlistentry>
 278         <varlistentry>
 279           <term><parameter>slots</parameter></term>
 280           <listitem>
 281             <para>
 282               The class slot definitions.
 283             </para>
 284           </listitem>
 285         </varlistentry>
 286         <varlistentry>
 287           <term><parameter>class options</parameter></term>
 288           <listitem>
 289             <para>
 290               The class options.
 291             </para>
 292           </listitem>
 293         </varlistentry>
 294         <varlistentry>
 295           <term><parameter>class</parameter></term>
 296           <listitem>
 297             <para>
 298               The defined class.
 299             </para>
 300           </listitem>
 301         </varlistentry>
 302       </variablelist>
 303     </refsect1>
 304     <refsect1>
 305       <title>Slot Options</title>
 306       <itemizedlist>
 307         <listitem>
 308           <para>
 309             <parameter>:db-kind</parameter> - specifies the kind of
 310             database mapping which is performed for this slot and
 311             defaults to <parameter>:base</parameter> which indicates
 312             that the slot maps to an ordinary column of the database
 313             table. A <parameter>:db-kind</parameter> value of
 314             <parameter>:key</parameter> indicates that this slot is a
 315             special kind of <parameter>:base</parameter> slot which
 316             maps onto a column which is one of the unique keys for the
 317             database table, the value <parameter>:join</parameter>
 318             indicates this slot represents a join onto another
 319             <glossterm linkend="gloss-view-class">View Class</glossterm>
 320             which contains View Class objects, and the value
 321             <parameter>:virtual</parameter> indicates a standard CLOS
 322             slot which does not map onto columns of the database
 323             table.
 324           </para>
 325         </listitem>
 326         <listitem>
 327           <para>
 328             <parameter>:db-info</parameter> - if a slot is specified
 329             with <parameter>:db-kind</parameter>
 330             <parameter>:join</parameter>, the slot option
 331             <parameter>:db-info</parameter> contains a property list
 332             which specifies the nature of the join. The valid members
 333             of the list are:
 334           </para>
 335           <itemizedlist>
 336             <listitem>
 337               <para>
 338                 <parameter>:join-class</parameter>
 339                 <emphasis>class-name</emphasis> - the name of the
 340                 class to join on.
 341               </para>
 342             </listitem>
 343             <listitem>
 344               <para>
 345                 <parameter>:home-key</parameter>
 346                 <emphasis>slot-name</emphasis> - the name of the slot
 347                 of this class for joining
 348               </para>
 349             </listitem>
 350             <listitem>
 351               <para>
 352                 <parameter>:foreign-key</parameter>
 353                 <emphasis>slot-name</emphasis> - the name of the slot
 354                 of the <parameter>:join-class</parameter> for joining
 355               </para>
 356             </listitem>
 357             <listitem>
 358               <para>
 359                 <parameter>:target-slot</parameter>
 360                 <emphasis>target-slot</emphasis> - this is an optional
 361                 parameter. If specified, then the join slot of the
 362                 defining class will contain instances of this target
 363                 slot rather than of the join class. This can be useful
 364                 when the <parameter>:join-class</parameter> is an
 365                 intermediate class in a
 366                 <emphasis>many-to-many</emphasis> relationship and the
 367                 application is actually interested in the
 368                 <parameter>:target-slot</parameter>.
 369               </para>
 370             </listitem>
 371             <listitem>
 372               <para>
 373                 <parameter>:retrieval</parameter>
 374                 <emphasis>time</emphasis> - The default value is
 375                 <parameter>:deferred</parameter>, which defers filling
 376                 this slot until the value is accessed. The other valid
 377                 value is <parameter>:immediate</parameter> which
 378                 performs the SQL query when the instance of the class
 379                 is created. In this case, the
 380                 <parameter>:set</parameter> is automatically set to
 381                 &nil;
 382               </para>
 383             </listitem>
 384             <listitem>
 385               <para>
 386                 <parameter>:set</parameter> <emphasis>set</emphasis> -
 387                 This controls what is stored in the join slot.  The
 388                 default value is &t;. When <emphasis>set</emphasis> is
 389                 &t; and <emphasis>target-slot</emphasis> is undefined,
 390                 the join slot will contain a list of instances of the
 391                 join class. Whereas, if
 392                 <emphasis>target-slot</emphasis> is defined, then the
 393                 join slot will contain a list of pairs of
 394                 <emphasis>(target-value join-instance)</emphasis>.
 395                 When <emphasis>set</emphasis> is &nil;, the join slot
 396                 will contain a single instances.
 397               </para>
 398             </listitem>
 399           </itemizedlist>
 400         </listitem>
 401         <listitem>
 402           <para>
 403             <parameter>:type</parameter> - for slots of
 404             <parameter>:db-kind</parameter> <parameter>:base</parameter> or
 405             <parameter>:key</parameter>, the <parameter>:type</parameter> slot
 406             option has a special interpretation such that Lisp
 407             types, such as string, integer and float are
 408             automatically converted into appropriate SQL types for
 409             the column onto which the slot maps. This behaviour may
 410             be overridden using the <parameter>:db-type</parameter> slot
 411             option. The valid values are:
 412             <simplelist>
 413               <member>
 414                 <parameter>string</parameter> - a variable length
 415                 character field up to <link
 416                 linkend="default-string-length">*default-string-length*</link>
 417                 characters.
 418               </member>
 419               <member>
 420                 <parameter>(string n)</parameter> - a fixed length
 421                 character field <parameter>n</parameter> characters
 422                 long.
 423               </member>
 424               <member>
 425                 <parameter>varchar</parameter> - a variable length
 426                 character field up to <link
 427                 linkend="default-string-length">*default-string-length*</link>
 428                 characters.
 429               </member>
 430               <member>
 431                 <parameter>(varchar n)</parameter> - a variable length
 432                 character field up to <parameter>n</parameter>
 433                 characters in length.
 434               </member>
 435               <member>
 436                 <parameter>char</parameter> - a single character field
 437               </member>
 438               <member><parameter>integer</parameter> - signed integer
 439               at least 32-bits wide</member>
 440               <member><parameter>(integer n)</parameter></member>
 441               <member><parameter>float</parameter></member>
 442               <member><parameter>(float n)</parameter></member>
 443               <member><parameter>long-float</parameter></member>
 444               <member><parameter>number</parameter></member>
 445               <member><parameter>(number n)</parameter></member>
 446               <member><parameter>(number n p)</parameter></member>
 447               <member>
 448                 <parameter>tinyint</parameter> - An integer column 8-bits
 449                 wide. [not supported by all database backends]
 450               </member>
 451               <member>
 452                 <parameter>smallint</parameter> - An integer column 16-bits
 453                 wide. [not supported by all database backends]
 454               </member>
 455               <member>
 456                 <parameter>bigint</parameter> - An integer column
 457                 64-bits wide. [not supported by all database backends]
 458               </member>
 459               <member>
 460                 <parameter>universal-time</parameter> - an integer
 461                 field sufficiently wide to store a
 462                 universal-time. On most databases, a slot of this
 463                 type assigned a SQL type of
 464                 <parameter>BIGINT</parameter>
 465               </member>
 466               <member>
 467                 <parameter>wall-time</parameter> - a slot which stores
 468                 a date and time in a SQL timestamp column. &clsql;
 469                 provides a number of time manipulation functions to
 470                 support objects of type <type>wall-time</type>.
 471               </member>
 472               <member>
 473                 <parameter>duration</parameter> - stores a
 474                 <type>duration</type> structure.  &clsql; provides
 475                 routines for <type>wall-time</type> and
 476                 <type>duration</type> processing.
 477               </member>
 478               <member><parameter>boolean</parameter> - stores a &t; or
 479               &nil; value.</member>
 480               <member>
 481                 <parameter>generalized-boolean</parameter> - similar
 482                 to a <parameter>boolean</parameter> in that either a
 483                 &t; or &nil; value is stored in the SQL
 484                 database. However, any Lisp object can be stored in
 485                 the Lisp object. A Lisp value of &nil; is stored as
 486                 <constant>FALSE</constant> in the database, any
 487                 other Lisp value is stored as
 488                 <constant>TRUE</constant>.
 489               </member>
 490               <member>
 491                 <parameter>keyword</parameter> - stores a keyword
 492               </member>
 493               <member><parameter>symbol</parameter> - stores a symbol</member>
 494               <member>
 495                 <parameter>list</parameter> - stores a list by writing
 496                 it to a string. The items in the list must be able to
 497                 be readable written.
 498               </member>
 499               <member><parameter>vector</parameter> - stores a vector
 500               similarly to <parameter>list</parameter></member>
 501               <member><parameter>array</parameter> - stores a array
 502               similarly to <parameter>list</parameter></member>
 503             </simplelist>
 504           </para>
 505
 506         </listitem>
 507         <listitem>
 508           <para>
 509             <parameter>:column</parameter> - specifies the name of
 510             the SQL column which the slot maps onto, if
 511             <parameter>:db-kind</parameter> is not
 512             <parameter>:virtual</parameter>, and defaults to the
 513             slot name. If the slot name is used for the SQL column
 514             name, any hypens in the slot name are converted
 515             to underscore characters.
 516           </para>
 517         </listitem>
 518         <listitem>
 519           <para>
 520             <parameter>:void-value</parameter> - specifies the value
 521             to store in the Lisp instance if the SQL value is NULL and
 522             defaults to NIL.
 523           </para>
 524         </listitem>
 525         <listitem>
 526           <para>
 527             <parameter>:db-constraints</parameter> - is a keyword
 528             symbol representing an SQL column constraint expression or
 529             a list of such symbols. The following column constraints
 530             are supported: <symbol>:not-null</symbol>,
 531             <symbol>:primary-key</symbol>, <symbol>:unique</symbol>,
 532             <symbol>:unsigned</symbol> (&mysql; specific),
 533             <symbol>:zerofill</symbol> (&mysql; specific) and
 534             <symbol>:auto-increment</symbol> (&mysql; specific).
 535           </para>
 536         </listitem>
 537         <listitem>
 538           <para>
 539             <parameter>:db-type</parameter> - a string to specify the SQL
 540             column type. If specified, this string overrides the SQL
 541             column type as computed from the <parameter>:type</parameter>
 542             slot value.
 543           </para>
 544         </listitem>
 545       </itemizedlist>
 546     </refsect1>
 547     <refsect1>
 548       <title>Class Options</title>
 549       <para>
 550         <itemizedlist>
 551           <listitem>
 552             <para>
 553               <parameter>:base-table</parameter> - specifies the name
 554               of the SQL database table. The default value is the
 555               class name. Like slot names, hypens in the class name
 556               are converted to underscore characters.
 557             </para>
 558           </listitem>
 559         </itemizedlist>
 560       </para>
 561     </refsect1>
 562     <refsect1>
 563       <title>Description</title>
 564       <para>
 565         Creates a <glossterm linkend="gloss-view-class">View
 566         Class</glossterm> called <parameter>name</parameter> whose
 567         slots <parameter>slots</parameter> can map onto the attributes
 568         of a table in a database. If
 569         <parameter>superclasses</parameter> is &nil; then the
 570         superclass of <parameter>class</parameter> will be
 571         <parameter>standard-db-object</parameter>, otherwise
 572         <parameter>superclasses</parameter> is a list of superclasses
 573         for <parameter>class</parameter> which must include
 574         <parameter>standard-db-object</parameter> or a descendent of
 575         this class.
 576       </para>
 577
 578     </refsect1>
 579     <refsect1>
 580       <title>Examples</title>
 581       <para>
 582         The following examples are from the &clsql; test suite.
 583       </para>
 584       <screen>
 585 (def-view-class person (thing)
 586   ((height :db-kind :base :accessor height :type float
 587            :initarg :height)
 588    (married :db-kind :base :accessor married :type boolean
 589             :initarg :married)
 590    (birthday :type clsql:wall-time :initarg :birthday)
 591    (bd-utime :type clsql:universal-time :initarg :bd-utime)
 592    (hobby :db-kind :virtual :initarg :hobby :initform nil)))
 593
 594 (def-view-class employee (person)
 595   ((emplid
 596     :db-kind :key
 597     :db-constraints :not-null
 598     :type integer
 599     :initarg :emplid)
 600    (groupid
 601     :db-kind :key
 602     :db-constraints :not-null
 603     :type integer
 604     :initarg :groupid)
 605    (first-name
 606     :accessor first-name
 607     :type (varchar 30)
 608     :initarg :first-name)
 609    (last-name
 610     :accessor last-name
 611     :type (varchar 30)
 612     :initarg :last-name)
 613    (email
 614     :accessor employee-email
 615     :type (varchar 100)
 616     :initarg :email)
 617    (ecompanyid
 618     :type integer
 619     :initarg :companyid)
 620    (company
 621     :accessor employee-company
 622     :db-kind :join
 623     :db-info (:join-class company
 624                           :home-key ecompanyid
 625                           :foreign-key companyid
 626                           :set nil))
 627    (managerid
 628     :type integer
 629     :initarg :managerid)
 630    (manager
 631     :accessor employee-manager
 632     :db-kind :join
 633     :db-info (:join-class employee
 634                           :home-key managerid
 635                           :foreign-key emplid
 636                           :set nil))
 637    (addresses
 638     :accessor employee-addresses
 639     :db-kind :join
 640     :db-info (:join-class employee-address
 641                           :home-key emplid
 642                           :foreign-key aemplid
 643                           :target-slot address
 644                           :set t)))
 645   (:base-table employee))
 646
 647 (def-view-class company ()
 648   ((companyid
 649     :db-kind :key
 650     :db-constraints :not-null
 651     :type integer
 652     :initarg :companyid)
 653    (groupid
 654     :db-kind :key
 655     :db-constraints :not-null
 656     :type integer
 657     :initarg :groupid)
 658    (name
 659     :type (varchar 100)
 660     :initarg :name)
 661    (presidentid
 662     :type integer
 663     :initarg :presidentid)
 664    (president
 665     :reader president
 666     :db-kind :join
 667     :db-info (:join-class employee
 668                           :home-key presidentid
 669                           :foreign-key emplid
 670                           :set nil))
 671    (employees
 672     :reader company-employees
 673     :db-kind :join
 674     :db-info (:join-class employee
 675                           :home-key (companyid groupid)
 676                           :foreign-key (ecompanyid groupid)
 677                           :set t))))
 678
 679 (def-view-class address ()
 680   ((addressid
 681     :db-kind :key
 682     :db-constraints :not-null
 683     :type integer
 684     :initarg :addressid)
 685    (street-number
 686     :type integer
 687     :initarg :street-number)
 688    (street-name
 689     :type (varchar 30)
 690     :void-value ""
 691     :initarg :street-name)
 692    (city
 693     :column "city_field"
 694     :void-value "no city"
 695     :type (varchar 30)
 696     :initarg :city)
 697    (postal-code
 698     :column zip
 699     :type integer
 700     :void-value 0
 701     :initarg :postal-code))
 702   (:base-table addr))
 703
 704 ;; many employees can reside at many addressess
 705 (def-view-class employee-address ()
 706   ((aemplid :type integer :initarg :emplid)
 707    (aaddressid :type integer :initarg :addressid)
 708    (verified :type boolean :initarg :verified)
 709    (address :db-kind :join
 710             :db-info (:join-class address
 711                                   :home-key aaddressid
 712                                   :foreign-key addressid
 713                                   :retrieval :immediate)))
 714   (:base-table "ea_join"))
 715
 716 (def-view-class deferred-employee-address ()
 717   ((aemplid :type integer :initarg :emplid)
 718    (aaddressid :type integer :initarg :addressid)
 719    (verified :type boolean :initarg :verified)
 720    (address :db-kind :join
 721             :db-info (:join-class address
 722                                   :home-key aaddressid
 723                                   :foreign-key addressid
 724                                   :retrieval :deferred
 725                                   :set nil)))
 726   (:base-table "ea_join"))
 727       </screen>
 728     </refsect1>
 729     <refsect1>
 730       <title>Side Effects</title>
 731       <para>Creates a new CLOS class.</para>
 732     </refsect1>
 733     <refsect1>
 734       <title>Affected by</title>
 735       <para>
 736         Nothing.
 737       </para>
 738     </refsect1>
 739     <refsect1>
 740       <title>Exceptional Situations</title>
 741       <para>
 742         None.
 743       </para>
 744     </refsect1>
 745     <refsect1>
 746       <title>See Also</title>
 747       <para>
 748         <simplelist>
 749           <member><link linkend="create-view-from-class"><function>create-view-from-class</function></link></member>
 750           <member><link linkend="standard-db-object"><parameter>standard-db-object</parameter></link></member>
 751           <member><link linkend="drop-view-from-class"><function>drop-view-from-class</function></link></member>
 752         </simplelist>
 753       </para>
 754     </refsect1>
 755     <refsect1>
 756       <title>Notes</title>
 757       <para>
 758         The actual SQL type for a column depends up the database type
 759         in which the SQL table is stored. As an example, the view
 760         class type <parameter>(varchar 100)</parameter> specifies a
 761         SQL column type <parameter>VARCHAR(100)</parameter> in &mysql;
 762         and a column type <parameter>VARCHAR2(100)</parameter> in
 763         &oracle;
 764       </para>
 765       <para>
 766         The actual lisp type for a slot may be different than the
 767         value specified by the <parameter>:type</parameter> attribute.
 768         For example, a slot declared with "<parameter>:type (string
 769         30)</parameter>" actually sets the slots Lisp type as
 770         <parameter>(or null string)</parameter>. This is to allow a
 771         &nil; value or a string shorter than 30 characters to be
 772         stored in the slot.
 773       </para>
 774     </refsect1>
 775   </refentry>
 776
 777   <refentry id="drop-view-from-class">
 778     <refnamediv>
 779       <refname>DROP-VIEW-FROM-CLASS</refname>
 780       <refpurpose>Delete table from SQL database.</refpurpose>
 781       <refclass>Function</refclass>
 782     </refnamediv>
 783     <refsect1>
 784       <title>Syntax</title>
 785       <synopsis>
 786       <function>drop-view-from-class</function> <replaceable>view-class-name</replaceable> &amp;key <replaceable>database</replaceable> => <returnvalue><!-- result --></returnvalue></synopsis>
 787     </refsect1>
 788     <refsect1>
 789       <title>Arguments and Values</title>
 790       <variablelist>
 791         <varlistentry>
 792           <term><parameter>view-class-name</parameter></term>
 793           <listitem>
 794             <para>
 795               The name of the <glossterm linkend="gloss-view-class">View
 796               Class</glossterm>.
 797             </para>
 798           </listitem>
 799         </varlistentry>
 800         <varlistentry>
 801           <term><parameter>database</parameter></term>
 802           <listitem>
 803             <para>
 804               <glossterm linkend="gloss-database-object">database
 805               object</glossterm>. This will default to the value of
 806               <symbol>*default-database*</symbol>.
 807             </para>
 808           </listitem>
 809         </varlistentry>
 810       </variablelist>
 811     </refsect1>
 812     <refsect1>
 813       <title>Description</title>
 814       <para>Removes a table defined by the <glossterm
 815       linkend="gloss-view-class">View Class</glossterm>
 816       <parameter>view-class-name</parameter> from
 817       <parameter>database</parameter> which defaults to
 818       <parameter>*default-database*</parameter>.
 819       </para>
 820     </refsect1>
 821     <refsect1>
 822       <title>Examples</title>
 823       <screen>
 824 (list-tables)
 825 => ("FOO" "BAR")
 826 (drop-view-from-class 'foo)
 827 =>
 828 (list-tables)
 829 => ("BAR")
 830       </screen>
 831     </refsect1>
 832     <refsect1>
 833       <title>Side Effects</title>
 834       <para>
 835         Deletes a table from the SQL database.
 836       </para>
 837     </refsect1>
 838     <refsect1>
 839       <title>Affected by</title>
 840       <para>
 841         Whether the specified table exists in the SQL database.
 842       </para>
 843     </refsect1>
 844     <refsect1>
 845       <title>Exceptional Situations</title>
 846       <para>
 847         A condition may be signalled if the table does not exist in
 848         the SQL database or if the SQL connection does not have
 849         sufficient permissions to delete tables.
 850       </para>
 851     </refsect1>
 852     <refsect1>
 853       <title>See Also</title>
 854       <para>
 855         <simplelist>
 856           <member><link linkend="create-view-from-class"><function>create-view-from-class</function></link></member>
 857           <member><link linkend="def-view-class"><function>def-view-class</function></link></member>
 858         </simplelist>
 859       </para>
 860     </refsect1>
 861     <refsect1>
 862       <title>Notes</title>
 863       <para>
 864         None.
 865       </para>
 866     </refsect1>
 867   </refentry>
 868
 869   <refentry id="list-classes">
 870     <refnamediv>
 871       <refname>LIST-CLASSES</refname>
 872       <refpurpose>List classes for tables in SQL database.</refpurpose>
 873       <refclass>Function</refclass>
 874     </refnamediv>
 875     <refsect1>
 876       <title>Syntax</title>
 877       <synopsis>
 878       <function>list-classes</function> &amp;key <replaceable>test</replaceable> <replaceable>root-class</replaceable> <replaceable>database</replaceable> => <returnvalue>classes</returnvalue></synopsis>
 879     </refsect1>
 880     <refsect1>
 881       <title>Arguments and Values</title>
 882       <variablelist>
 883         <varlistentry>
 884           <term><parameter>test</parameter></term>
 885           <listitem>
 886             <para>
 887               a function used to filter the search. By default, <parameter>identity</parameter> is used which
 888               will return all classes.
 889             </para>
 890           </listitem>
 891         </varlistentry>
 892         <varlistentry>
 893           <term><parameter>root-class</parameter></term>
 894           <listitem>
 895             <para>
 896               specifies the root class to the search. By default,
 897               <parameter>standard-db-object</parameter> is used which
 898               is the root for all view classes.
 899             </para>
 900           </listitem>
 901         </varlistentry>
 902         <varlistentry>
 903           <term><parameter>database</parameter></term>
 904           <listitem>
 905             <para>
 906               The <glossterm
 907               linkend="gloss-database-object">database</glossterm> to
 908               search for view classes. This will default to the value
 909               of <symbol>*default-database*</symbol>.
 910             </para>
 911           </listitem>
 912         </varlistentry>
 913         <varlistentry>
 914           <term><parameter>classes</parameter></term>
 915           <listitem>
 916             <para>
 917               List of view classes.
 918             </para>
 919           </listitem>
 920         </varlistentry>
 921       </variablelist>
 922     </refsect1>
 923     <refsect1>
 924       <title>Description</title>
 925       <para>Returns a list of all the View Classes which have been
 926       defined in the Lisp session and are connected to
 927       <parameter>database</parameter> and which descended from the
 928       class <parameter>root-class</parameter> and which satisfy the
 929       function <parameter>test</parameter>.
 930       </para>
 931     </refsect1>
 932     <refsect1>
 933       <title>Examples</title>
 934       <screen>
 935 (list-classes)
 936 => (#&lt;clsql-sys::standard-db-class big> #&lt;clsql-sys::standard-db-class employee-address>
 937     #&lt;clsql-sys::standard-db-class address> #&lt;clsql-sys::standard-db-class company>
 938     #&lt;clsql-sys::standard-db-class employee>)
 939
 940 (list-classes :test #'(lambda (c) (> (length (symbol-name (class-name c))) 3)))
 941 => (#&lt;clsql-sys::standard-db-class employee-address> #&lt;clsql-sys::standard-db-class address>
 942     #&lt;clsql-sys::standard-db-class company> #&lt;clsql-sys::standard-db-class employee>)
 943       </screen>
 944     </refsect1>
 945     <refsect1>
 946       <title>Side Effects</title>
 947       <para>
 948         None.
 949       </para>
 950     </refsect1>
 951     <refsect1>
 952       <title>Affected by</title>
 953       <para>
 954         <simplelist>
 955           <member>Which view classes have been defined in the Lisp
 956           session.</member>
 957         </simplelist>
 958       </para>
 959     </refsect1>
 960     <refsect1>
 961       <title>Exceptional Situations</title>
 962       <para>
 963         None.
 964       </para>
 965     </refsect1>
 966     <refsect1>
 967       <title>See Also</title>
 968       <para>
 969         <simplelist>
 970           <member><link linkend="def-view-class"><function>def-view-class</function></link></member>
 971         </simplelist>
 972       </para>
 973     </refsect1>
 974     <refsect1>
 975       <title>Notes</title>
 976       <para>
 977         None.
 978       </para>
 979     </refsect1>
 980   </refentry>
 981
 982
 983 </reference>