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.

Returns

LONG BINARY

Remarks

The value returned by the READ_CLIENT_FILE function 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:

Standards and compatibility
  • SQL/2003   Vendor extension.

See also