17.10 - Include Name Clause - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL Data Definition Language Detailed Topics

Product
Advanced SQL Engine
Teradata Database
Release Number
17.10
Release Date
July 2021
Content Type
Programming Reference
Publication ID
B035-1184-171K
Language
English (United States)

The Include Name clause specifies an explicit path to an include file that is to be used for this UDF definition.

The syntax for this clause is as follows.

    CI¡name_on_server¡include_name

or

    SI¡name_on_server¡include_name

The character ¡ represents a user-defined delimiter.

Perform the following procedure for specifying an include file name string.

  1. Begin the clause with the appropriate client or platform location code.
    IF you specify this code … THEN the source or object code for the function is stored on the …
    C client.
    S server.
  2. Type the character I to indicate this is an include file specification.
  3. Specify an arbitrary delimiter character to separate the I code and the name_on_server variable specified in the string.
  4. Specify the name assigned to the include file, without the .h extension, on the server. The server adds the .h extension.

    All names on server must be unique among the UDFs and external procedures created within the same database. If the CREATE/REPLACE FUNCTION definition includes a nonunique name_on_server specification, the system does not create it.

    The C or C++ source must have an include statement in the following form:

          #include <name_on_server.h>

  5. Specify your delimiter character to separate the name_on_server from the include_name.
  6. Specify the path and name of the include file.
    IF the include file is on the … THEN you …
    client must format the specification in the form required by the client application, for example, BTEQ.

    Refer to the appropriate client documentation for information about the required form of presentation.

    server can use either the SOLIDUS character (/) or the REVERSE SOLIDUS character (\) as the separator in the path specification for all platform operating systems.