File: classMaxPacketInsertPolicy.html

package info (click to toggle)
mysql%2B%2B 3.1.0-2
  • links: PTS
  • area: main
  • in suites: wheezy
  • size: 11,640 kB
  • sloc: cpp: 35,569; sh: 3,113; makefile: 946; perl: 786
file content (183 lines) | stat: -rw-r--r-- 9,760 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
<!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&nbsp;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&nbsp;List</span></a></li>
    <li><a href="hierarchy.html"><span>Class&nbsp;Hierarchy</span></a></li>
    <li><a href="functions.html"><span>Class&nbsp;Members</span></a></li>
  </ul></div>
<h1>MaxPacketInsertPolicy&lt; AccessController &gt; Class Template Reference</h1><!-- doxytag: class="MaxPacketInsertPolicy" -->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="#_details">More...</a>
<p>
<code>#include &lt;<a class="el" href="insertpolicy_8h-source.html">insertpolicy.h</a>&gt;</code>
<p>
<a href="classMaxPacketInsertPolicy-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 Types</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="12b4378f273aa6c4a398ae3a254d2cfc"></a><!-- doxytag: member="MaxPacketInsertPolicy::access_controller" ref="12b4378f273aa6c4a398ae3a254d2cfc" args="" -->
typedef AccessController&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#12b4378f273aa6c4a398ae3a254d2cfc">access_controller</a></td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Alias for our access controller type. <br></td></tr>
<tr><td colspan="2"><br><h2>Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#a29c31d5052c44cbf6ee8aa112b1490d">MaxPacketInsertPolicy</a> (Connection *con, int size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#a29c31d5052c44cbf6ee8aa112b1490d"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#9c313c2291382b11c12b5d5adb5c6b7b">MaxPacketInsertPolicy</a> (int size)</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Constructor.  <a href="#9c313c2291382b11c12b5d5adb5c6b7b"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="anchor" name="4ec3c03e60ebfdb6d15b76b254826903"></a><!-- doxytag: member="MaxPacketInsertPolicy::~MaxPacketInsertPolicy" ref="4ec3c03e60ebfdb6d15b76b254826903" args="()" -->
&nbsp;</td><td class="memItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#4ec3c03e60ebfdb6d15b76b254826903">~MaxPacketInsertPolicy</a> ()</td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Destructor. <br></td></tr>
<tr><td class="memTemplParams" nowrap colspan="2">template&lt;class RowT&gt; </td></tr>
<tr><td class="memTemplItemLeft" nowrap align="right" valign="top">bool&nbsp;</td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classMaxPacketInsertPolicy.html#519cee157016f1204c3a7115d43c1f4e">can_add</a> (int size, const RowT &amp;object) const </td></tr>

<tr><td class="mdescLeft">&nbsp;</td><td class="mdescRight">Can we add another object to the query?  <a href="#519cee157016f1204c3a7115d43c1f4e"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
<h3>template&lt;class AccessController = Transaction&gt;<br>
 class MaxPacketInsertPolicy&lt; AccessController &gt;</h3>

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>
This differs from the <a class="el" href="classSizeThresholdInsertPolicy.html">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>
<hr><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" name="a29c31d5052c44cbf6ee8aa112b1490d"></a><!-- doxytag: member="MaxPacketInsertPolicy::MaxPacketInsertPolicy" ref="a29c31d5052c44cbf6ee8aa112b1490d" args="(Connection *con, int size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class AccessController = Transaction&gt; </div>
      <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 *&nbsp;</td>
          <td class="paramname"> <em>con</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">int&nbsp;</td>
          <td class="paramname"> <em>size</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>con</em>&nbsp;</td><td>connection object used for escaping text </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>the maximum allowed size for an INSERT statement </td></tr>
  </table>
</dl>

</div>
</div><p>
<a class="anchor" name="9c313c2291382b11c12b5d5adb5c6b7b"></a><!-- doxytag: member="MaxPacketInsertPolicy::MaxPacketInsertPolicy" ref="9c313c2291382b11c12b5d5adb5c6b7b" args="(int size)" -->
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template&lt;class AccessController = Transaction&gt; </div>
      <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&nbsp;</td>
          <td class="paramname"> <em>size</em>          </td>
          <td>&nbsp;)&nbsp;</td>
          <td width="100%"><code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Constructor. 
<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 compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>the maximum allowed size for an INSERT statement </td></tr>
  </table>
</dl>

</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="519cee157016f1204c3a7115d43c1f4e"></a><!-- doxytag: member="MaxPacketInsertPolicy::can_add" ref="519cee157016f1204c3a7115d43c1f4e" args="(int size, const RowT &amp;object) const " -->
<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="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&nbsp;</td>
          <td class="paramname"> <em>size</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">const RowT &amp;&nbsp;</td>
          <td class="paramname"> <em>object</em></td><td>&nbsp;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td><td width="100%"> const<code> [inline]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>
Can we add another object to the query? 
<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>size</em>&nbsp;</td><td>current length of the INSERT statement </td></tr>
    <tr><td valign="top"></td><td valign="top"><em>object</em>&nbsp;</td><td>the SSQLS object to be added</td></tr>
  </table>
</dl>
<dl compact><dt><b>Return values:</b></dt><dd>
  <table border="0" cellspacing="2" cellpadding="0">
    <tr><td valign="top"></td><td valign="top"><em>true</em>&nbsp;</td><td>if the object is allowed to be added to the INSERT statement </td></tr>
  </table>
</dl>

</div>
</div><p>
<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></ul>
<hr size="1"><address style="align: right;"><small>Generated on Thu Jun 3 11:59:12 2010 for MySQL++ by&nbsp;
<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>