File: classMaxPacketInsertPolicy.html

package info (click to toggle)
mysql%2B%2B 3.2.2%2Bpristine-2
  • links: PTS
  • area: main
  • in suites: stretch
  • size: 15,724 kB
  • ctags: 10,567
  • sloc: cpp: 35,668; sh: 3,683; makefile: 846; perl: 786
file content (217 lines) | stat: -rwxr-xr-x 10,916 bytes parent folder | download 
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
206
207
208
209
210
211
212
213
214
215
216
217
 
<!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&#160;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&#160;List</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-types">Public Types</a> &#124;
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="classMaxPacketInsertPolicy-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">MaxPacketInsertPolicy&lt; AccessController &gt; Class Template Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>An insert policy object that triggers a new INSERT statement if the object to be added would cause the statement to exceed a maximum size.  
 <a href="classMaxPacketInsertPolicy.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="insertpolicy_8h_source.html">insertpolicy.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
Public Types</h2></td></tr>
<tr class="memitem:a12b4378f273aa6c4a398ae3a254d2cfc"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a12b4378f273aa6c4a398ae3a254d2cfc"></a>
typedef AccessController&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#a12b4378f273aa6c4a398ae3a254d2cfc">access_controller</a></td></tr>
<tr class="memdesc:a12b4378f273aa6c4a398ae3a254d2cfc"><td class="mdescLeft">&#160;</td><td class="mdescRight">Alias for our access controller type. <br/></td></tr>
<tr class="separator:a12b4378f273aa6c4a398ae3a254d2cfc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><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:aa29c31d5052c44cbf6ee8aa112b1490d"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#aa29c31d5052c44cbf6ee8aa112b1490d">MaxPacketInsertPolicy</a> (Connection *con, int size)</td></tr>
<tr class="memdesc:aa29c31d5052c44cbf6ee8aa112b1490d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#aa29c31d5052c44cbf6ee8aa112b1490d">More...</a><br/></td></tr>
<tr class="separator:aa29c31d5052c44cbf6ee8aa112b1490d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9c313c2291382b11c12b5d5adb5c6b7b"><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#a9c313c2291382b11c12b5d5adb5c6b7b">MaxPacketInsertPolicy</a> (int size)</td></tr>
<tr class="memdesc:a9c313c2291382b11c12b5d5adb5c6b7b"><td class="mdescLeft">&#160;</td><td class="mdescRight">Constructor.  <a href="#a9c313c2291382b11c12b5d5adb5c6b7b">More...</a><br/></td></tr>
<tr class="separator:a9c313c2291382b11c12b5d5adb5c6b7b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4ec3c03e60ebfdb6d15b76b254826903"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a4ec3c03e60ebfdb6d15b76b254826903"></a>
&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#a4ec3c03e60ebfdb6d15b76b254826903">~MaxPacketInsertPolicy</a> ()</td></tr>
<tr class="memdesc:a4ec3c03e60ebfdb6d15b76b254826903"><td class="mdescLeft">&#160;</td><td class="mdescRight">Destructor. <br/></td></tr>
<tr class="separator:a4ec3c03e60ebfdb6d15b76b254826903"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9ed045222bd5374e15439d4e9f2cc2ad"><td class="memTemplParams" colspan="2">template&lt;class RowT &gt; </td></tr>
<tr class="memitem:a9ed045222bd5374e15439d4e9f2cc2ad"><td class="memTemplItemLeft" align="right" valign="top">bool&#160;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#a9ed045222bd5374e15439d4e9f2cc2ad">can_add</a> (int size, const RowT &amp;object) const </td></tr>
<tr class="memdesc:a9ed045222bd5374e15439d4e9f2cc2ad"><td class="mdescLeft">&#160;</td><td class="mdescRight">Can we add another object to the query?  <a href="#a9ed045222bd5374e15439d4e9f2cc2ad">More...</a><br/></td></tr>
<tr class="separator:a9ed045222bd5374e15439d4e9f2cc2ad"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template&lt;class AccessController = Transaction&gt;<br/>
class MaxPacketInsertPolicy&lt; AccessController &gt;</h3>

<p>An insert policy object that triggers a new INSERT statement if the object to be added would cause the statement to exceed a maximum size. </p>
<p>This differs from the <a class="el" href="classSizeThresholdInsertPolicy.html" title="An insert policy object that triggers a new INSERT statement after a size threshold for the length of...">SizeThresholdInsertPolicy</a> in that it builds the VALUES expression and checks whether it would cause the length of the INSERT statement to exceed the maximum size. </p>
</div><h2 class="groupheader">Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="aa29c31d5052c44cbf6ee8aa112b1490d"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class AccessController  = Transaction&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classMaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a>&lt; AccessController &gt;::<a class="el" href="classMaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a> </td>
          <td>(</td>
          <td class="paramtype">Connection *&#160;</td>
          <td class="paramname"><em>con</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em>&#160;</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>Constructor. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">con</td><td>connection object used for escaping text </td></tr>
    <tr><td class="paramname">size</td><td>the maximum allowed size for an INSERT statement </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a class="anchor" id="a9c313c2291382b11c12b5d5adb5c6b7b"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class AccessController  = Transaction&gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classMaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a>&lt; AccessController &gt;::<a class="el" href="classMaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a> </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em></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>Constructor. </p>
<p>This version does not use a Connection* so it will not be able to take the character set into account when escaping the text.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>the maximum allowed size for an INSERT statement </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a9ed045222bd5374e15439d4e9f2cc2ad"></a>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class AccessController  = Transaction&gt; </div>
<div class="memtemplate">
template&lt;class RowT &gt; </div>
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">bool <a class="el" href="classMaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a>&lt; AccessController &gt;::can_add </td>
          <td>(</td>
          <td class="paramtype">int&#160;</td>
          <td class="paramname"><em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const RowT &amp;&#160;</td>
          <td class="paramname"><em>object</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</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>Can we add another object to the query? </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">size</td><td>current length of the INSERT statement </td></tr>
    <tr><td class="paramname">object</td><td>the SSQLS object to be added</td></tr>
  </table>
  </dd>
</dl>
<dl class="retval"><dt>Return values</dt><dd>
  <table class="retval">
    <tr><td class="paramname">true</td><td>if the object is allowed to be added to the INSERT statement </td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li><a class="el" href="insertpolicy_8h_source.html">insertpolicy.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Mar 18 2015 18:19:52 for MySQL++ by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.5
</small></address>
</body>
</html>