summaryrefslogtreecommitdiff
path: root/htdocs/docs/man/FS/dbdef_column.html
blob: c753b52f7c4be8e6e065f5c8733694a46847ad0c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
<HTML>
<HEAD>
<TITLE>FS::dbdef_column - Column object</TITLE>
<LINK REV="made" HREF="mailto:ivan@rootwood.sisd.com">
</HEAD>

<BODY>

<!-- INDEX BEGIN -->

<UL>

	<LI><A HREF="#NAME">NAME</A>
	<LI><A HREF="#SYNOPSIS">SYNOPSIS</A>
	<LI><A HREF="#DESCRIPTION">DESCRIPTION</A>
	<LI><A HREF="#METHODS">METHODS</A>
	<LI><A HREF="#BUGS">BUGS</A>
	<LI><A HREF="#SEE_ALSO">SEE ALSO</A>
	<LI><A HREF="#VERSION">VERSION</A>
</UL>
<!-- INDEX END -->

<HR>
<P>
<H1><A NAME="NAME">NAME</A></H1>
<P>
FS::dbdef_column - Column object

<P>
<HR>
<H1><A NAME="SYNOPSIS">SYNOPSIS</A></H1>
<P>
<PRE>  use FS::dbdef_column;
</PRE>
<P>
<PRE>  $column_object = new FS::dbdef_column ( $name, $sql_type, '' );
  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL' );
  $column_object = new FS::dbdef_column ( $name, $sql_type, '', $length );
  $column_object = new FS::dbdef_column ( $name, $sql_type, 'NULL', $length );
</PRE>
<P>
<PRE>  $name = $column_object-&gt;name;
  $column_object-&gt;name ( 'name' );
</PRE>
<P>
<PRE>  $name = $column_object-&gt;type;
  $column_object-&gt;name ( 'sql_type' );
</PRE>
<P>
<PRE>  $name = $column_object-&gt;null;
  $column_object-&gt;name ( 'NOT NULL' );
</PRE>
<P>
<PRE>  $name = $column_object-&gt;length;
  $column_object-&gt;name ( $length );
</PRE>
<P>
<PRE>  $sql_line = $column-&gt;line;
  $sql_line = $column-&gt;line $datasrc;
</PRE>
<P>
<HR>
<H1><A NAME="DESCRIPTION">DESCRIPTION</A></H1>
<P>
FS::dbdef::column objects represend columns in tables (see <A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>).

<P>
<HR>
<H1><A NAME="METHODS">METHODS</A></H1>
<DL>
<DT><STRONG><A NAME="item_new">new</A></STRONG><DD>
<P>
Creates a new FS::dbdef_column object.

<DT><STRONG><A NAME="item_name">name</A></STRONG><DD>
<P>
Returns or sets the column name.

<DT><STRONG><A NAME="item_type">type</A></STRONG><DD>
<P>
Returns or sets the column type.

<DT><STRONG><A NAME="item_null">null</A></STRONG><DD>
<P>
Returns or sets the column null flag.

<DT><STRONG>type</STRONG><DD>
<P>
Returns or sets the column length.

<DT><STRONG><A NAME="item_line">line [ $datasrc ]</A></STRONG><DD>
<P>
Returns an SQL column definition.

<P>
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.

</DL>
<P>
<HR>
<H1><A NAME="BUGS">BUGS</A></H1>
<P>
<HR>
<H1><A NAME="SEE_ALSO">SEE ALSO</A></H1>
<P>
<A HREF="../FS/dbdef_table.html">FS::dbdef_table</A>, <A HREF="../FS/dbdef.html">FS::dbdef</A>, <EM>DBI</EM>



<P>
<HR>
<H1><A NAME="VERSION">VERSION</A></H1>
<P>
$Id: dbdef_column.html,v 1.1 1999-08-04 12:13:27 ivan Exp $

</BODY>

</HTML>