SYSUIF.REPLACE_FILE | SQL Operators & User-Defined Functions | Teradata Vantage - 17.10 - SYSUIF.REPLACE_FILE - Advanced SQL Engine - Teradata Database

Teradata Vantage™ - SQL Operators and User-Defined Functions

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

The SYSUIF.REPLACE_FILE external stored procedure has the following definition:

SYSUIF.REPLACE_FILE (
    IN uif_name VARCHAR(128)NOT CASESPECIFIC CHARACTER SET UNICODE,
    IN uif_filename VARCHAR(256) CASESPECIFIC CHARACTER SET UNICODE,
    IN locspec VARCHAR(1024)CASESPECIFIC CHARACTER SET UNICODE,
    INoverride_lock int
);

Syntax Elements

uif_name
The SQL name associated with the user-installed file. It cannot have a database name associated with it, as the file is always installed in the current database.
The uif_name should be unique within a database.
The uif_name can be any valid Teradata identifier.
uif_filename
The name of file with the extension (if any). This can be any valid LINUX file name.
locspec
The location of the replacement file. The format is identical to the SYSUIF.INSTALL_FILE locspec parameter.
The first two characters of the locspec string specify whether the replacement archive file is on the client or on the database server. If the first two characters are:
  • CJ, then the external language script is on the client.
  • SJ, then the external language script is on the database server.
The third character of the locspec string is a delimiter that you choose to separate the first two characters from the remaining characters in the locspec string.
The remaining characters in the locspec string specify the file path.
If the external language script is on the:
  • client, then the file path is a client-interpreted path that specifies the location and name of the file.
  • database server, then the file path can be a full or relative path that specifies the location and name of the file.

    If the file path is relative, the full path to the file is formed by appending the relative path to the default path for source code on the server.

    To determine the default path for source code, use the -o option of the cufconfig utility and find the setting for the SourceDirectoryPath field:

         cufconfig -o

    For information on cufconfig, see Teradata Vantage™ - Database Utilities.

If the replacement file does not exist in the current database, the REPLACE_FILE creates and registers a new file with the database.
The new file is updated and distributed to all nodes. If a node is down, the pending file copy is recorded and copied as soon as the node comes back up.
override_lock
An integer value for the override lock.
If a script is being executed in the database where the file is being replaced, then all files in that database are locked with read-only access. REPLACE_FILE must wait until the script is executed and permission is granted to write the file. If override_lock is set to 1, then the file is replaced even if a script is being executed.
The value of override_lock is 1 or 0.