READ_CLIENT_FILE function [String]

Reads data from the specified file on the client computer.

Syntax

READ_CLIENT_FILE( client-filename-expression )

Parameters

client-filename-expression CHAR value indicating the name of the file on the client computer. The path is resolved on the client computer relative to the current working directory of the client application.

Remarks

The READ_CLIENT_FILE function returns a LONG BINARY value that represents the contents of the specified client file. You can use the function in syntax wherever a BINARY expression is allowed.

Since the data returns as a binary string, if the data is in another character set, or is compressed, or is encrypted, you may also need to perform character set conversion, decompression, or decryption on it.

During evaluation of READ_CLIENT_FILE, the database server initiates the transfer of the specified file from the client. The client, upon receiving the transfer request, obtains a shared lock on the client file, and holds the lock until the database server requests the client to terminate the request.

Reading of the file is performed by the client software library, and the transfer of data is done using the command sequence communication protocol.

Permissions

When reading from a file on a client computer:

READCLIENTFILE authority is required. See READCLIENTFILE authority.
Read permissions are required on the directory being read from.
The allow_read_client_file database option must be enabled. See allow_read_client_file option [database].
The read_client_file secured feature must be enabled. See -sf server option.

Standards and compatibility

SQL/2003 Vendor extension.