3 <TITLE>FS::dbdef_table - Table objects</TITLE>
4 <LINK REV="made" HREF="mailto:none">
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>
25 <H1><A NAME="NAME">NAME</A></H1>
27 FS::dbdef_table - Table objects
31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
33 <PRE> use FS::dbdef_table;
36 <PRE> $dbdef_table = new FS::dbdef_table (
37 "table_name",
38 "primary_key",
39 $FS_dbdef_unique_object,
40 $FS_dbdef_index_object,
41 @FS_dbdef_column_objects,
45 <PRE> $dbdef_table->addcolumn ( $FS_dbdef_column_object );
48 <PRE> $table_name = $dbdef_table->name;
49 $dbdef_table->name ("table_name");
52 <PRE> $table_name = $dbdef_table->primary_keye;
53 $dbdef_table->primary_key ("primary_key");
56 <PRE> $FS_dbdef_unique_object = $dbdef_table->unique;
57 $dbdef_table->unique ( $FS_dbdef_unique_object );
60 <PRE> $FS_dbdef_index_object = $dbdef_table->index;
61 $dbdef_table->index ( $FS_dbdef_index_object );
64 <PRE> @column_names = $dbdef->columns;
67 <PRE> $FS_dbdef_column_object = $dbdef->column;
70 <PRE> @sql_statements = $dbdef->sql_create_table;
71 @sql_statements = $dbdef->sql_create_table $datasrc;
75 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
77 FS::dbdef_table objects represent a single database table.
81 <H1><A NAME="METHODS">METHODS</A></H1>
83 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
85 Creates a new FS::dbdef_table object.
87 <DT><STRONG><A NAME="item_addcolumn">addcolumn</A></STRONG><DD>
89 Adds this FS::dbdef_column object.
91 <DT><STRONG><A NAME="item_name">name</A></STRONG><DD>
93 Returns or sets the table name.
95 <DT><STRONG><A NAME="item_primary_key">primary_key</A></STRONG><DD>
97 Returns or sets the primary key.
99 <DT><STRONG><A NAME="item_unique">unique</A></STRONG><DD>
101 Returns or sets the FS::dbdef_unique object.
103 <DT><STRONG><A NAME="item_index">index</A></STRONG><DD>
105 Returns or sets the FS::dbdef_index object.
107 <DT><STRONG><A NAME="item_columns">columns</A></STRONG><DD>
109 Returns a list consisting of the names of all columns.
111 <DT><STRONG><A NAME="item_column">column "column"</A></STRONG><DD>
113 Returns the column object (see <A HREF="../FS/dbdef_column.html">FS::dbdef_column</A>) for ``column''.
115 <DT><STRONG><A NAME="item_sql_create_table">sql_create_table [ $datasrc ]</A></STRONG><DD>
117 Returns an array of SQL statments to create this table.
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.
126 <H1><A NAME="BUGS">BUGS</A></H1>
129 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
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>,
138 <H1><A NAME="VERSION">VERSION</A></H1>
140 $Id: dbdef_table.html,v 1.2 2000-03-03 18:22:43 ivan Exp $