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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267
|
<!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::Query::MaxPacketInsertPolicy< AccessController > Class Template 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_1Query.html">Query</a></li><li class="navelem"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-types">Public Types</a> |
<a href="#pub-methods">Public Member Functions</a> |
<a href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">mysqlpp::Query::MaxPacketInsertPolicy< AccessController > 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="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#details">More...</a></p>
<p><code>#include <<a class="el" href="query_8h_source.html">query.h</a>></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:ae264bf470ed07397c59b1ded36a6b4e1"><td class="memItemLeft" align="right" valign="top"><a id="ae264bf470ed07397c59b1ded36a6b4e1"></a>
typedef AccessController </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#ae264bf470ed07397c59b1ded36a6b4e1">access_controller</a></td></tr>
<tr class="memdesc:ae264bf470ed07397c59b1ded36a6b4e1"><td class="mdescLeft"> </td><td class="mdescRight">Alias for our access controller type. <br /></td></tr>
<tr class="separator:ae264bf470ed07397c59b1ded36a6b4e1"><td class="memSeparator" colspan="2"> </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:a75865ae861d09225cbbd8cbc48f804ce"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#a75865ae861d09225cbbd8cbc48f804ce">MaxPacketInsertPolicy</a> (<a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> *con, int size)</td></tr>
<tr class="memdesc:a75865ae861d09225cbbd8cbc48f804ce"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a75865ae861d09225cbbd8cbc48f804ce">More...</a><br /></td></tr>
<tr class="separator:a75865ae861d09225cbbd8cbc48f804ce"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4e8a6a0f56f95041cb2eebfee9b6790b"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#a4e8a6a0f56f95041cb2eebfee9b6790b">MaxPacketInsertPolicy</a> (int size)</td></tr>
<tr class="memdesc:a4e8a6a0f56f95041cb2eebfee9b6790b"><td class="mdescLeft"> </td><td class="mdescRight">Constructor. <a href="#a4e8a6a0f56f95041cb2eebfee9b6790b">More...</a><br /></td></tr>
<tr class="separator:a4e8a6a0f56f95041cb2eebfee9b6790b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ab75fef1551b542e97f6f83efdf86da82"><td class="memItemLeft" align="right" valign="top"><a id="ab75fef1551b542e97f6f83efdf86da82"></a>
 </td><td class="memItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#ab75fef1551b542e97f6f83efdf86da82">~MaxPacketInsertPolicy</a> ()</td></tr>
<tr class="memdesc:ab75fef1551b542e97f6f83efdf86da82"><td class="mdescLeft"> </td><td class="mdescRight">Destructor. <br /></td></tr>
<tr class="separator:ab75fef1551b542e97f6f83efdf86da82"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4821d1dc8698e0177ed0d7ea6a30ecb4"><td class="memTemplParams" colspan="2">template<class RowT > </td></tr>
<tr class="memitem:a4821d1dc8698e0177ed0d7ea6a30ecb4"><td class="memTemplItemLeft" align="right" valign="top">bool </td><td class="memTemplItemRight" valign="bottom"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html#a4821d1dc8698e0177ed0d7ea6a30ecb4">can_add</a> (int size, const RowT &object) const</td></tr>
<tr class="memdesc:a4821d1dc8698e0177ed0d7ea6a30ecb4"><td class="mdescLeft"> </td><td class="mdescRight">Can we add another object to the query? <a href="#a4821d1dc8698e0177ed0d7ea6a30ecb4">More...</a><br /></td></tr>
<tr class="separator:a4821d1dc8698e0177ed0d7ea6a30ecb4"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><h3>template<class AccessController = Transaction><br />
class mysqlpp::Query::MaxPacketInsertPolicy< AccessController ></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="classmysqlpp_1_1Query_1_1SizeThresholdInsertPolicy.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 & Destructor Documentation</h2>
<a id="a75865ae861d09225cbbd8cbc48f804ce"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a75865ae861d09225cbbd8cbc48f804ce">◆ </a></span>MaxPacketInsertPolicy() <span class="overload">[1/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class AccessController = Transaction> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">mysqlpp::Query::MaxPacketInsertPolicy</a>< AccessController >::<a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a> </td>
<td>(</td>
<td class="paramtype"><a class="el" href="classmysqlpp_1_1Connection.html">Connection</a> * </td>
<td class="paramname"><em>con</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</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>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 id="a4e8a6a0f56f95041cb2eebfee9b6790b"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4e8a6a0f56f95041cb2eebfee9b6790b">◆ </a></span>MaxPacketInsertPolicy() <span class="overload">[2/2]</span></h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class AccessController = Transaction> </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">mysqlpp::Query::MaxPacketInsertPolicy</a>< AccessController >::<a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">MaxPacketInsertPolicy</a> </td>
<td>(</td>
<td class="paramtype">int </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 id="a4821d1dc8698e0177ed0d7ea6a30ecb4"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a4821d1dc8698e0177ed0d7ea6a30ecb4">◆ </a></span>can_add()</h2>
<div class="memitem">
<div class="memproto">
<div class="memtemplate">
template<class AccessController = Transaction> </div>
<div class="memtemplate">
template<class RowT > </div>
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">bool <a class="el" href="classmysqlpp_1_1Query_1_1MaxPacketInsertPolicy.html">mysqlpp::Query::MaxPacketInsertPolicy</a>< AccessController >::can_add </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"><em>size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const RowT & </td>
<td class="paramname"><em>object</em> </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="query_8h_source.html">query.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>
|