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
|
<?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_name_part">
<refmeta>
<refentrytitle>name_part</refentrytitle>
<refmiscinfo>sql</refmiscinfo>
</refmeta>
<refnamediv>
<refname>name_part</refname>
<refpurpose>Returns portion of dotted name such as a fully qualified table name.</refpurpose>
</refnamediv>
<refsynopsisdiv>
<funcsynopsis id="fsyn_name_part">
<funcprototype id="fproto_name_part">
<funcdef>varchar <function>name_part</function></funcdef>
<paramdef>in <parameter>string</parameter> varchar</paramdef>
<paramdef>in <parameter>idx</parameter> integer</paramdef>
<paramdef>in <parameter>dstring</parameter> varchar</paramdef>
</funcprototype>
</funcsynopsis>
</refsynopsisdiv>
<refsect1 id="desc_name_part">
<title>Description</title>
<para>The <function>name_part()</function> can be used to dissecting parts of a three part names (string
where items are divided by dots ".") such as table names or columns names. The table
name "DB"."DBA"."SYS_USERS" contains three parts which can be extracted individually
using this function providing the correct index from a 0 base: 0 would return "DB",
1 would return "DBA", 2 would return "SYS_USERS".</para>
</refsect1>
<refsect1 id="params_name_part">
<title>Parameters</title>
<refsect2><title>string</title>
<para>The string to be disected.</para></refsect2>
<refsect2><title>idx</title>
<para>The part index starting from 0.</para></refsect2>
<refsect2><title>dstring</title>
<para>The default value if the found value is null.</para></refsect2>
</refsect1>
<refsect1 id="ret_name_part"><title>Return Types</title>
<para>A string will be returned containing the text from
the specified index.</para>
</refsect1>
<refsect1 id="errors_name_part">
<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>SR014</errorcode></entry>
<entry><errorname>Function name_part needs a string as argument 1, not an arg of type [type]</errorname></entry>
<entry></entry>
</row>
<row>
<entry><errorcode>22023</errorcode></entry>
<entry><errorcode>SR008</errorcode></entry>
<entry><errorname>Function name_part needs an integer as argument 2, not an arg of type [type]</errorname></entry>
<entry></entry>
</row>
</tbody>
</tgroup>
</table>
</refsect1>
<refsect1 id="examples_name_part">
<title>Examples</title>
<example id="ex_name_part"><title>Using the name_part() function</title>
<para>This simple example shows the 3 parts of a table name being retrieved
using the name_part() function from ISQL.</para>
<screen><![CDATA[
SQL> select name_part('"DB"."DBA"."SYS_TABLES"', 0);
callret
VARCHAR
__________________________________________________________
"DB"
1 Rows. -- 20 msec.
SQL> select name_part('"DB"."DBA"."SYS_TABLES"', 1);
callret
VARCHAR
__________________________________________________________
"DBA"
1 Rows. -- 30 msec.
SQL> select name_part('"DB"."DBA"."SYS_TABLES"', 2);
callret
VARCHAR
__________________________________________________________
SYS_TABLES"
1 Rows. -- 20 msec.
]]></screen>
</example>
</refsect1>
<!-- refsect1 id="seealso_name_part">
<title>See Also</title>
<para><link linkend="fn"><function></function></link></para>
</refsect1 -->
</refentry>
|