<!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>Class Poco::Data::ODBC::Preparation</title> <meta http-equiv="content-type" content="text/html; charset=utf-8"/> <meta name="author" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="publisher" content="Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="copyright" content="Copyright (c) 2009, Applied Informatics Software Engineering GmbH and Contributors"/> <meta name="language" content="en"/> <meta name="date" content="2009-11-24"/> <meta name="generator" content="PocoDoc"/> <link rel="stylesheet" href="css/styles.css" type="text/css"/> </head> <body bgcolor="#ffffff" leftmargin="0" topmargin="0"> <div class="header"> <h1 class="namespace"><a href="Poco.Data.ODBC.html" class="namespace">Poco::Data::ODBC</a></h1> <h1 class="symbol">class Preparation</h1> </div> <div class="body"> <p> <b>Library:</b> Data/ODBC<br /> <b>Package:</b> ODBC<br /> <b>Header:</b> Poco/Data/ODBC/Preparation.h</p> <h2>Description</h2> <div class="description"> <p>Class used for database preparation where we first have to register all data types with respective memory output locations before extracting data. <a href="Poco.Data.Extraction.html" title="class Poco::Data::Extraction">Extraction</a> works in two-phases: first prepare is called once, then extract n-times. In <a href="Poco.Data.ODBC.html" title="namespace Poco::Data::ODBC">ODBC</a>, SQLBindCol/SQLFetch is the preferred method of data retrieval (SQLGetData is available, however with numerous driver implementation dependent limitations). In order to fit this functionality into <a href="Poco.html" title="namespace Poco">Poco</a> DataConnectors framework, every <a href="Poco.Data.ODBC.html" title="namespace Poco::Data::ODBC">ODBC</a> SQL statement instantiates its own <a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a> object. This is done once per statement execution (from <a href="Poco.Data.StatementImpl.html#3103" title="Poco::Data::StatementImpl::bindImpl()">StatementImpl::bindImpl</a>()). </p> <p><a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a> object is used to : </p> <p>1) <a href="Poco.Data.Prepare.html" title="class Poco::Data::Prepare">Prepare</a> SQL statement. 2) Provide and contain the memory locations where retrieved values are placed during recordset iteration. 3) Keep count of returned number of columns with their respective datatypes and sizes. </p> <p>Notes: </p> <p>- Value datatypes in this interface <a href="Poco.Data.ODBC.Preparation.html#1118" title="Poco::Data::ODBC::Preparation::prepare()">prepare</a>() calls serve only for the purpose of type distinction. - <a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a> keeps its own std::vector<<a href="Poco.Any.html" title="class Poco::Any">Any</a>> buffer for fetched data to be later retrieved by <a href="Poco.Data.ODBC.Extractor.html" title="class Poco::Data::ODBC::Extractor">Extractor</a>. - <a href="Poco.Data.ODBC.Preparation.html#1118" title="Poco::Data::ODBC::Preparation::prepare()">prepare</a>() methods should not be called when extraction mode is <a href="Poco.Data.ODBC.Preparation.html#1110" title="Poco::Data::ODBC::Preparation::DE_MANUAL">DE_MANUAL</a> </p> <p></p> </div> <h2>Inheritance</h2> <p><b>Direct Base Classes: </b><a href="Poco.Data.AbstractPreparation.html" title="class Poco::Data::AbstractPreparation">Poco::Data::AbstractPreparation</a></p> <p><b>All Base Classes: </b><a href="Poco.Data.AbstractPreparation.html" title="class Poco::Data::AbstractPreparation">Poco::Data::AbstractPreparation</a>, <a href="Poco.RefCountedObject.html" title="class Poco::RefCountedObject">Poco::RefCountedObject</a></p> <h2>Member Summary</h2> <p><b>Member Functions: </b><a href="Poco.Data.ODBC.Preparation.html#1171" title="Poco::Data::ODBC::Preparation::actualDataSize()">actualDataSize</a>, <a href="Poco.Data.ODBC.Preparation.html#1163" title="Poco::Data::ODBC::Preparation::columns()">columns</a>, <a href="Poco.Data.ODBC.Preparation.html#1175" title="Poco::Data::ODBC::Preparation::getDataExtraction()">getDataExtraction</a>, <a href="Poco.Data.ODBC.Preparation.html#1168" title="Poco::Data::ODBC::Preparation::getMaxFieldSize()">getMaxFieldSize</a>, <a href="Poco.Data.ODBC.Preparation.html#1169" title="Poco::Data::ODBC::Preparation::maxDataSize()">maxDataSize</a>, <a href="Poco.Data.ODBC.Preparation.html#1164" title="Poco::Data::ODBC::Preparation::operator()">operator</a>, <a href="Poco.Data.ODBC.Preparation.html#1118" title="Poco::Data::ODBC::Preparation::prepare()">prepare</a>, <a href="Poco.Data.ODBC.Preparation.html#1173" title="Poco::Data::ODBC::Preparation::setDataExtraction()">setDataExtraction</a>, <a href="Poco.Data.ODBC.Preparation.html#1166" title="Poco::Data::ODBC::Preparation::setMaxFieldSize()">setMaxFieldSize</a></p> <p><b>Inherited Functions: </b><a href="Poco.RefCountedObject.html#9659" title="Poco::RefCountedObject::duplicate()">duplicate</a>, <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">prepare</a>, <a href="Poco.RefCountedObject.html#9661" title="Poco::RefCountedObject::referenceCount()">referenceCount</a>, <a href="Poco.RefCountedObject.html#9660" title="Poco::RefCountedObject::release()">release</a></p> <h2>Enumerations</h2> <h3><a name="1109">DataExtraction</a></h3> <div class="description"> <p></p> </div> <p class="decl"><a name="1110">DE_MANUAL</a></p> <div class="description"> <p></p> </div> <p class="decl"><a name="1111">DE_BOUND</a></p> <div class="description"> <p></p> </div> <h2>Constructors</h2> <h3><a name="1112">Preparation</a></h3> <p class="decl"><a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a>(<br /> const <a href="Poco.Data.ODBC.html#908" title="Poco::Data::ODBC::StatementHandle">StatementHandle</a> & rStmt,<br /> const std::string & statement,<br /> std::size_t maxFieldSize,<br /> <a href="Poco.Data.ODBC.Preparation.html#1109" title="enum Poco::Data::ODBC::Preparation::DataExtraction">DataExtraction</a> dataExtraction = DE_BOUND<br />);</p> <div class="description"> <p>Creates the <a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a>. </p> </div> <h2>Destructor</h2> <h3><a name="1117">~Preparation</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">~<a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a>();</p> <div class="description"> <p>Destroys the <a href="Poco.Data.ODBC.Preparation.html" title="class Poco::Data::ODBC::Preparation">Preparation</a>. </p> </div> <h2>Member Functions</h2> <h3><a name="1171">actualDataSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">std::size_t actualDataSize(<br /> std::size_t pos<br />) const;</p> <div class="description"> <p>Returns the returned length. This is usually equal to the column size, except for variable length fields (<a href="Poco.Data.BLOB.html" title="class Poco::Data::BLOB">BLOB</a> and variable length strings). </p> </div> <h3><a name="1163">columns</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">std::size_t columns() const;</p> <div class="description"> <p>Returns the number of columns. </p> </div> <h3><a name="1175">getDataExtraction</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl"><a href="Poco.Data.ODBC.Preparation.html#1109" title="enum Poco::Data::ODBC::Preparation::DataExtraction">DataExtraction</a> getDataExtraction() const;</p> <div class="description"> <p>Returns data extraction mode. </p> </div> <h3><a name="1168">getMaxFieldSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">std::size_t getMaxFieldSize() const;</p> <div class="description"> <p></p> </div> <h3><a name="1169">maxDataSize</a></h3> <p class="decl">std::size_t maxDataSize(<br /> std::size_t pos<br />) const;</p> <div class="description"> <p>Returns max supported size for column at position pos. Returned length for variable length fields is the one supported by this implementation, not the underlying DB. </p> </div> <h3><a name="1164">operator</a></h3> <p class="decl"><a href="Poco.Any.html" title="class Poco::Any">Poco::Any</a> & operator[] (<br /> std::size_t pos<br />);</p> <div class="description"> <p>Returns reference to column data. </p> </div> <h3><a name="1118">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11349" title="Poco::Int8">Poco::Int8</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11349" title="Poco::Int8">Int8</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1121">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11350" title="Poco::UInt8">Poco::UInt8</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11350" title="Poco::UInt8">UInt8</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1124">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11351" title="Poco::Int16">Poco::Int16</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11351" title="Poco::Int16">Int16</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1127">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11352" title="Poco::UInt16">Poco::UInt16</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11352" title="Poco::UInt16">UInt16</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1130">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11353" title="Poco::Int32">Poco::Int32</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11353" title="Poco::Int32">Int32</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1133">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11354" title="Poco::UInt32">Poco::UInt32</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11354" title="Poco::UInt32">UInt32</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1136">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11357" title="Poco::Int64">Poco::Int64</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11357" title="Poco::Int64">Int64</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1139">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> <a href="Poco.html#11358" title="Poco::UInt64">Poco::UInt64</a><br />);</p> <div class="description"> <p>Prepares an <a href="Poco.html#11358" title="Poco::UInt64">UInt64</a>. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2204" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1142">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> bool<br />);</p> <div class="description"> <p>Prepares a boolean. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2228" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1145">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> float<br />);</p> <div class="description"> <p>Prepares a float. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2231" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1148">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> double<br />);</p> <div class="description"> <p>Prepares a double. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2234" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1151">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> char<br />);</p> <div class="description"> <p>Prepares a single character. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2237" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1154">prepare</a> <img src="images/virtual.gif" alt="virtual" title="virtual" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> const std::string & param22<br />);</p> <div class="description"> <p>Prepares a string. </p> </div> <div class="description"><p><b>See also:</b> <a href="Poco.Data.AbstractPreparation.html#2240" title="Poco::Data::AbstractPreparation::prepare()">Poco::Data::AbstractPreparation::prepare()</a></p></div> <h3><a name="1157">prepare</a></h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> const <a href="Poco.Data.BLOB.html" title="class Poco::Data::BLOB">Poco::Data::BLOB</a> & param23<br />);</p> <div class="description"> <p>Prepares a <a href="Poco.Data.BLOB.html" title="class Poco::Data::BLOB">BLOB</a>. </p> </div> <h3><a name="1160">prepare</a></h3> <p class="decl">void prepare(<br /> std::size_t pos,<br /> const <a href="Poco.Any.html" title="class Poco::Any">Poco::Any</a> & param24<br />);</p> <div class="description"> <p>Prepares an <a href="Poco.Any.html" title="class Poco::Any">Any</a>. </p> </div> <h3><a name="1173">setDataExtraction</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setDataExtraction(<br /> <a href="Poco.Data.ODBC.Preparation.html#1109" title="enum Poco::Data::ODBC::Preparation::DataExtraction">DataExtraction</a> ext<br />);</p> <div class="description"> <p>Set data extraction mode. </p> </div> <h3><a name="1166">setMaxFieldSize</a> <img src="images/inline.gif" alt="inline" title="inline" style="vertical-align:baseline;" border="0" /> </h3> <p class="decl">void setMaxFieldSize(<br /> std::size_t size<br />);</p> <div class="description"> <p>Sets maximum supported field size. </p> </div> <p class="footer">POCO C++ Libraries 1.3.6-all<br /> Copyright © 2009, <a href="http://pocoproject.org/" target="_blank">Applied Informatics Software Engineering GmbH and Contributors</a></p> </div> </body> </html>
