FILE.LENGTH (U-SQL)

Article
03/10/2017

Summary

Returns the logical size in bytes of the file at the specified location at compile time.

Syntax

long? LENGTH(
    string path
).

Parameters

path
A constant-foldable string expression. path can be any supported file path Universal Resource Identifier (URI). If path is not constant-foldable, the error E_CSC_USER_EXPRESSIONNOTCONSTANTFOLDABLE is raised. If path is empty (null or the zero-length string), the error E_CSC_USER_EMPTYFILEPATH is raised. If path contains invalid characters, the error E_CSC_USER_INVALIDFILENAME is raised.

Return Value

long?
The logical size in bytes of path at compile time. Null if path does not exists, refers to a folder or the user has no access to it.

Examples

The example can be executed in Visual Studio with the Azure Data Lake Tools plug-in.
The example below uses the sample data provided with your Data Lake Analytics account. See Prepare source data for additional information.

DECLARE @filepath_good = "/Samples/Data/SearchLog.tsv";
DECLARE @filepath_bad = "/Samples/Data/zzz.tsv";
 
@result =
    SELECT  FILE.LENGTH(@filepath_good) AS length_good,
            FILE.LENGTH(@filepath_bad) AS length_bad
    FROM (VALUES (1)) AS T(dummy);
 
OUTPUT @result
TO "/Output/ReferenceGuide/BuiltInFunctions/SystemFunctions/FileLength.txt"
USING Outputters.Csv();

See Also