htdocs/docs/man/FS/dbdef_table.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::dbdef_table - Table objects</TITLE>
   4 <LINK REV="made" HREF="mailto:none">
   5 </HEAD>
   6
   7 <BODY>
   8
   9 <!-- INDEX BEGIN -->
  10
  11 <UL>
  12
  13         <LI><A HREF="#NAME">NAME</A>
  14         <LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
  15         <LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
  16         <LI><A HREF="#METHODS">METHODS</A>
  17         <LI><A HREF="#BUGS">BUGS</A>
  18         <LI><A HREF="#SEE_ALSO">SEE ALSO</A>
  19         <LI><A HREF="#VERSION">VERSION</A>
  20 </UL>
  21 <!-- INDEX END -->
  22
  23 <HR>
  24 <P>
  25 <H1><A NAME="NAME">NAME</A></H1>
  26 <P>
  27 FS::dbdef_table - Table objects
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::dbdef_table;
  34 </PRE>
  35 <P>
  36 <PRE>  $dbdef_table = new FS::dbdef_table (
  37     &quot;table_name&quot;,
  38     &quot;primary_key&quot;,
  39     $FS_dbdef_unique_object,
  40     $FS_dbdef_index_object,
  41     @FS_dbdef_column_objects,
  42   );
  43 </PRE>
  44 <P>
  45 <PRE>  $dbdef_table-&gt;addcolumn ( $FS_dbdef_column_object );
  46 </PRE>
  47 <P>
  48 <PRE>  $table_name = $dbdef_table-&gt;name;
  49   $dbdef_table-&gt;name (&quot;table_name&quot;);
  50 </PRE>
  51 <P>
  52 <PRE>  $table_name = $dbdef_table-&gt;primary_keye;
  53   $dbdef_table-&gt;primary_key (&quot;primary_key&quot;);
  54 </PRE>
  55 <P>
  56 <PRE>  $FS_dbdef_unique_object = $dbdef_table-&gt;unique;
  57   $dbdef_table-&gt;unique ( $FS_dbdef_unique_object );
  58 </PRE>
  59 <P>
  60 <PRE>  $FS_dbdef_index_object = $dbdef_table-&gt;index;
  61   $dbdef_table-&gt;index ( $FS_dbdef_index_object );
  62 </PRE>
  63 <P>
  64 <PRE>  @column_names = $dbdef-&gt;columns;
  65 </PRE>
  66 <P>
  67 <PRE>  $FS_dbdef_column_object = $dbdef-&gt;column;
  68 </PRE>
  69 <P>
  70 <PRE>  @sql_statements = $dbdef-&gt;sql_create_table;
  71   @sql_statements = $dbdef-&gt;sql_create_table $datasrc;
  72 </PRE>
  73 <P>
  74 <HR>
  75 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  76 <P>
  77 FS::dbdef_table objects represent a single database table.
  78
  79 <P>
  80 <HR>
  81 <H1><A NAME="METHODS">METHODS</A></H1>
  82 <DL>
  83 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
  84 <P>
  85 Creates a new FS::dbdef_table object.
  86
  87 <DT><STRONG><A NAME="item_addcolumn">addcolumn</A></STRONG><DD>
  88 <P>
  89 Adds this FS::dbdef_column object.
  90
  91 <DT><STRONG><A NAME="item_name">name</A></STRONG><DD>
  92 <P>
  93 Returns or sets the table name.
  94
  95 <DT><STRONG><A NAME="item_primary_key">primary_key</A></STRONG><DD>
  96 <P>
  97 Returns or sets the primary key.
  98
  99 <DT><STRONG><A NAME="item_unique">unique</A></STRONG><DD>
 100 <P>
 101 Returns or sets the FS::dbdef_unique object.
 102
 103 <DT><STRONG><A NAME="item_index">index</A></STRONG><DD>
 104 <P>
 105 Returns or sets the FS::dbdef_index object.
 106
 107 <DT><STRONG><A NAME="item_columns">columns</A></STRONG><DD>
 108 <P>
 109 Returns a list consisting of the names of all columns.
 110
 111 <DT><STRONG><A NAME="item_column">column &quot;column&quot;</A></STRONG><DD>
 112 <P>
 113 Returns the column object (see <A HREF="../FS/dbdef_column.html">FS::dbdef_column</A>) for ``column''.
 114
 115 <DT><STRONG><A NAME="item_sql_create_table">sql_create_table [ $datasrc ]</A></STRONG><DD>
 116 <P>
 117 Returns an array of SQL statments to create this table.
 118
 119 <P>
 120 If passed a DBI <CODE>$datasrc</CODE> specifying <A HREF="../DBD/mysql.html">DBD::mysql</A>, will use MySQL-specific syntax. Non-standard syntax for other engines (if
 121 applicable) may also be supported in the future.
 122
 123 </DL>
 124 <P>
 125 <HR>
 126 <H1><A NAME="BUGS">BUGS</A></H1>
 127 <P>
 128 <HR>
 129 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 130 <P>
 131 <A HREF="../FS/dbdef.html">FS::dbdef</A>, <A HREF="../FS/dbdef_unique.html">FS::dbdef_unique</A>, <A HREF="../FS/dbdef_index.html">FS::dbdef_index</A>, <A HREF="../FS/dbdef_unique.html">FS::dbdef_unique</A>,
 132 <EM>DBI</EM>
 133
 134
 135
 136 <P>
 137 <HR>
 138 <H1><A NAME="VERSION">VERSION</A></H1>
 139 <P>
 140 $Id: dbdef_table.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
 141
 142 </BODY>
 143
 144 </HTML>