analytics/configuration/functions/TeradataTree.xml

<?xml version="1.0" encoding="UTF-8"?>
<!--
    Licensed Materials - Property of IBM
    BI and PM: QECL
    (C) Copyright IBM Corp. 2005, 2017
    US Government Users Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.
-->
<functionsRoot xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="FuncTree.xsd">
	<group>
		<id>vendor_group</id>
		<group>
			<id>Teradata</id>
			<context>tabular</context>
			<context>crosstab</context>
			<vendor>V_Teradata</vendor>
			<interface>TD</interface>
			<interface>JD-TD</interface>
			<interface>TD25</interface>
			<interface>OD</interface>
			<interface>OD25</interface>
			<mayBeSupportedByAnotherInterface/>
			<literal>
				<id>tdf_account</id>
				<name>account</name>
				<dropText>{account}</dropText>
			</literal>
			<function>
				<id>tdf_add_months</id>
				<name>add_months</name>
				<canonical>add_months</canonical>
				<formatType><![CDATA[@1]]></formatType>
				<returnType>@1</returnType>
				<parameter>
					<type>date</type>
					<type>dateTime</type>
				</parameter>
				<parameter>
					<type>integer</type>
				</parameter>
			</function>
			<function>
				<id>tdf_bytes</id>
				<name>bytes</name>
				<canonical>bytes</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_case_n</id>
				<name>case_n</name>
				<canonical>case_n</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
			</function>
			<function>
				<id>tdf_char2hexint</id>
				<name>char2hexint</name>
				<canonical>char2hexint</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_characters</id>
				<name>characters</name>
				<canonical>characters</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<!---  the coalesce function is implemented in common function, hence it is removed -->
			<!--function>
				<id>tdf_coalesce</id>
				<canonical>coalesce</canonical>
				<returnType>@1</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
				<parameter>
					<type>anyValueDatatype</type>
					<optional>true</optional>
				</parameter>
			</function-->
			<literal>
				<id>tdf_database</id>
				<name>database</name>
				<dropText>{database}</dropText>
			</literal>
			<literal>
				<id>tdf_date</id>
				<name>date</name>
				<dropText>{date}</dropText>
			</literal>
			<function>
				<id>tdf_format</id>
				<name>format</name>
				<canonical>format</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
			</function>
			<function>
				<id>tdf_index</id>
				<name>index</name>
				<canonical>index</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_log</id>
				<name>log</name>
				<canonical>log</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<function>
				<id>tdf_month</id>
				<hidden/>
				<name>month</name>
				<canonical>month</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>date</type>
					<type>dateTime</type>
				</parameter>
			</function>
			<function>
				<id>tdf_nullif</id>
				<name>nullif</name>
				<canonical>nullif</canonical>
				<formatType><![CDATA[@1]]></formatType>
				<returnType>@1</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
			</function>
			<function>
				<id>tdf_nullifzero</id>
				<name>nullifzero</name>
				<canonical>nullifzero</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<literal>
				<id>tdf_profile</id>
				<name>profile</name>
				<dropText>{profile}</dropText>
			</literal>
			<function>
				<id>tdf_random</id>
				<name>random</name>
				<canonical>random</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<function>
				<id>tdf_range_n</id>
				<!-- This function won't pass the CQE grammar therefore it is marked as hidden.-->
				<hidden/>
				<name>range_n</name>
				<canonical>range_n</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
			</function>
			<literal>
				<id>tdf_role</id>
				<name>role</name>
				<dropText>{role}</dropText>
			</literal>
			<literal>
				<id>tdf_session</id>
				<name>session</name>
				<dropText>{session}</dropText>
			</literal>
			<function>
				<id>tdf_soundex</id>
				<name>soundex</name>
				<canonical>soundex</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_substr</id>
				<name>substr</name>
				<canonical>substr</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>integer</type>
				</parameter>
				<parameter>
					<type>integer</type>
					<optional>true</optional>
				</parameter>
			</function>
			<literal>
				<id>tdf_time</id>
				<name>time</name>
				<dropText>{time}</dropText>
			</literal>
			<function>
				<id>tdf_type</id>
				<name>type</name>
				<canonical>type</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>anyValueDatatype</type>
				</parameter>
			</function>
			<literal>
				<id>tdf_user</id>
				<name>user</name>
				<dropText>{user}</dropText>
			</literal>
			<function>
				<id>tdf_vargraphic</id>
				<name>vargraphic</name>
				<canonical>vargraphic</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_year</id>
				<hidden/>
				<name>year</name>
				<canonical>year</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat useGrouping=&amp;quot;false&amp;quot;/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>integer</returnType>
				<parameter>
					<type>date</type>
					<type>dateTime</type>
				</parameter>
			</function>
			<function>
				<id>tdf_zeroifnull</id>
				<name>zeroifnull</name>
				<canonical>zeroifnull</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<group>
				<id>td_trig</id>
				<!--Teradata Trigonometry Functions-->
				<function>
					<id>tdf_acos</id>
					<name>acos</name>
					<canonical>acos</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_acosh</id>
					<name>acosh</name>
					<canonical>acosh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_asin</id>
					<name>asin</name>
					<canonical>asin</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_asinh</id>
					<name>asinh</name>
					<canonical>asinh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_atan</id>
					<name>atan</name>
					<canonical>atan</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_atan2</id>
					<name>atan2</name>
					<canonical>atan2</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_atanh</id>
					<name>atanh</name>
					<canonical>atanh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_cos</id>
					<name>cos</name>
					<canonical>cos</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_cosh</id>
					<name>cosh</name>
					<canonical>cosh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_sin</id>
					<name>sin</name>
					<canonical>sin</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_sinh</id>
					<name>sinh</name>
					<canonical>sinh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_tan</id>
					<name>tan</name>
					<canonical>tan</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
				<function>
					<id>tdf_tanh</id>
					<name>tanh</name>
					<canonical>tanh</canonical>
					<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
					<returnType>numeric</returnType>
					<usage>fact</usage>
					<parameter>
						<type>numeric</type>
					</parameter>
				</function>
			</group>
			<!-- The following section lists all the ODBC functions supported by Teradata.  The syntax for ODBC functions is "{fn function(…)}".  -->
			<!-- However when running ODBC functions against Teradata, the ODBC syntax is not required.  Teradata is smart enough to push those functions directly to the database server.  -->
			<!-- Therefore, those functions are marked as hidden. This means that the functions will not be exposed to the user. -->
			<!-- Note that no tip and syntax have been added in TeradataStrings_en.xml since those functions are marked as hidden.  -->
			<function>
				<id>tdf_char</id>
				<hidden/>
				<name>char</name>
				<canonical>char</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<function>
				<id>tdf_char_length</id>
				<hidden/>
				<name>char_length</name>
				<canonical>char_length</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_concat</id>
				<hidden/>
				<name>concat</name>
				<canonical>concat</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_dayofweek</id>
				<hidden/>
				<name>dayofweek</name>
				<canonical>dayofweek</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>date</type>
				</parameter>
			</function>
			<function>
				<id>tdf_dayofyear</id>
				<hidden/>
				<name>dayofyear</name>
				<canonical>dayofyear</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>date</type>
				</parameter>
			</function>
			<function>
				<id>tdf_degrees</id>
				<hidden/>
				<name>degrees</name>
				<canonical>degrees</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<usage>fact</usage>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<function>
				<id>tdf_left</id>
				<hidden/>
				<name>left</name>
				<canonical>left</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>integer</type>
				</parameter>
			</function>
			<function>
				<id>tdf_length</id>
				<hidden/>
				<name>length</name>
				<canonical>length</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_locate</id>
				<hidden/>
				<name>locate</name>
				<canonical>locate</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>string</type>
				</parameter>
				<parameter>
					<type>integer</type>
					<optional>true</optional>
				</parameter>
			</function>
			<function>
				<id>tdf_ltrim</id>
				<hidden/>
				<name>ltrim</name>
				<canonical>ltrim</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
			<function>
				<id>tdf_monthname</id>
				<hidden/>
				<name>monthname</name>
				<canonical>monthname</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>date</type>
				</parameter>
			</function>
			<!--// This function has no argument but requires parentheses, e.g pi()-->
			<function>
				<id>tdf_pi</id>
				<hidden/>
				<name>pi</name>
				<canonical>pi</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
			</function>
			<function>
				<id>tdf_radians</id>
				<hidden/>
				<name>radians</name>
				<canonical>radians</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;numberFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>numeric</returnType>
				<parameter>
					<type>numeric</type>
				</parameter>
			</function>
			<function>
				<id>tdf_ucase</id>
				<hidden/>
				<name>ucase</name>
				<canonical>ucase</canonical>
				<formatType><![CDATA[&amp;lt;formatGroup&amp;gt;&amp;lt;stringFormat/&amp;gt;&amp;lt;/formatGroup&amp;gt;]]></formatType>
				<returnType>string</returnType>
				<parameter>
					<type>string</type>
				</parameter>
			</function>
		</group>
	</group>
</functionsRoot>