htdocs/docs/man/FS/dbdef_column.html

   1 <HTML>
   2 <HEAD>
   3 <TITLE>FS::dbdef_column - Column object</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_column - Column object
  28
  29 <P>
  30 <HR>
  31 <H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
  32 <P>
  33 <PRE>  use FS::dbdef_column;
  34 </PRE>
  35 <P>
  36 <PRE>  $column_object = new FS::dbdef_column ( $name, $sql_type, '' );
  37   $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL' );
  38   $column_object = new FS::dbdef_column ( $name, $sql_type, '', $length );
  39   $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL', $length );
  40 </PRE>
  41 <P>
  42 <PRE>  $name = $column_object-&gt;name;
  43   $column_object-&gt;name ( 'name' );
  44 </PRE>
  45 <P>
  46 <PRE>  $name = $column_object-&gt;type;
  47   $column_object-&gt;name ( 'sql_type' );
  48 </PRE>
  49 <P>
  50 <PRE>  $name = $column_object-&gt;null;
  51   $column_object-&gt;name ( 'NOT NULL' );
  52 </PRE>
  53 <P>
  54 <PRE>  $name = $column_object-&gt;length;
  55   $column_object-&gt;name ( $length );
  56 </PRE>
  57 <P>
  58 <PRE>  $sql_line = $column-&gt;line;
  59   $sql_line = $column-&gt;line $datasrc;
  60 </PRE>
  61 <P>
  62 <HR>
  63 <H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
  64 <P>
  65 FS::dbdef::column objects represend columns in tables (see <A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>).
  66
  67 <P>
  68 <HR>
  69 <H1><A NAME="METHODS">METHODS</A></H1>
  70 <DL>
  71 <DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
  72 <P>
  73 Creates a new FS::dbdef_column object.
  74
  75 <DT><STRONG><A NAME="item_name">name</A></STRONG><DD>
  76 <P>
  77 Returns or sets the column name.
  78
  79 <DT><STRONG><A NAME="item_type">type</A></STRONG><DD>
  80 <P>
  81 Returns or sets the column type.
  82
  83 <DT><STRONG><A NAME="item_null">null</A></STRONG><DD>
  84 <P>
  85 Returns or sets the column null flag.
  86
  87 <DT><STRONG>type</STRONG><DD>
  88 <P>
  89 Returns or sets the column length.
  90
  91 <DT><STRONG><A NAME="item_line">line [ $datasrc ]</A></STRONG><DD>
  92 <P>
  93 Returns an SQL column definition.
  94
  95 <P>
  96 If passed a DBI <CODE>$datasrc</CODE> specifying <A HREF="../DBD/mysql.html">DBD::mysql</A> or <A HREF="../DBD/Pg.html">DBD::Pg</A>, will use engine-specific syntax.
  97
  98 </DL>
  99 <P>
 100 <HR>
 101 <H1><A NAME="BUGS">BUGS</A></H1>
 102 <P>
 103 <HR>
 104 <H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
 105 <P>
 106 <A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>, <A HREF="../FS/dbdef.html">FS::dbdef</A>, <EM>DBI</EM>
 107
 108
 109
 110 <P>
 111 <HR>
 112 <H1><A NAME="VERSION">VERSION</A></H1>
 113 <P>
 114 $Id: dbdef_column.html,v 1.2 2000-03-03 18:22:43 ivan Exp $
 115
 116 </BODY>
 117
 118 </HTML>