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>date</parameter> - a slot which stores the
 474                 date (without any time of day resolution) in a
 475                 column. &clsql; provides a number of time
 476                 manipulation functions that operate on date values.
 477               </member>
 478               <member>
 479                 <parameter>duration</parameter> - stores a
 480                 <type>duration</type> structure.  &clsql; provides
 481                 routines for <type>wall-time</type> and
 482                 <type>duration</type> processing.
 483               </member>
 484               <member><parameter>boolean</parameter> - stores a &t; or
 485               &nil; value.</member>
 486               <member>
 487                 <parameter>generalized-boolean</parameter> - similar
 488                 to a <parameter>boolean</parameter> in that either a
 489                 &t; or &nil; value is stored in the SQL
 490                 database. However, any Lisp object can be stored in
 491                 the Lisp object. A Lisp value of &nil; is stored as
 492                 <constant>FALSE</constant> in the database, any
 493                 other Lisp value is stored as
 494                 <constant>TRUE</constant>.
 495               </member>
 496               <member>
 497                 <parameter>keyword</parameter> - stores a keyword
 498               </member>
 499               <member><parameter>symbol</parameter> - stores a symbol</member>
 500               <member>
 501                 <parameter>list</parameter> - stores a list by writing
 502                 it to a string. The items in the list must be able to
 503                 be readable written.
 504               </member>
 505               <member><parameter>vector</parameter> - stores a vector
 506               similarly to <parameter>list</parameter></member>
 507               <member><parameter>array</parameter> - stores a array
 508               similarly to <parameter>list</parameter></member>
 509             </simplelist>
 510           </para>
 511
 512         </listitem>
 513         <listitem>
 514           <para>
 515             <parameter>:column</parameter> - specifies the name of
 516             the SQL column which the slot maps onto, if
 517             <parameter>:db-kind</parameter> is not
 518             <parameter>:virtual</parameter>, and defaults to the
 519             slot name. If the slot name is used for the SQL column
 520             name, any hypens in the slot name are converted
 521             to underscore characters.
 522           </para>
 523         </listitem>
 524         <listitem>
 525           <para>
 526             <parameter>:void-value</parameter> - specifies the value
 527             to store in the Lisp instance if the SQL value is NULL and
 528             defaults to NIL.
 529           </para>
 530         </listitem>
 531         <listitem>
 532           <para>
 533             <parameter>:db-constraints</parameter> - is a keyword
 534             symbol representing an SQL column constraint expression or
 535             a list of such symbols. The following column constraints
 536             are supported: <symbol>:not-null</symbol>,
 537             <symbol>:primary-key</symbol>, <symbol>:unique</symbol>,
 538             <symbol>:unsigned</symbol> (&mysql; specific),
 539             <symbol>:zerofill</symbol> (&mysql; specific) and
 540             <symbol>:auto-increment</symbol> (&mysql; specific).
 541           </para>
 542         </listitem>
 543         <listitem>
 544           <para>
 545             <parameter>:db-type</parameter> - a string to specify the SQL
 546             column type. If specified, this string overrides the SQL
 547             column type as computed from the <parameter>:type</parameter>
 548             slot value.
 549           </para>
 550         </listitem>
 551       </itemizedlist>
 552     </refsect1>
 553     <refsect1>
 554       <title>Class Options</title>
 555       <para>
 556         <itemizedlist>
 557           <listitem>
 558             <para>
 559               <parameter>:base-table</parameter> - specifies the name
 560               of the SQL database table. The default value is the
 561               class name. Like slot names, hypens in the class name
 562               are converted to underscore characters.
 563             </para>
 564           </listitem>
 565         </itemizedlist>
 566       </para>
 567     </refsect1>
 568     <refsect1>
 569       <title>Description</title>
 570       <para>
 571         Creates a <glossterm linkend="gloss-view-class">View
 572         Class</glossterm> called <parameter>name</parameter> whose
 573         slots <parameter>slots</parameter> can map onto the attributes
 574         of a table in a database. If
 575         <parameter>superclasses</parameter> is &nil; then the
 576         superclass of <parameter>class</parameter> will be
 577         <parameter>standard-db-object</parameter>, otherwise
 578         <parameter>superclasses</parameter> is a list of superclasses
 579         for <parameter>class</parameter> which must include
 580         <parameter>standard-db-object</parameter> or a descendent of
 581         this class.
 582       </para>
 583
 584     </refsect1>
 585     <refsect1>
 586       <title>Examples</title>
 587       <para>
 588         The following examples are from the &clsql; test suite.
 589       </para>
 590       <screen>
 591 (def-view-class person (thing)
 592   ((height :db-kind :base :accessor height :type float
 593            :initarg :height)
 594    (married :db-kind :base :accessor married :type boolean
 595             :initarg :married)
 596    (birthday :type clsql:wall-time :initarg :birthday)
 597    (bd-utime :type clsql:universal-time :initarg :bd-utime)
 598    (hobby :db-kind :virtual :initarg :hobby :initform nil)))
 599
 600 (def-view-class employee (person)
 601   ((emplid
 602     :db-kind :key
 603     :db-constraints :not-null
 604     :type integer
 605     :initarg :emplid)
 606    (groupid
 607     :db-kind :key
 608     :db-constraints :not-null
 609     :type integer
 610     :initarg :groupid)
 611    (first-name
 612     :accessor first-name
 613     :type (varchar 30)
 614     :initarg :first-name)
 615    (last-name
 616     :accessor last-name
 617     :type (varchar 30)
 618     :initarg :last-name)
 619    (email
 620     :accessor employee-email
 621     :type (varchar 100)
 622     :initarg :email)
 623    (ecompanyid
 624     :type integer
 625     :initarg :companyid)
 626    (company
 627     :accessor employee-company
 628     :db-kind :join
 629     :db-info (:join-class company
 630                           :home-key ecompanyid
 631                           :foreign-key companyid
 632                           :set nil))
 633    (managerid
 634     :type integer
 635     :initarg :managerid)
 636    (manager
 637     :accessor employee-manager
 638     :db-kind :join
 639     :db-info (:join-class employee
 640                           :home-key managerid
 641                           :foreign-key emplid
 642                           :set nil))
 643    (addresses
 644     :accessor employee-addresses
 645     :db-kind :join
 646     :db-info (:join-class employee-address
 647                           :home-key emplid
 648                           :foreign-key aemplid
 649                           :target-slot address
 650                           :set t)))
 651   (:base-table employee))
 652
 653 (def-view-class company ()
 654   ((companyid
 655     :db-kind :key
 656     :db-constraints :not-null
 657     :type integer
 658     :initarg :companyid)
 659    (groupid
 660     :db-kind :key
 661     :db-constraints :not-null
 662     :type integer
 663     :initarg :groupid)
 664    (name
 665     :type (varchar 100)
 666     :initarg :name)
 667    (presidentid
 668     :type integer
 669     :initarg :presidentid)
 670    (president
 671     :reader president
 672     :db-kind :join
 673     :db-info (:join-class employee
 674                           :home-key presidentid
 675                           :foreign-key emplid
 676                           :set nil))
 677    (employees
 678     :reader company-employees
 679     :db-kind :join
 680     :db-info (:join-class employee
 681                           :home-key (companyid groupid)
 682                           :foreign-key (ecompanyid groupid)
 683                           :set t))))
 684
 685 (def-view-class address ()
 686   ((addressid
 687     :db-kind :key
 688     :db-constraints :not-null
 689     :type integer
 690     :initarg :addressid)
 691    (street-number
 692     :type integer
 693     :initarg :street-number)
 694    (street-name
 695     :type (varchar 30)
 696     :void-value ""
 697     :initarg :street-name)
 698    (city
 699     :column "city_field"
 700     :void-value "no city"
 701     :type (varchar 30)
 702     :initarg :city)
 703    (postal-code
 704     :column zip
 705     :type integer
 706     :void-value 0
 707     :initarg :postal-code))
 708   (:base-table addr))
 709
 710 ;; many employees can reside at many addressess
 711 (def-view-class employee-address ()
 712   ((aemplid :type integer :initarg :emplid)
 713    (aaddressid :type integer :initarg :addressid)
 714    (verified :type boolean :initarg :verified)
 715    (address :db-kind :join
 716             :db-info (:join-class address
 717                                   :home-key aaddressid
 718                                   :foreign-key addressid
 719                                   :retrieval :immediate)))
 720   (:base-table "ea_join"))
 721
 722 (def-view-class deferred-employee-address ()
 723   ((aemplid :type integer :initarg :emplid)
 724    (aaddressid :type integer :initarg :addressid)
 725    (verified :type boolean :initarg :verified)
 726    (address :db-kind :join
 727             :db-info (:join-class address
 728                                   :home-key aaddressid
 729                                   :foreign-key addressid
 730                                   :retrieval :deferred
 731                                   :set nil)))
 732   (:base-table "ea_join"))
 733       </screen>
 734     </refsect1>
 735     <refsect1>
 736       <title>Side Effects</title>
 737       <para>Creates a new CLOS class.</para>
 738     </refsect1>
 739     <refsect1>
 740       <title>Affected by</title>
 741       <para>
 742         Nothing.
 743       </para>
 744     </refsect1>
 745     <refsect1>
 746       <title>Exceptional Situations</title>
 747       <para>
 748         None.
 749       </para>
 750     </refsect1>
 751     <refsect1>
 752       <title>See Also</title>
 753       <para>
 754         <simplelist>
 755           <member><link linkend="create-view-from-class"><function>create-view-from-class</function></link></member>
 756           <member><link linkend="standard-db-object"><parameter>standard-db-object</parameter></link></member>
 757           <member><link linkend="drop-view-from-class"><function>drop-view-from-class</function></link></member>
 758         </simplelist>
 759       </para>
 760     </refsect1>
 761     <refsect1>
 762       <title>Notes</title>
 763       <para>
 764         The actual SQL type for a column depends up the database type
 765         in which the SQL table is stored. As an example, the view
 766         class type <parameter>(varchar 100)</parameter> specifies a
 767         SQL column type <parameter>VARCHAR(100)</parameter> in &mysql;
 768         and a column type <parameter>VARCHAR2(100)</parameter> in
 769         &oracle;
 770       </para>
 771       <para>
 772         The actual lisp type for a slot may be different than the
 773         value specified by the <parameter>:type</parameter> attribute.
 774         For example, a slot declared with "<parameter>:type (string
 775         30)</parameter>" actually sets the slots Lisp type as
 776         <parameter>(or null string)</parameter>. This is to allow a
 777         &nil; value or a string shorter than 30 characters to be
 778         stored in the slot.
 779       </para>
 780     </refsect1>
 781   </refentry>
 782
 783   <refentry id="drop-view-from-class">
 784     <refnamediv>
 785       <refname>DROP-VIEW-FROM-CLASS</refname>
 786       <refpurpose>Delete table from SQL database.</refpurpose>
 787       <refclass>Function</refclass>
 788     </refnamediv>
 789     <refsect1>
 790       <title>Syntax</title>
 791       <synopsis>
 792       <function>drop-view-from-class</function> <replaceable>view-class-name</replaceable> &amp;key <replaceable>database</replaceable> => <returnvalue><!-- result --></returnvalue></synopsis>
 793     </refsect1>
 794     <refsect1>
 795       <title>Arguments and Values</title>
 796       <variablelist>
 797         <varlistentry>
 798           <term><parameter>view-class-name</parameter></term>
 799           <listitem>
 800             <para>
 801               The name of the <glossterm linkend="gloss-view-class">View
 802               Class</glossterm>.
 803             </para>
 804           </listitem>
 805         </varlistentry>
 806         <varlistentry>
 807           <term><parameter>database</parameter></term>
 808           <listitem>
 809             <para>
 810               <glossterm linkend="gloss-database-object">database
 811               object</glossterm>. This will default to the value of
 812               <symbol>*default-database*</symbol>.
 813             </para>
 814           </listitem>
 815         </varlistentry>
 816       </variablelist>
 817     </refsect1>
 818     <refsect1>
 819       <title>Description</title>
 820       <para>Removes a table defined by the <glossterm
 821       linkend="gloss-view-class">View Class</glossterm>
 822       <parameter>view-class-name</parameter> from
 823       <parameter>database</parameter> which defaults to
 824       <parameter>*default-database*</parameter>.
 825       </para>
 826     </refsect1>
 827     <refsect1>
 828       <title>Examples</title>
 829       <screen>
 830 (list-tables)
 831 => ("FOO" "BAR")
 832 (drop-view-from-class 'foo)
 833 =>
 834 (list-tables)
 835 => ("BAR")
 836       </screen>
 837     </refsect1>
 838     <refsect1>
 839       <title>Side Effects</title>
 840       <para>
 841         Deletes a table from the SQL database.
 842       </para>
 843     </refsect1>
 844     <refsect1>
 845       <title>Affected by</title>
 846       <para>
 847         Whether the specified table exists in the SQL database.
 848       </para>
 849     </refsect1>
 850     <refsect1>
 851       <title>Exceptional Situations</title>
 852       <para>
 853         A condition may be signalled if the table does not exist in
 854         the SQL database or if the SQL connection does not have
 855         sufficient permissions to delete tables.
 856       </para>
 857     </refsect1>
 858     <refsect1>
 859       <title>See Also</title>
 860       <para>
 861         <simplelist>
 862           <member><link linkend="create-view-from-class"><function>create-view-from-class</function></link></member>
 863           <member><link linkend="def-view-class"><function>def-view-class</function></link></member>
 864         </simplelist>
 865       </para>
 866     </refsect1>
 867     <refsect1>
 868       <title>Notes</title>
 869       <para>
 870         None.
 871       </para>
 872     </refsect1>
 873   </refentry>
 874
 875   <refentry id="list-classes">
 876     <refnamediv>
 877       <refname>LIST-CLASSES</refname>
 878       <refpurpose>List classes for tables in SQL database.</refpurpose>
 879       <refclass>Function</refclass>
 880     </refnamediv>
 881     <refsect1>
 882       <title>Syntax</title>
 883       <synopsis>
 884       <function>list-classes</function> &amp;key <replaceable>test</replaceable> <replaceable>root-class</replaceable> <replaceable>database</replaceable> => <returnvalue>classes</returnvalue></synopsis>
 885     </refsect1>
 886     <refsect1>
 887       <title>Arguments and Values</title>
 888       <variablelist>
 889         <varlistentry>
 890           <term><parameter>test</parameter></term>
 891           <listitem>
 892             <para>
 893               a function used to filter the search. By default, <parameter>identity</parameter> is used which
 894               will return all classes.
 895             </para>
 896           </listitem>
 897         </varlistentry>
 898         <varlistentry>
 899           <term><parameter>root-class</parameter></term>
 900           <listitem>
 901             <para>
 902               specifies the root class to the search. By default,
 903               <parameter>standard-db-object</parameter> is used which
 904               is the root for all view classes.
 905             </para>
 906           </listitem>
 907         </varlistentry>
 908         <varlistentry>
 909           <term><parameter>database</parameter></term>
 910           <listitem>
 911             <para>
 912               The <glossterm
 913               linkend="gloss-database-object">database</glossterm> to
 914               search for view classes. This will default to the value
 915               of <symbol>*default-database*</symbol>.
 916             </para>
 917           </listitem>
 918         </varlistentry>
 919         <varlistentry>
 920           <term><parameter>classes</parameter></term>
 921           <listitem>
 922             <para>
 923               List of view classes.
 924             </para>
 925           </listitem>
 926         </varlistentry>
 927       </variablelist>
 928     </refsect1>
 929     <refsect1>
 930       <title>Description</title>
 931       <para>Returns a list of all the View Classes which have been
 932       defined in the Lisp session and are connected to
 933       <parameter>database</parameter> and which descended from the
 934       class <parameter>root-class</parameter> and which satisfy the
 935       function <parameter>test</parameter>.
 936       </para>
 937     </refsect1>
 938     <refsect1>
 939       <title>Examples</title>
 940       <screen>
 941 (list-classes)
 942 => (#&lt;clsql-sys::standard-db-class big> #&lt;clsql-sys::standard-db-class employee-address>
 943     #&lt;clsql-sys::standard-db-class address> #&lt;clsql-sys::standard-db-class company>
 944     #&lt;clsql-sys::standard-db-class employee>)
 945
 946 (list-classes :test #'(lambda (c) (> (length (symbol-name (class-name c))) 3)))
 947 => (#&lt;clsql-sys::standard-db-class employee-address> #&lt;clsql-sys::standard-db-class address>
 948     #&lt;clsql-sys::standard-db-class company> #&lt;clsql-sys::standard-db-class employee>)
 949       </screen>
 950     </refsect1>
 951     <refsect1>
 952       <title>Side Effects</title>
 953       <para>
 954         None.
 955       </para>
 956     </refsect1>
 957     <refsect1>
 958       <title>Affected by</title>
 959       <para>
 960         <simplelist>
 961           <member>Which view classes have been defined in the Lisp
 962           session.</member>
 963         </simplelist>
 964       </para>
 965     </refsect1>
 966     <refsect1>
 967       <title>Exceptional Situations</title>
 968       <para>
 969         None.
 970       </para>
 971     </refsect1>
 972     <refsect1>
 973       <title>See Also</title>
 974       <para>
 975         <simplelist>
 976           <member><link linkend="def-view-class"><function>def-view-class</function></link></member>
 977         </simplelist>
 978       </para>
 979     </refsect1>
 980     <refsect1>
 981       <title>Notes</title>
 982       <para>
 983         None.
 984       </para>
 985     </refsect1>
 986   </refentry>
 987
 988
 989 </reference>