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
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<title>MySQL++ Reference Manual</title>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.15"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>MySQL++: mysqlpp::Field Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">MySQL++
 <span id="projectnumber">3.2.5</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.15 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
var searchBox = new SearchBox("searchBox", "search",false,'Search');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
$(function() {
initMenu('',true,false,'search.php','Search');
$(document).ready(function() { init_search(); });
});
/* @license-end */</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="classmysqlpp_1_1Field.html">Field</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1Field-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::Field Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Class to hold information about a SQL field.
<a href="classmysqlpp_1_1Field.html#details">More...</a></p>
<p><code>#include <<a class="el" href="field_8h_source.html">field.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:af93a6fa53e488b3566bcb1ea4908e996"><td class="memItemLeft" align="right" valign="top"><a id="af93a6fa53e488b3566bcb1ea4908e996"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#af93a6fa53e488b3566bcb1ea4908e996">Field</a> ()</td></tr>
<tr class="memdesc:af93a6fa53e488b3566bcb1ea4908e996"><td class="mdescLeft"> </td><td class="mdescRight">Create empty object. <br /></td></tr>
<tr class="separator:af93a6fa53e488b3566bcb1ea4908e996"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a887e4566a1266e5c98be8d86eedbd548"><td class="memItemLeft" align="right" valign="top"><a id="a887e4566a1266e5c98be8d86eedbd548"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a887e4566a1266e5c98be8d86eedbd548">Field</a> (const MYSQL_FIELD *pf)</td></tr>
<tr class="memdesc:a887e4566a1266e5c98be8d86eedbd548"><td class="mdescLeft"> </td><td class="mdescRight">Create object from C API field structure. <br /></td></tr>
<tr class="separator:a887e4566a1266e5c98be8d86eedbd548"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a6833175bda71e745b6b83df585030154"><td class="memItemLeft" align="right" valign="top"><a id="a6833175bda71e745b6b83df585030154"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a6833175bda71e745b6b83df585030154">Field</a> (const <a class="el" href="classmysqlpp_1_1Field.html">Field</a> &other)</td></tr>
<tr class="memdesc:a6833175bda71e745b6b83df585030154"><td class="mdescLeft"> </td><td class="mdescRight">Create object as a copy of another <a class="el" href="classmysqlpp_1_1Field.html" title="Class to hold information about a SQL field.">Field</a>. <br /></td></tr>
<tr class="separator:a6833175bda71e745b6b83df585030154"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a777755e6c546e98ea2d227368a0bebe9"><td class="memItemLeft" align="right" valign="top"><a id="a777755e6c546e98ea2d227368a0bebe9"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a777755e6c546e98ea2d227368a0bebe9">auto_increment</a> () const</td></tr>
<tr class="memdesc:a777755e6c546e98ea2d227368a0bebe9"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field auto-increments. <br /></td></tr>
<tr class="separator:a777755e6c546e98ea2d227368a0bebe9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3294a6683f0fdce76a51a4d08e2ed964"><td class="memItemLeft" align="right" valign="top"><a id="a3294a6683f0fdce76a51a4d08e2ed964"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a3294a6683f0fdce76a51a4d08e2ed964">binary_type</a> () const</td></tr>
<tr class="memdesc:a3294a6683f0fdce76a51a4d08e2ed964"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some binary type. <br /></td></tr>
<tr class="separator:a3294a6683f0fdce76a51a4d08e2ed964"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abfd56de16f7a880bfdb5a124643f2cfa"><td class="memItemLeft" align="right" valign="top"><a id="abfd56de16f7a880bfdb5a124643f2cfa"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#abfd56de16f7a880bfdb5a124643f2cfa">blob_type</a> () const</td></tr>
<tr class="memdesc:abfd56de16f7a880bfdb5a124643f2cfa"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some BLOB type. <br /></td></tr>
<tr class="separator:abfd56de16f7a880bfdb5a124643f2cfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acb15b398d46119b6f0b4418daa9177eb"><td class="memItemLeft" align="right" valign="top"><a id="acb15b398d46119b6f0b4418daa9177eb"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#acb15b398d46119b6f0b4418daa9177eb">db</a> () const</td></tr>
<tr class="memdesc:acb15b398d46119b6f0b4418daa9177eb"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the database the field comes from. <br /></td></tr>
<tr class="separator:acb15b398d46119b6f0b4418daa9177eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a864c0336cf9cb67231d8210045ae9478"><td class="memItemLeft" align="right" valign="top"><a id="a864c0336cf9cb67231d8210045ae9478"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a864c0336cf9cb67231d8210045ae9478">enumeration</a> () const</td></tr>
<tr class="memdesc:a864c0336cf9cb67231d8210045ae9478"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of an enumerated value type. <br /></td></tr>
<tr class="separator:a864c0336cf9cb67231d8210045ae9478"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a307ff524ddb269d093f1d1072432e5cd"><td class="memItemLeft" align="right" valign="top">size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a307ff524ddb269d093f1d1072432e5cd">length</a> () const</td></tr>
<tr class="memdesc:a307ff524ddb269d093f1d1072432e5cd"><td class="mdescLeft"> </td><td class="mdescRight">Return the creation size of the field. <a href="#a307ff524ddb269d093f1d1072432e5cd">More...</a><br /></td></tr>
<tr class="separator:a307ff524ddb269d093f1d1072432e5cd"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:afa185acf090746d01d9b84c40c5e9d13"><td class="memItemLeft" align="right" valign="top"><a id="afa185acf090746d01d9b84c40c5e9d13"></a>
size_t </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#afa185acf090746d01d9b84c40c5e9d13">max_length</a> () const</td></tr>
<tr class="memdesc:afa185acf090746d01d9b84c40c5e9d13"><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 class="separator:afa185acf090746d01d9b84c40c5e9d13"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab4e3e8f448ec16e47be2f45e4c11cc96"><td class="memItemLeft" align="right" valign="top"><a id="ab4e3e8f448ec16e47be2f45e4c11cc96"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#ab4e3e8f448ec16e47be2f45e4c11cc96">multiple_key</a> () const</td></tr>
<tr class="memdesc:ab4e3e8f448ec16e47be2f45e4c11cc96"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a key. <br /></td></tr>
<tr class="separator:ab4e3e8f448ec16e47be2f45e4c11cc96"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac44d0e13e19e14995a6e845f0f4c5875"><td class="memItemLeft" align="right" valign="top"><a id="ac44d0e13e19e14995a6e845f0f4c5875"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#ac44d0e13e19e14995a6e845f0f4c5875">name</a> () const</td></tr>
<tr class="memdesc:ac44d0e13e19e14995a6e845f0f4c5875"><td class="mdescLeft"> </td><td class="mdescRight">Return the field's name. <br /></td></tr>
<tr class="separator:ac44d0e13e19e14995a6e845f0f4c5875"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a27be919503aa4110a03e5dade6f574dc"><td class="memItemLeft" align="right" valign="top"><a id="a27be919503aa4110a03e5dade6f574dc"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a27be919503aa4110a03e5dade6f574dc">primary_key</a> () const</td></tr>
<tr class="memdesc:a27be919503aa4110a03e5dade6f574dc"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a primary key. <br /></td></tr>
<tr class="separator:a27be919503aa4110a03e5dade6f574dc"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a78ce1b25eb3c7d32711fb6de22c037c3"><td class="memItemLeft" align="right" valign="top"><a id="a78ce1b25eb3c7d32711fb6de22c037c3"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a78ce1b25eb3c7d32711fb6de22c037c3">set_type</a> () const</td></tr>
<tr class="memdesc:a78ce1b25eb3c7d32711fb6de22c037c3"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is of some 'set' type. <br /></td></tr>
<tr class="separator:a78ce1b25eb3c7d32711fb6de22c037c3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8a3fdaf1db0c6c7a6f28298eb6badf05"><td class="memItemLeft" align="right" valign="top"><a id="a8a3fdaf1db0c6c7a6f28298eb6badf05"></a>
const char * </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a8a3fdaf1db0c6c7a6f28298eb6badf05">table</a> () const</td></tr>
<tr class="memdesc:a8a3fdaf1db0c6c7a6f28298eb6badf05"><td class="mdescLeft"> </td><td class="mdescRight">Return the name of the table the field comes from. <br /></td></tr>
<tr class="separator:a8a3fdaf1db0c6c7a6f28298eb6badf05"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4508b043ec630a28868f75dba2dcefd5"><td class="memItemLeft" align="right" valign="top"><a id="a4508b043ec630a28868f75dba2dcefd5"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#a4508b043ec630a28868f75dba2dcefd5">timestamp</a> () const</td></tr>
<tr class="memdesc:a4508b043ec630a28868f75dba2dcefd5"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field's type is timestamp. <br /></td></tr>
<tr class="separator:a4508b043ec630a28868f75dba2dcefd5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad3c602a453c813c9442af389d1826058"><td class="memItemLeft" align="right" valign="top"><a id="ad3c602a453c813c9442af389d1826058"></a>
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#ad3c602a453c813c9442af389d1826058">type</a> () const</td></tr>
<tr class="memdesc:ad3c602a453c813c9442af389d1826058"><td class="mdescLeft"> </td><td class="mdescRight">Return information about the field's type. <br /></td></tr>
<tr class="separator:ad3c602a453c813c9442af389d1826058"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:acac67cc1a4d189e1b6a1db016bf5c586"><td class="memItemLeft" align="right" valign="top"><a id="acac67cc1a4d189e1b6a1db016bf5c586"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#acac67cc1a4d189e1b6a1db016bf5c586">unique_key</a> () const</td></tr>
<tr class="memdesc:acac67cc1a4d189e1b6a1db016bf5c586"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field is part of a unique key. <br /></td></tr>
<tr class="separator:acac67cc1a4d189e1b6a1db016bf5c586"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ad68319625f0c81b2b246bb5cc6c09064"><td class="memItemLeft" align="right" valign="top"><a id="ad68319625f0c81b2b246bb5cc6c09064"></a>
bool </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Field.html#ad68319625f0c81b2b246bb5cc6c09064">zerofill</a> () const</td></tr>
<tr class="memdesc:ad68319625f0c81b2b246bb5cc6c09064"><td class="mdescLeft"> </td><td class="mdescRight">Returns true if field has the zerofill attribute. <br /></td></tr>
<tr class="separator:ad68319625f0c81b2b246bb5cc6c09064"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Class to hold information about a SQL field. </p>
<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>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a307ff524ddb269d093f1d1072432e5cd"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a307ff524ddb269d093f1d1072432e5cd">◆ </a></span>length()</h2>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">size_t mysqlpp::Field::length </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td> const</td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Return the creation size of the field. </p>
<p>This is the number of bytes the field can hold, not how much is actually stored in the field on any particular row. </p>
</div>
</div>
<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></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Sun Jul 21 2019 05:32:21 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.15
</small></address>
</body>
</html>
|
