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
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-type" content="text/html;charset=iso-8859-1">
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="refman.css" rel="stylesheet" type="text/css">
</head>
<body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li id="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul></div>
<div class="nav">
<b>mysqlpp</b>::<a class="el" href="classmysqlpp_1_1Field.html">Field</a></div>
<h1>mysqlpp::Field Class Reference</h1><!-- doxytag: class="mysqlpp::Field" -->Class to hold information about a SQL field.
<a href="#_details">More...</a>
<p>
<code>#include <<a class="el" href="field_8h-source.html">field.h</a>></code>
<p>
Collaboration diagram for mysqlpp::Field:<p><center><img src="classmysqlpp_1_1Field__coll__graph.png" border="0" usemap="#mysqlpp_1_1Field__coll__map" alt="Collaboration graph"></center>
<map name="mysqlpp_1_1Field__coll__map">
<area href="classmysqlpp_1_1mysql__type__info.html" shape="rect" coords="5,7,197,31" alt="">
</map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center><a href="classmysqlpp_1_1Field-members.html">List of all members.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="f93a6fa53e488b3566bcb1ea4908e996"></a><!-- doxytag: member="mysqlpp::Field::Field" ref="f93a6fa53e488b3566bcb1ea4908e996" args="()" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#f93a6fa53e488b3566bcb1ea4908e996">Field</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create empty object. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="887e4566a1266e5c98be8d86eedbd548"></a><!-- doxytag: member="mysqlpp::Field::Field" ref="887e4566a1266e5c98be8d86eedbd548" args="(const MYSQL_FIELD *pf)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#887e4566a1266e5c98be8d86eedbd548">Field</a> (const MYSQL_FIELD *pf)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object from C API field structure. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6833175bda71e745b6b83df585030154"></a><!-- doxytag: member="mysqlpp::Field::Field" ref="6833175bda71e745b6b83df585030154" args="(const Field &other)" -->
</td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#6833175bda71e745b6b83df585030154">Field</a> (const <a class="el" href="classmysqlpp_1_1Field.html">Field</a> &other)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Create object as a copy of another <a class="el" href="classmysqlpp_1_1Field.html">Field</a>. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="bfae5bd1d80c8c2df3f3a198f586cb9a"></a><!-- doxytag: member="mysqlpp::Field::auto_increment" ref="bfae5bd1d80c8c2df3f3a198f586cb9a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#bfae5bd1d80c8c2df3f3a198f586cb9a">auto_increment</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field auto-increments. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="adcd521da1c6abf551297285d9066c59"></a><!-- doxytag: member="mysqlpp::Field::binary_type" ref="adcd521da1c6abf551297285d9066c59" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#adcd521da1c6abf551297285d9066c59">binary_type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some binary type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="42f2d14810c1c89ae6a0b9a4392641eb"></a><!-- doxytag: member="mysqlpp::Field::blob_type" ref="42f2d14810c1c89ae6a0b9a4392641eb" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#42f2d14810c1c89ae6a0b9a4392641eb">blob_type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some BLOB type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d8c7716647ec0ecc16c500696a3afb1f"></a><!-- doxytag: member="mysqlpp::Field::db" ref="d8c7716647ec0ecc16c500696a3afb1f" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#d8c7716647ec0ecc16c500696a3afb1f">db</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the database the field comes from. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="e5278a6cb1d754ec506c2ad2421451fd"></a><!-- doxytag: member="mysqlpp::Field::enumeration" ref="e5278a6cb1d754ec506c2ad2421451fd" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#e5278a6cb1d754ec506c2ad2421451fd">enumeration</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of an enumerated value type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#2b497665a0a1cc09855562ad9ef6871d">length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the creation size of the field. <a href="#2b497665a0a1cc09855562ad9ef6871d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b72f6da6cd4a512f1d6a35a435a63ed8"></a><!-- doxytag: member="mysqlpp::Field::max_length" ref="b72f6da6cd4a512f1d6a35a435a63ed8" args="() const " -->
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#b72f6da6cd4a512f1d6a35a435a63ed8">max_length</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the maximum number of bytes stored in this field in any of the rows in the result set we were created from. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="a1d17ae8726ddf34c1066437198f3fee"></a><!-- doxytag: member="mysqlpp::Field::multiple_key" ref="a1d17ae8726ddf34c1066437198f3fee" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a1d17ae8726ddf34c1066437198f3fee">multiple_key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="1ee7be4fb4104d669725f91c166bb50e"></a><!-- doxytag: member="mysqlpp::Field::name" ref="1ee7be4fb4104d669725f91c166bb50e" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#1ee7be4fb4104d669725f91c166bb50e">name</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the field's name. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d5ec7d6cb28141c547610100b8225327"></a><!-- doxytag: member="mysqlpp::Field::primary_key" ref="d5ec7d6cb28141c547610100b8225327" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#d5ec7d6cb28141c547610100b8225327">primary_key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a primary key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="d4417c65532ff5d2d8cb9ec4d2706fcc"></a><!-- doxytag: member="mysqlpp::Field::set_type" ref="d4417c65532ff5d2d8cb9ec4d2706fcc" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#d4417c65532ff5d2d8cb9ec4d2706fcc">set_type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some 'set' type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="aaa8afad2e6ac3703e639843d97722db"></a><!-- doxytag: member="mysqlpp::Field::table" ref="aaa8afad2e6ac3703e639843d97722db" args="() const " -->
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#aaa8afad2e6ac3703e639843d97722db">table</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the table the field comes from. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="b89c227addf1acb01040de46fc021c9a"></a><!-- doxytag: member="mysqlpp::Field::timestamp" ref="b89c227addf1acb01040de46fc021c9a" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#b89c227addf1acb01040de46fc021c9a">timestamp</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field's type is timestamp. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="3b8594efb4685be1b0ffa34418a04c2f"></a><!-- doxytag: member="mysqlpp::Field::type" ref="3b8594efb4685be1b0ffa34418a04c2f" args="() const " -->
const <a class="el" href="classmysqlpp_1_1mysql__type__info.html">mysql_type_info</a> & </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#3b8594efb4685be1b0ffa34418a04c2f">type</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Return information about the field's type. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="6ebf1823c21d3601b7674c865e27ad0d"></a><!-- doxytag: member="mysqlpp::Field::unique_key" ref="6ebf1823c21d3601b7674c865e27ad0d" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#6ebf1823c21d3601b7674c865e27ad0d">unique_key</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a unique key. <br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="31dee697f7bd816e17ea89ad34151fba"></a><!-- doxytag: member="mysqlpp::Field::zerofill" ref="31dee697f7bd816e17ea89ad34151fba" args="() const " -->
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#31dee697f7bd816e17ea89ad34151fba">zerofill</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field has the zerofill attribute. <br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
Class to hold information about a SQL field.
<p>
This is a cut-down version of MYSQL_FIELD, using MySQL++ and generic C++ types instead of the C types it uses, and hiding all fields behind accessors. It leaves out data members we have decided aren't very useful. Given a good argument, we're willing to mirror more of the fields; we just don't want to mirror the underlying structure slavishly for no benefit.
<p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="2b497665a0a1cc09855562ad9ef6871d"></a><!-- doxytag: member="mysqlpp::Field::length" ref="2b497665a0a1cc09855562ad9ef6871d" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">size_t mysqlpp::Field::length </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Return the creation size of the field.
<p>
This is the number of bytes the field can hold, not how much is actually stored in the field on any particular row.
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="field_8h-source.html">field.h</a></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 3 11:59:12 2010 for MySQL++ by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
|
