Categories:

File functions (AI Functions)

FL_IS_DOCUMENT

Checks if the input is a document FILE.

Syntax

Use one of the following:

FL_IS_DOCUMENT( <file_expression> )

FL_IS_DOCUMENT( <variant_expression> )

Arguments

file_expression

The argument must be an expression of type FILE.

variant_expression

The argument must be an OBJECT representing a FILE.

Returns

A BOOLEAN indicating whether the file is a document.

Examples

Example using an input FILE:

CREATE TABLE file_table(f FILE);
INSERT INTO file_table SELECT TO_FILE(BUILD_STAGE_FILE_URL('@mystage', 'image.png'));

SELECT FL_IS_DOCUMENT(f) FROM file_table;

+-------------------+
| FL_IS_DOCUMENT(F) |
|-------------------|
| False             |
+-------------------+

Example using an input OBJECT:

CREATE TABLE file_table(f OBJECT);
INSERT INTO file_table SELECT OBJECT_CONSTRUCT('STAGE', 'MYSTAGE', 'RELATIVE_PATH', 'document.pdf', 'ETAG', '<ETAG value>',
  'LAST_MODIFIED', 'Wed, 11 Dec 2024 20:24:00 GMT', 'SIZE', 105859, 'FILE_TYPE', 'application/pdf');

SELECT FL_IS_DOCUMENT(f) FROM file_table;

+-------------------+
| FL_IS_DOCUMENT(F) |
|-------------------|
| True              |
+-------------------+