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
|
<!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">
</head>
<body>
<!-- Generated by Doxygen 1.8.5 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><b>mysqlpp</b></li><li class="navelem"><a class="el" href="structmysqlpp_1_1SQLParseElement.html">SQLParseElement</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-attribs">Public Attributes</a> |
<a href="structmysqlpp_1_1SQLParseElement-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::SQLParseElement Struct Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>Used within <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries. ">Query</a> to hold elements for parameterized queries.
<a href="structmysqlpp_1_1SQLParseElement.html#details">More...</a></p>
<p><code>#include <<a class="el" href="qparms_8h_source.html">qparms.h</a>></code></p>
<div class="dynheader">
Collaboration diagram for mysqlpp::SQLParseElement:</div>
<div class="dyncontent">
<div class="center"><img src="structmysqlpp_1_1SQLParseElement__coll__graph.png" border="0" usemap="#mysqlpp_1_1SQLParseElement_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a5095f861effa2f1695c3cc29f79f825e"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a5095f861effa2f1695c3cc29f79f825e">SQLParseElement</a> (std::string b, char o, signed char n)</td></tr>
<tr class="memdesc:a5095f861effa2f1695c3cc29f79f825e"><td class="mdescLeft"> </td><td class="mdescRight">Create object. <a href="#a5095f861effa2f1695c3cc29f79f825e">More...</a><br/></td></tr>
<tr class="separator:a5095f861effa2f1695c3cc29f79f825e"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:a8b0a5afd4a8b825d13579b1427e94331"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a8b0a5afd4a8b825d13579b1427e94331"></a>
std::string </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a8b0a5afd4a8b825d13579b1427e94331">before</a></td></tr>
<tr class="memdesc:a8b0a5afd4a8b825d13579b1427e94331"><td class="mdescLeft"> </td><td class="mdescRight">string inserted before the parameter <br/></td></tr>
<tr class="separator:a8b0a5afd4a8b825d13579b1427e94331"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a99ca4660111774c7bdfc5d0a142d9f00"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a99ca4660111774c7bdfc5d0a142d9f00"></a>
char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#a99ca4660111774c7bdfc5d0a142d9f00">option</a></td></tr>
<tr class="memdesc:a99ca4660111774c7bdfc5d0a142d9f00"><td class="mdescLeft"> </td><td class="mdescRight">the parameter option, or blank if none <br/></td></tr>
<tr class="separator:a99ca4660111774c7bdfc5d0a142d9f00"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:adad4d34b5d3435cf327382a0cc343323"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="adad4d34b5d3435cf327382a0cc343323"></a>
signed char </td><td class="memItemRight" valign="bottom"><a class="el" href="structmysqlpp_1_1SQLParseElement.html#adad4d34b5d3435cf327382a0cc343323">num</a></td></tr>
<tr class="memdesc:adad4d34b5d3435cf327382a0cc343323"><td class="mdescLeft"> </td><td class="mdescRight">the parameter position to use <br/></td></tr>
<tr class="separator:adad4d34b5d3435cf327382a0cc343323"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Used within <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries. ">Query</a> to hold elements for parameterized queries. </p>
<p>Each element has three parts:</p>
<p>The concept behind the <code>before</code> variable needs a little explaining. When a template query is parsed, each parameter is parsed into one of these <a class="el" href="structmysqlpp_1_1SQLParseElement.html" title="Used within Query to hold elements for parameterized queries. ">SQLParseElement</a> objects, but the non-parameter parts of the template also have to be stored somewhere. MySQL++ chooses to attach the text leading up to a parameter to that parameter. So, the <code>before</code> string is simply the text copied literally into the finished query before we insert a value for the parameter.</p>
<p>The <code>option</code> character is currently one of 'q', 'Q', 'r', 'R' or ' '. See the "Template Queries" chapter in the user manual for details.</p>
<p>The position value (<code>num</code>) allows a template query to have its parameters in a different order than in the <a class="el" href="classmysqlpp_1_1Query.html" title="A class for building and executing SQL queries. ">Query</a> method call. An example of how this can be helpful is in the "Template Queries" chapter of the user manual. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a5095f861effa2f1695c3cc29f79f825e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">mysqlpp::SQLParseElement::SQLParseElement </td>
<td>(</td>
<td class="paramtype">std::string </td>
<td class="paramname"><em>b</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">char </td>
<td class="paramname"><em>o</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">signed char </td>
<td class="paramname"><em>n</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></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>Create object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">b</td><td>the 'before' value </td></tr>
<tr><td class="paramname">o</td><td>the 'option' value </td></tr>
<tr><td class="paramname">n</td><td>the 'num' value </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qparms_8h_source.html">qparms.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:55:03 for MySQL++ by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>
|
