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
|
<?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_sql_special_columns">
<refmeta>
<refentrytitle>sql_special_columns</refentrytitle>
<refmiscinfo>rmt</refmiscinfo>
</refmeta>
<refnamediv>
<refname>sql_special_columns</refname>
<refpurpose>get special column information from table on a remote DSN</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_sql_special_columns">
<funcprototype id="fproto_sql_special_columns">
<funcdef>vector <function>sql_special_columns</function></funcdef>
<paramdef>in <parameter>dsn</parameter> varchar</paramdef>
<paramdef>in <parameter>qualifier</parameter> varchar</paramdef>
<paramdef>in <parameter>owner</parameter> varchar</paramdef>
<paramdef>in <parameter>table_name</parameter> varchar</paramdef>
<paramdef>in <parameter>scope</parameter> integer</paramdef>
<paramdef>in <parameter>nullable</parameter> integer</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_special_columns"><title>Description</title>
<para>This function corresponds to the ODBC catalog call of similar name.
It and related functions are used by the virtual database to query
remote data dictionaries.</para>
<para>First argument of the ODBC SQLSpecialColumns is always SQL_BEST_ROWID.</para>
<para>The dsn argument must refer to a dsn previously defined by
<function>vd_remote_data_source()</function> or ATTACH TABLE.</para>
<para>For instance, the qualifier argument corresponds to the
szTableQualifier and cbTableQualifier arguments of an ODBC catalog
function. The SQL NULL value corresponds to the C NULL value.
The arguments can contain % signs, which are interpreted as in LIKE.</para>
</refsect1>
<refsect1 id="params_sql_special_columns">
<title>Parameters</title>
<para>As defined in ODBC API for the corresponding catalog call.</para>
</refsect1>
<refsect1 id="ret_sql_special_columns"><title>Return Types</title>
<para>As defined in ODBC API for the corresponding catalog call.</para>
<para>This function returns an array, with one element for each row of
the result set. Each row is represented as an array with one element for
each column.</para>
</refsect1>
<refsect1 id="examples_sql_special_columns">
<title>Examples</title>
<example id="ex_sql_special_columns"><title>Simple example</title>
<screen><![CDATA[
dbg_obj_print (sql_special_columns ('Local Virtuoso', 'Demo', 'demo', 'Orders', 0, 0));
->
(
(0ld "OrderID" 4 "INTEGER" 10 10 <DB NULL> 1 )
)
]]>
</screen></example>
</refsect1>
<refsect1 id="seealso_sql_special_columns">
<title>See Also</title>
<para><link linkend="fn_sql_data_sources"><function>sql_data_sources</function></link>,
<link linkend="fn_sql_columns"><function>sql_columns</function></link>
<link linkend="fn_sql_primary_keys"><function>sql_primary_keys</function></link>,
<link linkend="fn_sql_gettypeinfo"><function>sql_gettypeinfo</function></link>,
<link linkend="fn_sql_statistics"><function>sql_statistics</function></link>,
<link linkend="fn_sql_tables"><function>sql_tables</function></link>.</para>
</refsect1>
</refentry>
|
