<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>libgdamm: Gnome::Gda::SqlParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css">
<link href="doxygen.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.8 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="pages.html"><span>Related Pages</span></a></li>
<li><a href="modules.html"><span>Modules</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>
</ul>
</div>
<div class="tabs">
<ul>
<li><a href="annotated.html"><span>Class List</span></a></li>
<li><a href="classes.html"><span>Class Index</span></a></li>
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="namespaceGnome.html">Gnome</a>::<a class="el" href="namespaceGnome_1_1Gda.html">Gda</a>::<a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">SqlParser</a>
</div>
</div>
<div class="contents">
<h1>Gnome::Gda::SqlParser Class Reference</h1><!-- doxytag: class="Gnome::Gda::SqlParser" --><!-- doxytag: inherits="Glib::Object" -->SQL parser. <a href="#_details">More...</a>
<p>
Inherits <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html">Glib::Object</a>.
<p>
<div class="dynheader">
Collaboration diagram for Gnome::Gda::SqlParser:</div>
<div class="dynsection">
<p><center><img src="classGnome_1_1Gda_1_1SqlParser__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1SqlParser__coll__map" alt="Collaboration graph"></center>
<map name="Gnome_1_1Gda_1_1SqlParser__coll__map">
<area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1Object.html" title="Glib::Object" alt="" coords="40,155,131,181"><area shape="rect" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html" title="Glib::ObjectBase" alt="" coords="25,80,145,107"><area shape="rect" href="../../../libsigc++-2.0/reference/html/structsigc_1_1trackable.html" title="sigc::trackable" alt="" coords="32,5,139,32"></map>
<center><font size="2">[<a href="graph_legend.html">legend</a>]</font></center></div>
<p>
<a href="classGnome_1_1Gda_1_1SqlParser-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 Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#765d2c3c16ddc2e2d0c123f7abd42ed5">~SqlParser</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#f25f6f171a0e49b7a699fec818fff0eb">gobj</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#f25f6f171a0e49b7a699fec818fff0eb"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">const GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#c75589e6f67165c0eaad7b0320c862c7">gobj</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#c75589e6f67165c0eaad7b0320c862c7"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#2361217e48cb1f4bd2e7eefde1e2540f">gobj_copy</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <a href="#2361217e48cb1f4bd2e7eefde1e2540f"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1Statement.html">Statement</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#7bf6ab947171af3633f9057493282283">parse_string</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& sql, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& remain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parses <em>sql</em> and creates a <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> statement from the first SQL statement contained in <em>sql:</em> if <em>sql</em> contains more than one statement, then the remaining part of the string is not parsed at all, and <em>remain</em> (if not <code>0</code>) will point at the first non parsed character. <a href="#7bf6ab947171af3633f9057493282283"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1Statement.html">Statement</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#5b2e0e43aaa1564761367b12dc5ea428">parse_string</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& sql)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#4c6d00c520b3e7db2202c6cedee70732">parse_string_as_batch</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& sql, <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& remain)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse <em>sql</em> and creates a <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object which contains all the <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects created while parsing (one object per SQL statement). <a href="#4c6d00c520b3e7db2202c6cedee70732"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#1e039c647fdebc48ca3f080839c79757">parse_string_as_batch</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& sql)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#77ce1356f13018c6c1762542612ad863">parse_file_as_batch</a> (const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a>& filename)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">Parse <em>filename's</em> contents and creates a <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object which contains all the <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects created while parsing (one object per SQL statement). <a href="#77ce1356f13018c6c1762542612ad863"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#4b444c89abca611871e7b2f69180f95c">property_column_error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#4b444c89abca611871e7b2f69180f95c"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#baa2e9abd7bb376cad3d7b764561e5f8">property_line_error</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#baa2e9abd7bb376cad3d7b764561e5f8"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#408b37ec8905b302af01b5f5cabacf65">property_mode</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#408b37ec8905b302af01b5f5cabacf65"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#dbe30840427ea8a4b6c3c74ffa8b860a">property_mode</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#dbe30840427ea8a4b6c3c74ffa8b860a"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#cf3aa70c619396c2d7ff1fb1c9f52319">property_tokenizer_flavour</a> ()</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#cf3aa70c619396c2d7ff1fb1c9f52319"></a><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a>< int > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#f136acfc012d173361502518cb1e03c3">property_tokenizer_flavour</a> () const </td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">You rarely need to use properties because there are get_ and set_ methods for almost all of them. <a href="#f136acfc012d173361502518cb1e03c3"></a><br></td></tr>
<tr><td colspan="2"><br><h2>Static Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">SqlParser</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#8cf75992930e982c18573a5229a87ca7">create</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Protected Member Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#2cc927b65570bb3b2dbf8fc2b494a044">SqlParser</a> ()</td></tr>
<tr><td colspan="2"><br><h2>Related Functions</h2></td></tr>
<tr><td colspan="2">(Note that these are not member functions.) <br><br></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><br class="typebreak">
< <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">Gnome::Gda::SqlParser</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#8d5a3c0d376b2111618f83a4708c6d59">wrap</a> (GdaSqlParser* object, bool take_copy=false)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#8d5a3c0d376b2111618f83a4708c6d59"></a><br></td></tr>
</table>
<hr><a name="_details"></a><h2>Detailed Description</h2>
SQL parser. <p>
The <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> is an object dedicated to creating <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> and <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> objects from SQL strings. The actual contents of the parsed statements is represented as Gda::SqlStatement structures (which can be obtained from any <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> through the "structure" property).<p>
<a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> parsers can be created by calling <a class="el" href="classGnome_1_1Gda_1_1ServerProvider.html#8676058daf007a085469999e501dc897" title="Creates a new Gda::SqlParser object which is adapted to provider (and possibly depending...">Gda::ServerProvider::create_parser()</a> for a provider adapted SQL parser, or using <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#8cf75992930e982c18573a5229a87ca7">create()</a> for a general purpose SQL parser.<p>
The <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> can either work in "parse" mode where it will try to parse the SQL string, or in "delimiter" mode where it will only attempt at delimiting SQL statements in a string which may contain several SQL statements (usually separated by a semi column). If operating in "parser" mode, and the parser can't correctly parse the string, then it will switch to the "delimiter" mode for the next statement in the string to parse (and create a STATEMENT_UNKNOWN statement).<p>
The <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> object parses and analyses SQL statements and reports the following statement types:<p>
<ul>
<li>SELECT (and COMPOUND select), INSERT, UPDATE and DELETE SQL statements should be completely parsed.</li></ul>
<p>
<ul>
<li>Transaction related statements (corresponding to the BEGIN, COMMIT, ROLLBACK, SAVEPOINT, ROLLBACK SAVEPOINT and DELETE SAVEPOINT) are parsed and a minimalist structure is created to extract some information (that structure is not enough per-se to re-create the complete SQL statement).</li></ul>
<p>
Any other type of SQL statement (CREATE TABLE, ...) creates a GdaStatement of type STATEMENT_UNKNOWN, and it only able to locate place holders (variables) and end of statement marks.<p>
NOTE: Any SQL of a type which should be parsed which but which creates a <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> of type GDA_SQL_STATEMENT_UNKNOWN (check with <a class="el" href="classGnome_1_1Gda_1_1Statement.html#743226b2c98d269aca41c44a16a36ba2" title="Get the type of statement held by stmt.">Gda::Statement::get_statement_type()</a>) should be reported as a bug.<p>
The <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> object recognizes place holders (variables), which can later be queried and valued using <a class="el" href="classGnome_1_1Gda_1_1Statement.html#8dad51a8ddb41ae5d1f67b81e777471c" title="Get a new Gda::Set object which groups all the execution parameters which stmt needs...">Gda::Statement::get_parameters()</a>. The folllowing syntax are recognized (other syntaxes might be recognized for specific database providers if the <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html" title="SQL parser.">Gda::SqlParser</a> is created using <a class="el" href="classGnome_1_1Gda_1_1ServerProvider.html#8676058daf007a085469999e501dc897" title="Creates a new Gda::SqlParser object which is adapted to provider (and possibly depending...">Gda::ServerProvider::create_parser()</a> but for portability reasons it's better to avoid them):<p>
<ul>
<li>#NAME[TYPE[NULL]]: for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), and with the optional "::NULL" to instruct that the variable can be NULL.</li><li>## //<div class="fragment"><pre class="fragment"></pre></div>* name:NAME [type:TYPE] [nullok:[TRUE|FALSE]] [descr:DESCR] *<div class="fragment"><pre class="fragment"></pre></div>/ for a variable named NAME with the optional type TYPE (which can be a GType name or a custom database type name), with the optional "nullok" attribute and an optional description DESCR. Note that the NAME, TYPE and DESCR literals here must be quoted (simple or double quotes) if they include non alphanumeric characters, and that there must always be at least a space between the ## and the //<div class="fragment"><pre class="fragment"></pre></div>* ... *<div class="fragment"><pre class="fragment"></pre></div>/. </li></ul>
<hr><h2>Constructor & Destructor Documentation</h2>
<a class="anchor" name="765d2c3c16ddc2e2d0c123f7abd42ed5"></a><!-- doxytag: member="Gnome::Gda::SqlParser::~SqlParser" ref="765d2c3c16ddc2e2d0c123f7abd42ed5" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">virtual Gnome::Gda::SqlParser::~SqlParser </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [virtual]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="2cc927b65570bb3b2dbf8fc2b494a044"></a><!-- doxytag: member="Gnome::Gda::SqlParser::SqlParser" ref="2cc927b65570bb3b2dbf8fc2b494a044" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">Gnome::Gda::SqlParser::SqlParser </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [protected]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<hr><h2>Member Function Documentation</h2>
<a class="anchor" name="8cf75992930e982c18573a5229a87ca7"></a><!-- doxytag: member="Gnome::Gda::SqlParser::create" ref="8cf75992930e982c18573a5229a87ca7" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">static <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">SqlParser</a>> Gnome::Gda::SqlParser::create </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [static]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="c75589e6f67165c0eaad7b0320c862c7"></a><!-- doxytag: member="Gnome::Gda::SqlParser::gobj" ref="c75589e6f67165c0eaad7b0320c862c7" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">const GdaSqlParser* Gnome::Gda::SqlParser::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const<code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject. <p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#778a94181132976bbfb0519793f3b32e">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="f25f6f171a0e49b7a699fec818fff0eb"></a><!-- doxytag: member="Gnome::Gda::SqlParser::gobj" ref="f25f6f171a0e49b7a699fec818fff0eb" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaSqlParser* Gnome::Gda::SqlParser::gobj </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td><code> [inline]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C GObject. <p>
<p>Reimplemented from <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ObjectBase.html#4c6efc18be8cb9c56e58fc0bd20fafbe">Glib::ObjectBase</a>.</p>
</div>
</div><p>
<a class="anchor" name="2361217e48cb1f4bd2e7eefde1e2540f"></a><!-- doxytag: member="Gnome::Gda::SqlParser::gobj_copy" ref="2361217e48cb1f4bd2e7eefde1e2540f" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">GdaSqlParser* Gnome::Gda::SqlParser::gobj_copy </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Provides access to the underlying C instance. The caller is responsible for unrefing it. Use when directly setting fields in structs. <p>
</div>
</div><p>
<a class="anchor" name="77ce1356f13018c6c1762542612ad863"></a><!-- doxytag: member="Gnome::Gda::SqlParser::parse_file_as_batch" ref="77ce1356f13018c6c1762542612ad863" args="(const std::string &filename)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a>> Gnome::Gda::SqlParser::parse_file_as_batch </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/a00969.html#32db3d9898c44d3b3a578b560f7758cc">std::string</a> & </td>
<td class="paramname"> <em>filename</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse <em>filename's</em> contents and creates a <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object which contains all the <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects created while parsing (one object per SQL statement). <p>
<em>filename's</em> contents are parsed and <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects are created as long as no error is found. If an error is found at some point, then the parsing stops, <em>error</em> may be set and <code>0</code> is returned<p>
if <em>sql</em> is <code>0</code>, then the returned <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object will contain no statement. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>filename</em> </td><td>Name of the file to parse. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object, or <code>0</code> if an error occurred. </dd></dl>
</div>
</div><p>
<a class="anchor" name="5b2e0e43aaa1564761367b12dc5ea428"></a><!-- doxytag: member="Gnome::Gda::SqlParser::parse_string" ref="5b2e0e43aaa1564761367b12dc5ea428" args="(const Glib::ustring &sql)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1Statement.html">Statement</a>> Gnome::Gda::SqlParser::parse_string </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>sql</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="7bf6ab947171af3633f9057493282283"></a><!-- doxytag: member="Gnome::Gda::SqlParser::parse_string" ref="7bf6ab947171af3633f9057493282283" args="(const Glib::ustring &sql, Glib::ustring &remain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1Statement.html">Statement</a>> Gnome::Gda::SqlParser::parse_string </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>sql</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>remain</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parses <em>sql</em> and creates a <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> statement from the first SQL statement contained in <em>sql:</em> if <em>sql</em> contains more than one statement, then the remaining part of the string is not parsed at all, and <em>remain</em> (if not <code>0</code>) will point at the first non parsed character. <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>sql</em> </td><td>The SQL string to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remain</em> </td><td>Location to store a pointer to remaining part of <em>sql</em> in case <em>sql</em> has multiple statement, or <code>0</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> object, or <code>0</code> if an error occurred. </dd></dl>
</div>
</div><p>
<a class="anchor" name="1e039c647fdebc48ca3f080839c79757"></a><!-- doxytag: member="Gnome::Gda::SqlParser::parse_string_as_batch" ref="1e039c647fdebc48ca3f080839c79757" args="(const Glib::ustring &sql)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a>> Gnome::Gda::SqlParser::parse_string_as_batch </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>sql</em> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="4c6d00c520b3e7db2202c6cedee70732"></a><!-- doxytag: member="Gnome::Gda::SqlParser::parse_string_as_batch" ref="4c6d00c520b3e7db2202c6cedee70732" args="(const Glib::ustring &sql, Glib::ustring &remain)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a><<a class="el" href="classGnome_1_1Gda_1_1Batch.html">Batch</a>> Gnome::Gda::SqlParser::parse_string_as_batch </td>
<td>(</td>
<td class="paramtype">const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>sql</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a> & </td>
<td class="paramname"> <em>remain</em></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
Parse <em>sql</em> and creates a <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object which contains all the <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects created while parsing (one object per SQL statement). <p>
Empty statements (composed of spaces only) do not appear in the resulting object.<p>
<em>sql</em> is parsed and <a class="el" href="classGnome_1_1Gda_1_1Statement.html" title="Single SQL statement.">Gda::Statement</a> objects are created as long as no error is found in <em>sql</em>. If an error is found at some point, then the parsing stops and <em>remain</em> may contain a non <code>0</code> pointer, <em>error</em> may be set, and <code>0</code> is returned.<p>
if <em>sql</em> is <code>0</code>, then the returned <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object will contain no statement. <dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>sql</em> </td><td>The SQL string to parse. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>remain</em> </td><td>Location to store a pointer to remaining part of <em>sql</em> in case an error occurred while parsing <em>sql</em>, or <code>0</code>. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A new <a class="el" href="classGnome_1_1Gda_1_1Batch.html" title="Multiple SQL statements grouped together.">Gda::Batch</a> object, or <code>0</code> if an error occurred. </dd></dl>
</div>
</div><p>
<a class="anchor" name="4b444c89abca611871e7b2f69180f95c"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_column_error" ref="4b444c89abca611871e7b2f69180f95c" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Gnome::Gda::SqlParser::property_column_error </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="baa2e9abd7bb376cad3d7b764561e5f8"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_line_error" ref="baa2e9abd7bb376cad3d7b764561e5f8" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Gnome::Gda::SqlParser::property_line_error </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="dbe30840427ea8a4b6c3c74ffa8b860a"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_mode" ref="dbe30840427ea8a4b6c3c74ffa8b860a" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Gnome::Gda::SqlParser::property_mode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="408b37ec8905b302af01b5f5cabacf65"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_mode" ref="408b37ec8905b302af01b5f5cabacf65" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><int> Gnome::Gda::SqlParser::property_mode </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="f136acfc012d173361502518cb1e03c3"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_tokenizer_flavour" ref="f136acfc012d173361502518cb1e03c3" args="() const " -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy__ReadOnly.html">Glib::PropertyProxy_ReadOnly</a><int> Gnome::Gda::SqlParser::property_tokenizer_flavour </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td> const</td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<a class="anchor" name="cf3aa70c619396c2d7ff1fb1c9f52319"></a><!-- doxytag: member="Gnome::Gda::SqlParser::property_tokenizer_flavour" ref="cf3aa70c619396c2d7ff1fb1c9f52319" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1PropertyProxy.html">Glib::PropertyProxy</a><int> Gnome::Gda::SqlParser::property_tokenizer_flavour </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
You rarely need to use properties because there are get_ and set_ methods for almost all of them. <p>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A PropertyProxy that allows you to get or set the property of the value, or receive notification when the value of the property changes. </dd></dl>
</div>
</div><p>
<hr><h2>Friends And Related Function Documentation</h2>
<a class="anchor" name="8d5a3c0d376b2111618f83a4708c6d59"></a><!-- doxytag: member="Gnome::Gda::SqlParser::wrap" ref="8d5a3c0d376b2111618f83a4708c6d59" args="(GdaSqlParser *object, bool take_copy=false)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1RefPtr.html">Glib::RefPtr</a>< <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">Gnome::Gda::SqlParser</a> > wrap </td>
<td>(</td>
<td class="paramtype">GdaSqlParser * </td>
<td class="paramname"> <em>object</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">bool </td>
<td class="paramname"> <em>take_copy</em> = <code>false</code></td><td> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td><td><code> [related]</code></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <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>object</em> </td><td>The C instance. </td></tr>
<tr><td valign="top"></td><td valign="top"><em>take_copy</em> </td><td>False if the result should take ownership of the C instance. True if it should take a new copy or ref. </td></tr>
</table>
</dl>
<dl class="return" compact><dt><b>Returns:</b></dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div><p>
<hr>The documentation for this class was generated from the following file:<ul>
<li>libgdamm/sqlparser.h</ul>
</div>
<hr size="1"><address style="text-align: right;"><small>Generated on Fri Aug 28 20:01:56 2009 for libgdamm by 
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.8 </small></address>
</body>
</html>
