File: vd_remote_data_source.xml

package info (click to toggle)
virtuoso-opensource 7.2.5.1%2Bdfsg1-0.3
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 285,240 kB
  • sloc: ansic: 641,220; sql: 490,413; xml: 269,570; java: 83,893; javascript: 79,900; cpp: 36,927; sh: 31,653; cs: 25,702; php: 12,690; yacc: 10,227; lex: 7,601; makefile: 7,129; jsp: 4,523; awk: 1,697; perl: 1,013; ruby: 1,003; python: 326
file content (92 lines) | stat: -rw-r--r-- 4,088 bytes parent folder | download | duplicates (2)
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
<?xml version="1.0" encoding="ISO-8859-1"?>
<!--
 -  
 -  This file is part of the OpenLink Software Virtuoso Open-Source (VOS)
 -  project.
 -  
 -  Copyright (C) 1998-2018 OpenLink Software
 -  
 -  This project is free software; you can redistribute it and/or modify it
 -  under the terms of the GNU General Public License as published by the
 -  Free Software Foundation; only version 2 of the License, dated June 1991.
 -  
 -  This program is distributed in the hope that it will be useful, but
 -  WITHOUT ANY WARRANTY; without even the implied warranty of
 -  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
 -  General Public License for more details.
 -  
 -  You should have received a copy of the GNU General Public License along
 -  with this program; if not, write to the Free Software Foundation, Inc.,
 -  51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
 -  
 -  
-->
<refentry id="fn_vd_remote_data_source">
  <refmeta>
    <refentrytitle>vd_remote_data_source</refentrytitle>
    <refmiscinfo>rmt</refmiscinfo>
  </refmeta>
  <refnamediv>
    <refname>vd_remote_data_source</refname>
    <refpurpose>prepares a remote DSN  for use</refpurpose>
  </refnamediv>
  <refsynopsisdiv>
    <funcsynopsis id="fsyn_vd_remote_data_source">
      <funcprototype id="fproto_vd_remote_data_source">
        <funcdef><function>vd_remote_data_source</function></funcdef>
        <paramdef>in <parameter>dsn</parameter> varchar</paramdef>
        <paramdef>in <parameter>connstr</parameter> varchar</paramdef>
        <paramdef>in <parameter>user</parameter> varchar</paramdef>
        <paramdef>in <parameter>password</parameter> varchar</paramdef>
      </funcprototype>
    </funcsynopsis>
  </refsynopsisdiv>
  <refsect1 id="desc_vd_remote_data_source"><title>Description</title>
			<para>
A remote data source is uniquely identified by its DSN, the dsn argument
to this function. The connstr argument is presently ignored. The user and
password are the login name and password to use when communicating with
the remote data source. All Virtuoso users dealing with the remote data
source will appear as this user to the remote data source. Virtuoso will
make as many connections as there are concurrent users of the data source.
Connections are cached by Virtuoso.
</para>
			<para>
The default qualifier of the user of the remote data source is usually
not relevant.  This function connects to the DSN in order to retrieve various meta data, which it stores locally.  The DSN should be defined in the server's environment and the DSN's database should be on line.
</para>
  </refsect1>
  <refsect1 id="params_vd_remote_data_source"><title>Parameters</title>
    <refsect2><title>dsn</title>
      <para>The name of the remote datasource to prepare.</para></refsect2>
    <refsect2><title>connstr</title>
      <para>Currently ignored parameter.</para></refsect2>
    <refsect2><title>user</title>
      <para>username for the connection.</para></refsect2>
    <refsect2><title>password</title>
      <para>password for the user.</para></refsect2>
  </refsect1>
  <refsect1 id="ret_vd_remote_data_source"><title>Return Types</title><para>Status of the connection attempt.</para></refsect1>
  <refsect1 id="errors_vd_remote_data_source"><title>Errors</title>
    <table><title>Errors signalled by</title>
      <tgroup cols="4">
       <thead><row><entry>SQLState</entry><entry>Error Code</entry><entry>Error Text</entry><entry>Description</entry></row></thead>
	<tbody>
	  <row>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorcode></errorcode></entry>
	    <entry><errorname></errorname></entry>
	    <entry></entry>
	  </row>
	</tbody>
      </tgroup>
    </table>
  </refsect1>
  <refsect1 id="seealso_vd_remote_data_source"><title>See Also</title>
    <para><link linkend="fn_vd_remote_table">vd_remote_table</link></para>
    <para><link linkend="fn_vdd_disconnect_data_source">vdd_disconnect_data_source</link></para>
    <para><link linkend="MANSETRDS">Manually Setting Up A Remote Data Source</link></para>
  </refsect1>
</refentry>