<!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>
<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.3.1"/>
<title>libgdamm: Gnome::Gda::SqlParser Class Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.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 style="padding-left: 0.5em;">
<div id="projectname">libgdamm
 <span id="projectnumber">4.99.7</span>
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3.1 -->
<div id="navrow1" class="tabs">
<ul class="tablist">
<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 id="navrow2" class="tabs2">
<ul class="tablist">
<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="inherits.html"><span>Class Hierarchy</span></a></li>
<li><a href="functions.html"><span>Class Members</span></a></li>
</ul>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="namespaceGnome.html">Gnome</a></li><li class="navelem"><a class="el" href="namespaceGnome_1_1Gda.html">Gda</a></li><li class="navelem"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html">SqlParser</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="summary">
<a href="#pub-methods">Public Member Functions</a> |
<a href="#pub-static-methods">Static Public Member Functions</a> |
<a href="#pro-methods">Protected Member Functions</a> |
<a href="#related">Related Functions</a> |
<a href="classGnome_1_1Gda_1_1SqlParser-members.html">List of all members</a> </div>
<div class="headertitle">
<div class="title">Gnome::Gda::SqlParser Class Reference</div> </div>
</div><!--header-->
<div class="contents">
<p>SQL parser.
<a href="classGnome_1_1Gda_1_1SqlParser.html#details">More...</a></p>
<div class="dynheader">
Inheritance diagram for Gnome::Gda::SqlParser:</div>
<div class="dyncontent">
<div class="center"><img src="classGnome_1_1Gda_1_1SqlParser__inherit__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1SqlParser_inherit__map" alt="Inheritance graph"/></div>
<map name="Gnome_1_1Gda_1_1SqlParser_inherit__map" id="Gnome_1_1Gda_1_1SqlParser_inherit__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<div class="dynheader">
Collaboration diagram for Gnome::Gda::SqlParser:</div>
<div class="dyncontent">
<div class="center"><img src="classGnome_1_1Gda_1_1SqlParser__coll__graph.png" border="0" usemap="#Gnome_1_1Gda_1_1SqlParser_coll__map" alt="Collaboration graph"/></div>
<map name="Gnome_1_1Gda_1_1SqlParser_coll__map" id="Gnome_1_1Gda_1_1SqlParser_coll__map">
</map>
<center><span class="legend">[<a href="graph_legend.html">legend</a>]</span></center></div>
<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:a765d2c3c16ddc2e2d0c123f7abd42ed5"><td class="memItemLeft" align="right" valign="top">virtual </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#a765d2c3c16ddc2e2d0c123f7abd42ed5">~SqlParser</a> ()</td></tr>
<tr class="separator:a765d2c3c16ddc2e2d0c123f7abd42ed5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af25f6f171a0e49b7a699fec818fff0eb"><td class="memItemLeft" align="right" valign="top">GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#af25f6f171a0e49b7a699fec818fff0eb">gobj</a> ()</td></tr>
<tr class="memdesc:af25f6f171a0e49b7a699fec818fff0eb"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#af25f6f171a0e49b7a699fec818fff0eb">More...</a><br/></td></tr>
<tr class="separator:af25f6f171a0e49b7a699fec818fff0eb"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac75589e6f67165c0eaad7b0320c862c7"><td class="memItemLeft" align="right" valign="top">const GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#ac75589e6f67165c0eaad7b0320c862c7">gobj</a> () const </td></tr>
<tr class="memdesc:ac75589e6f67165c0eaad7b0320c862c7"><td class="mdescLeft"> </td><td class="mdescRight">Provides access to the underlying C GObject. <a href="#ac75589e6f67165c0eaad7b0320c862c7">More...</a><br/></td></tr>
<tr class="separator:ac75589e6f67165c0eaad7b0320c862c7"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a2361217e48cb1f4bd2e7eefde1e2540f"><td class="memItemLeft" align="right" valign="top">GdaSqlParser* </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#a2361217e48cb1f4bd2e7eefde1e2540f">gobj_copy</a> ()</td></tr>
<tr class="memdesc:a2361217e48cb1f4bd2e7eefde1e2540f"><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="#a2361217e48cb1f4bd2e7eefde1e2540f">More...</a><br/></td></tr>
<tr class="separator:a2361217e48cb1f4bd2e7eefde1e2540f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a7bf6ab947171af3633f9057493282283"><td class="memItemLeft" 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#a7bf6ab947171af3633f9057493282283">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 class="memdesc:a7bf6ab947171af3633f9057493282283"><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="#a7bf6ab947171af3633f9057493282283">More...</a><br/></td></tr>
<tr class="separator:a7bf6ab947171af3633f9057493282283"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a5b2e0e43aaa1564761367b12dc5ea428"><td class="memItemLeft" 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#a5b2e0e43aaa1564761367b12dc5ea428">parse_string</a> (const <a class="elRef" href="../../../glibmm-2.4/reference/html/classGlib_1_1ustring.html">Glib::ustring</a>& sql)</td></tr>
<tr class="separator:a5b2e0e43aaa1564761367b12dc5ea428"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a4c6d00c520b3e7db2202c6cedee70732"><td class="memItemLeft" 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#a4c6d00c520b3e7db2202c6cedee70732">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 class="memdesc:a4c6d00c520b3e7db2202c6cedee70732"><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="#a4c6d00c520b3e7db2202c6cedee70732">More...</a><br/></td></tr>
<tr class="separator:a4c6d00c520b3e7db2202c6cedee70732"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a1e039c647fdebc48ca3f080839c79757"><td class="memItemLeft" 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#a1e039c647fdebc48ca3f080839c79757">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 class="separator:a1e039c647fdebc48ca3f080839c79757"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a77ce1356f13018c6c1762542612ad863"><td class="memItemLeft" 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#a77ce1356f13018c6c1762542612ad863">parse_file_as_batch</a> (const std::string& filename)</td></tr>
<tr class="memdesc:a77ce1356f13018c6c1762542612ad863"><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="#a77ce1356f13018c6c1762542612ad863">More...</a><br/></td></tr>
<tr class="separator:a77ce1356f13018c6c1762542612ad863"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a901ca836d656a240c0d9746de5461e8e"><td class="memItemLeft" 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#a901ca836d656a240c0d9746de5461e8e">property_column_error</a> () const </td></tr>
<tr class="memdesc:a901ca836d656a240c0d9746de5461e8e"><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="#a901ca836d656a240c0d9746de5461e8e">More...</a><br/></td></tr>
<tr class="separator:a901ca836d656a240c0d9746de5461e8e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aa6732a8141c7516cf182234038d950df"><td class="memItemLeft" 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#aa6732a8141c7516cf182234038d950df">property_line_error</a> () const </td></tr>
<tr class="memdesc:aa6732a8141c7516cf182234038d950df"><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="#aa6732a8141c7516cf182234038d950df">More...</a><br/></td></tr>
<tr class="separator:aa6732a8141c7516cf182234038d950df"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a048397decb466cba4d5f24a9008a19be"><td class="memItemLeft" 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#a048397decb466cba4d5f24a9008a19be">property_mode</a> ()</td></tr>
<tr class="memdesc:a048397decb466cba4d5f24a9008a19be"><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="#a048397decb466cba4d5f24a9008a19be">More...</a><br/></td></tr>
<tr class="separator:a048397decb466cba4d5f24a9008a19be"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3f9d9d5560d37e7d09bdc39627c6aa42"><td class="memItemLeft" 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#a3f9d9d5560d37e7d09bdc39627c6aa42">property_mode</a> () const </td></tr>
<tr class="memdesc:a3f9d9d5560d37e7d09bdc39627c6aa42"><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="#a3f9d9d5560d37e7d09bdc39627c6aa42">More...</a><br/></td></tr>
<tr class="separator:a3f9d9d5560d37e7d09bdc39627c6aa42"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a3652622ee78a564b82955d957a44b376"><td class="memItemLeft" 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#a3652622ee78a564b82955d957a44b376">property_tokenizer_flavour</a> ()</td></tr>
<tr class="memdesc:a3652622ee78a564b82955d957a44b376"><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="#a3652622ee78a564b82955d957a44b376">More...</a><br/></td></tr>
<tr class="separator:a3652622ee78a564b82955d957a44b376"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a938edbf3e2bd9cc4db64bac560618907"><td class="memItemLeft" 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#a938edbf3e2bd9cc4db64bac560618907">property_tokenizer_flavour</a> () const </td></tr>
<tr class="memdesc:a938edbf3e2bd9cc4db64bac560618907"><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="#a938edbf3e2bd9cc4db64bac560618907">More...</a><br/></td></tr>
<tr class="separator:a938edbf3e2bd9cc4db64bac560618907"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-methods"></a>
Static Public Member Functions</h2></td></tr>
<tr class="memitem:ad933891aee60c6dbce9adae6c09dc71e"><td class="memItemLeft" align="right" valign="top">static GType </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#ad933891aee60c6dbce9adae6c09dc71e">get_type</a> ()</td></tr>
<tr class="memdesc:ad933891aee60c6dbce9adae6c09dc71e"><td class="mdescLeft"> </td><td class="mdescRight">Get the GType for this class, for use with the underlying GObject type system. <a href="#ad933891aee60c6dbce9adae6c09dc71e">More...</a><br/></td></tr>
<tr class="separator:ad933891aee60c6dbce9adae6c09dc71e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a8cf75992930e982c18573a5229a87ca7"><td class="memItemLeft" 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#a8cf75992930e982c18573a5229a87ca7">create</a> ()</td></tr>
<tr class="separator:a8cf75992930e982c18573a5229a87ca7"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pro-methods"></a>
Protected Member Functions</h2></td></tr>
<tr class="memitem:a2cc927b65570bb3b2dbf8fc2b494a044"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#a2cc927b65570bb3b2dbf8fc2b494a044">SqlParser</a> ()</td></tr>
<tr class="separator:a2cc927b65570bb3b2dbf8fc2b494a044"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="related"></a>
Related Functions</h2></td></tr>
<tr><td class="ititle" colspan="2"><p>(Note that these are not member functions.) </p>
</td></tr>
<tr class="memitem:a8d5a3c0d376b2111618f83a4708c6d59"><td class="memItemLeft" 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#a8d5a3c0d376b2111618f83a4708c6d59">wrap</a> (GdaSqlParser* object, bool take_copy=false)</td></tr>
<tr class="memdesc:a8d5a3c0d376b2111618f83a4708c6d59"><td class="mdescLeft"> </td><td class="mdescRight">A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. <a href="#a8d5a3c0d376b2111618f83a4708c6d59">More...</a><br/></td></tr>
<tr class="separator:a8d5a3c0d376b2111618f83a4708c6d59"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>SQL parser. </p>
<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 <a class="el" href="classGnome_1_1Gda_1_1SqlStatement.html" title="Every SQL statement can be decomposed in the SqlStatement tree structure.">Gda::SqlStatement</a> 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>
<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#a8676058daf007a085469999e501dc897" title="Creates a new Gda::SqlParser object which is adapted to provider (and possibly depending on cnc for t...">Gda::ServerProvider::create_parser()</a> for a provider adapted SQL parser, or using <a class="el" href="classGnome_1_1Gda_1_1SqlParser.html#a8cf75992930e982c18573a5229a87ca7">create()</a> for a general purpose SQL parser.</p>
<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>
<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>
<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>
<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#a743226b2c98d269aca41c44a16a36ba2" title="Get the type of statement held by stmt.">Gda::Statement::get_statement_type()</a>) should be reported as a bug.</p>
<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#a8dad51a8ddb41ae5d1f67b81e777471c" title="Get a new Gda::Set object which groups all the execution parameters which stmt needs.">Gda::Statement::get_parameters()</a>. See the syntax description for the underlying <a href="http://library.gnome.org/devel/libgda/stable/GdaSqlParser.html#GdaSqlParser.description">GdaSqlParser</a>. </p>
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
<a class="anchor" id="a765d2c3c16ddc2e2d0c123f7abd42ed5"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">virtual Gnome::Gda::SqlParser::~SqlParser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">virtual</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="a2cc927b65570bb3b2dbf8fc2b494a044"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">Gnome::Gda::SqlParser::SqlParser </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">protected</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<h2 class="groupheader">Member Function Documentation</h2>
<a class="anchor" id="a8cf75992930e982c18573a5229a87ca7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
</div>
</div>
<a class="anchor" id="ad933891aee60c6dbce9adae6c09dc71e"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">static GType Gnome::Gda::SqlParser::get_type </td>
<td>(</td>
<td class="paramname"></td><td>)</td>
<td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">static</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the GType for this class, for use with the underlying GObject type system. </p>
</div>
</div>
<a class="anchor" id="af25f6f171a0e49b7a699fec818fff0eb"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">GdaSqlParser* Gnome::Gda::SqlParser::gobj </td>
<td>(</td>
<td class="paramname"></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>Provides access to the underlying C GObject. </p>
</div>
</div>
<a class="anchor" id="ac75589e6f67165c0eaad7b0320c862c7"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<table class="memname">
<tr>
<td class="memname">const GdaSqlParser* Gnome::Gda::SqlParser::gobj </td>
<td>(</td>
<td class="paramname"></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>Provides access to the underlying C GObject. </p>
</div>
</div>
<a class="anchor" id="a2361217e48cb1f4bd2e7eefde1e2540f"></a>
<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>
<a class="anchor" id="a77ce1356f13018c6c1762542612ad863"></a>
<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 std::string & </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>
<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>
<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. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">filename</td><td>Name of the file to parse. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</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>
<a class="anchor" id="a7bf6ab947171af3633f9057493282283"></a>
<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>
</tr>
<tr>
<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>
<p>To include variables in the <em>sql</em> string, see the GdaSqlParser's object description. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sql</td><td>The SQL string to parse. </td></tr>
<tr><td class="paramname">remain</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>
</dd>
</dl>
<dl class="section return"><dt>Returns</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>
<a class="anchor" id="a5b2e0e43aaa1564761367b12dc5ea428"></a>
<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">
</div>
</div>
<a class="anchor" id="a4c6d00c520b3e7db2202c6cedee70732"></a>
<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>
</tr>
<tr>
<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>
<p>Empty statements (composed of spaces only) do not appear in the resulting object.</p>
<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>
<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.</p>
<p>To include variables in the <em>sql</em> string, see the GdaSqlParser's object description. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">sql</td><td>The SQL string to parse. </td></tr>
<tr><td class="paramname">remain</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>
</dd>
</dl>
<dl class="section return"><dt>Returns</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>
<a class="anchor" id="a1e039c647fdebc48ca3f080839c79757"></a>
<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">
</div>
</div>
<a class="anchor" id="a901ca836d656a240c0d9746de5461e8e"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="aa6732a8141c7516cf182234038d950df"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a048397decb466cba4d5f24a9008a19be"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a3f9d9d5560d37e7d09bdc39627c6aa42"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a3652622ee78a564b82955d957a44b376"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy that allows you to get or set the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<a class="anchor" id="a938edbf3e2bd9cc4db64bac560618907"></a>
<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="section return"><dt>Returns</dt><dd>A PropertyProxy_ReadOnly that allows you to get the value of the property, or receive notification when the value of the property changes. </dd></dl>
</div>
</div>
<h2 class="groupheader">Friends And Related Function Documentation</h2>
<a class="anchor" id="a8d5a3c0d376b2111618f83a4708c6d59"></a>
<div class="memitem">
<div class="memproto">
<table class="mlabels">
<tr>
<td class="mlabels-left">
<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>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</td>
<td class="mlabels-right">
<span class="mlabels"><span class="mlabel">related</span></span> </td>
</tr>
</table>
</div><div class="memdoc">
<p>A <a class="elRef" href="../../../glibmm-2.4/reference/html/namespaceGlib.html#a671306f4a3a0cae5ab4d7a9d54886592">Glib::wrap()</a> method for this object. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">object</td><td>The C instance. </td></tr>
<tr><td class="paramname">take_copy</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>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>A C++ instance that wraps this C instance. </dd></dl>
</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>libgdamm/sqlparser.h</li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Apr 24 2013 11:43:48 for libgdamm by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.3.1
</small></address>
</body>
</html>
