/usr/share/gtk-doc/html/libgda-4.0/GdaVconnectionHub.html is in libgda-4.0-doc 4.2.8-2build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 | <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>GdaVconnectionHub</title>
<meta name="generator" content="DocBook XSL Stylesheets V1.75.2">
<link rel="home" href="index.html" title="GNOME Data Access 4 manual">
<link rel="up" href="virtual_connection.html" title="Virtual connections">
<link rel="prev" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">
<link rel="next" href="data_models.html" title="Data handling">
<meta name="generator" content="GTK-Doc V1.17 (XML mode)">
<link rel="stylesheet" href="style.css" type="text/css">
</head>
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
<table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
<tr valign="middle">
<td><a accesskey="p" href="GdaVconnectionDataModel.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
<td><a accesskey="u" href="virtual_connection.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
<td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
<th width="100%" align="center">GNOME Data Access 4 manual</th>
<td><a accesskey="n" href="data_models.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
</tr>
<tr><td colspan="5" class="shortcuts">
<a href="#GdaVconnectionHub.synopsis" class="shortcut">Top</a>
|
<a href="#GdaVconnectionHub.description" class="shortcut">Description</a>
|
<a href="#GdaVconnectionHub.object-hierarchy" class="shortcut">Object Hierarchy</a>
|
<a href="#GdaVconnectionHub.implemented-interfaces" class="shortcut">Implemented Interfaces</a>
</td></tr>
</table>
<div class="refentry">
<a name="GdaVconnectionHub"></a><div class="titlepage"></div>
<div class="refnamediv"><table width="100%"><tr>
<td valign="top">
<h2><span class="refentrytitle"><a name="GdaVconnectionHub.top_of_page"></a>GdaVconnectionHub</span></h2>
<p>GdaVconnectionHub — Virtual connection which bind together connections</p>
</td>
<td valign="top" align="right"></td>
</tr></table></div>
<div class="refsynopsisdiv">
<a name="GdaVconnectionHub.synopsis"></a><h2>Synopsis</h2>
<pre class="synopsis">struct <a class="link" href="GdaVconnectionHub.html#GdaVconnectionHub-struct" title="struct GdaVconnectionHub">GdaVconnectionHub</a>;
<span class="returnvalue">void</span> (<a class="link" href="GdaVconnectionHub.html#GdaVConnectionHubFunc" title="GdaVConnectionHubFunc ()">*GdaVConnectionHubFunc</a>) (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()">gda_vconnection_hub_add</a> (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-remove" title="gda_vconnection_hub_remove ()">gda_vconnection_hub_remove</a> (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);
<a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-get-connection" title="gda_vconnection_hub_get_connection ()">gda_vconnection_hub_get_connection</a> (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>);
<span class="returnvalue">void</span> <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-foreach" title="gda_vconnection_hub_foreach ()">gda_vconnection_hub_foreach</a> (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html#GdaVConnectionHubFunc" title="GdaVConnectionHubFunc ()"><span class="type">GdaVConnectionHubFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);
</pre>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.object-hierarchy"></a><h2>Object Hierarchy</h2>
<pre class="synopsis">
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
+----<a class="link" href="GdaConnection.html" title="GdaConnection">GdaConnection</a>
+----<a class="link" href="GdaVirtualConnection.html" title="GdaVirtualConnection">GdaVirtualConnection</a>
+----<a class="link" href="GdaVconnectionDataModel.html" title="GdaVconnectionDataModel">GdaVconnectionDataModel</a>
+----GdaVconnectionHub
</pre>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.implemented-interfaces"></a><h2>Implemented Interfaces</h2>
<p>
GdaVconnectionHub implements
<a class="link" href="GdaLockable.html" title="GdaLockable">GdaLockable</a>.</p>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.description"></a><h2>Description</h2>
<p>
The <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> object "binds" together the tables from other (opened) connections to make it possible to run
SQL queries on data from several connections at once.
</p>
<p>
A <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection can bind several other connections, each separated in its own namespace (which is specified
when adding a connection using <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()"><code class="function">gda_vconnection_hub_add()</code></a>).
</p>
<p>
For example if a connection A has two tables 'table_1' and 'table_2', then after <a class="link" href="GdaVconnectionHub.html#gda-vconnection-hub-add" title="gda_vconnection_hub_add ()"><code class="function">gda_vconnection_hub_add()</code></a> has been called
with A as connection argument and with a "c1" namespace, then in the corresponding <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection, table
'table_1' must be referred to as 'c1.table_1' and 'table_2' must be referred to as 'c1.table_2'.
</p>
<p>Note that virtual connections have some inherent limitations
<sup>[<a name="id678099" href="#ftn.id678099" class="footnote">3</a>]</sup>due to the implementation.
</p>
</div>
<div class="refsect1">
<a name="GdaVconnectionHub.details"></a><h2>Details</h2>
<div class="refsect2">
<a name="GdaVconnectionHub-struct"></a><h3>struct GdaVconnectionHub</h3>
<pre class="programlisting">struct GdaVconnectionHub;</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="GdaVConnectionHubFunc"></a><h3>GdaVConnectionHubFunc ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> (*GdaVConnectionHubFunc) (<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
</p>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-add"></a><h3>gda_vconnection_hub_add ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_vconnection_hub_add (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Make all the tables of <em class="parameter"><code>cnc</code></em> appear as tables (of the same name) in the <em class="parameter"><code>hub</code></em> connection.
If the <em class="parameter"><code>ns</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, then within <em class="parameter"><code>hub</code></em>, the tables will be accessible using the '<em class="parameter"><code>ns</code></em>.<em class="parameter"><code>table_name</code></em>'
notation.
</p>
<p>
Within any instance of <em class="parameter"><code>hub</code></em>, there can be only one added connection where <em class="parameter"><code>ns</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hub</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cnc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ns</code></em> :</span></p></td>
<td>a namespace, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-remove"></a><h3>gda_vconnection_hub_remove ()</h3>
<pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gda_vconnection_hub_remove (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> *cnc</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Error-Reporting.html#GError"><span class="type">GError</span></a> **error</code></em>);</pre>
<p>
Remove all the tables in <em class="parameter"><code>hub</code></em> representing <em class="parameter"><code>cnc</code></em>'s tables.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hub</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>cnc</code></em> :</span></p></td>
<td>a <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>
</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>error</code></em> :</span></p></td>
<td>a place to store errors, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>TRUE if no error occurred</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-get-connection"></a><h3>gda_vconnection_hub_get_connection ()</h3>
<pre class="programlisting"><a class="link" href="GdaConnection.html" title="GdaConnection"><span class="returnvalue">GdaConnection</span></a> * gda_vconnection_hub_get_connection (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *ns</code></em>);</pre>
<p>
Find the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> object in <em class="parameter"><code>hub</code></em> associated to the <em class="parameter"><code>ns</code></em> name space
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hub</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>ns</code></em> :</span></p></td>
<td>a name space, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
</td>
</tr>
<tr>
<td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
<td>the <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a> if no connection is associated to <em class="parameter"><code>ns</code></em>
</td>
</tr>
</tbody>
</table></div>
</div>
<hr>
<div class="refsect2">
<a name="gda-vconnection-hub-foreach"></a><h3>gda_vconnection_hub_foreach ()</h3>
<pre class="programlisting"><span class="returnvalue">void</span> gda_vconnection_hub_foreach (<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> *hub</code></em>,
<em class="parameter"><code><a class="link" href="GdaVconnectionHub.html#GdaVConnectionHubFunc" title="GdaVConnectionHubFunc ()"><span class="type">GdaVConnectionHubFunc</span></a> func</code></em>,
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> data</code></em>);</pre>
<p>
Call <em class="parameter"><code>func</code></em> for each <a class="link" href="GdaConnection.html" title="GdaConnection"><span class="type">GdaConnection</span></a> represented in <em class="parameter"><code>hub</code></em>.
</p>
<div class="variablelist"><table border="0">
<col align="left" valign="top">
<tbody>
<tr>
<td><p><span class="term"><em class="parameter"><code>hub</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVconnectionHub.html" title="GdaVconnectionHub"><span class="type">GdaVconnectionHub</span></a> connection</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>func</code></em> :</span></p></td>
<td>a <a class="link" href="GdaVconnectionDataModel.html#GdaVconnectionDataModelFunc" title="GdaVconnectionDataModelFunc ()"><span class="type">GdaVconnectionDataModelFunc</span></a> function pointer</td>
</tr>
<tr>
<td><p><span class="term"><em class="parameter"><code>data</code></em> :</span></p></td>
<td>data to pass to <em class="parameter"><code>func</code></em> calls</td>
</tr>
</tbody>
</table></div>
</div>
</div>
<div class="footnotes">
<br><hr width="100" align="left">
<div class="footnote">
<p><sup>[<a name="ftn.id678099" href="#id678099" class="para">3</a>] </sup>
As virtual connections are implemented using
<a class="ulink" href="http://www.sqlite.org/cvstrac/wiki?p=VirtualTables" target="_top">SQLite's virtual table</a> features,
the SQL dialect which can be used
is the SQLite one (see the <a class="ulink" href="http://sqlite.org/lang.html" target="_top">SQL as Understood By SQLite</a> page), and
there are a few limitations inherent to this implementation (see link for more information).
</p>
<p>
Also note that it is possible to create temporary tables in virtual connections using "CREATE TEMP TABLE..." statements,
but the contents of such tables will be lost once the connection is closed.
</p>
</div>
</div>
</div>
<div class="footer">
<hr>
Generated by GTK-Doc V1.17</div>
</body>
</html>
|