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
|
<?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_quote_dotted">
<refmeta>
<refentrytitle>quote_dotted</refentrytitle>
<refmiscinfo>rmt</refmiscinfo>
</refmeta>
<refnamediv>
<refname>quote_dotted</refname>
<refpurpose>Returns an quoted identifier.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_quote_dotted">
<funcprototype id="fproto_quote_dotted">
<funcdef>varchar <function>quote_dotted</function></funcdef>
<paramdef>in <parameter>dsn</parameter> varchar</paramdef>
<paramdef>in <parameter>identifier</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_quote_dotted">
<title>Description</title>
<para>The <function>quote_dotted()</function> function will return the
identifier (table name or column name) appropriately quoted for the remote
data source. This function will obtain the appropriate quote characters
from the remote data source. This function can be used in conjunction with
rexecute function.</para>
</refsect1>
<refsect1 id="params_quote_dotted">
<title>Parameters</title>
<refsect2><title>dsn</title>
<para>The remote DSN name.</para></refsect2>
<refsect2><title>identifier</title>
<para>The string containing the identifier. The identifier can be a one,
two or three part name, separated with the dot, '.', character.</para></refsect2>
</refsect1>
<refsect1 id="ret_quote_dotted"><title>Return Types</title>
<para>A string will be returned containing the quoted identifier.</para>
</refsect1>
<refsect1 id="errors_quote_dotted">
<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>22023</errorcode></entry>
<entry><errorcode>VD011</errorcode></entry>
<entry><errorname>Supplied DSN [name] is not valid</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_quote_dotted">
<title>Examples</title>
<example id="ex_quote_dotted"><title>Using the quote_dotted() function</title>
<para>This simple example shows an identifier from a remote Oracle
data source being correctly quoted using the quote_dotted() function from ISQL.</para>
<screen><![CDATA[
SQL> select quote_dotted ('oracle', 'DEMO.EMP');
callret
VARCHAR
_______________________________________________________________________________
"DEMO"."EMP"
1 Rows. -- 2 msec.
]]></screen>
</example>
</refsect1>
<refsect1 id="seealso_quote_dotted"><title>See Also</title>
<para><link linkend="fn_rexecute"><function>rexecute()</function></link></para>
</refsect1>
</refentry>
|