GetPathLocator (Transact-SQL)

THIS TOPIC APPLIES TO: yesSQL Server (starting with 2012)noAzure SQL DatabasenoAzure SQL Data Warehouse noParallel Data Warehouse

Returns the path locator ID value for the specified file or directory in a FileTable.

||
|-|
|Applies to: SQL Server ( SQL Server 2012 through current version).|

Syntax


GetPathLocator(filenamespace_path)  

Arguments

filenamespace_path
A namespace path in the FileTable. The namespace path is of type nvarchar(max).

When the database belongs to an Always On availability group, then the GetPathLocator function accepts the virtual network name (VNN) or the computer name.

Return Type

hierarchyid

General Remarks

For more information, see Work with Directories and Paths in FileTables.

Examples

You can use the GetPathLocator function when you are migrating files from a file server to a FileTable. In this scenario, you want to move the files into the FileTable, and then replace the original UNC path for each file with the FileTable UNC path. For a complete example, see Load Files into FileTables.

See Also

Work with Directories and Paths in FileTables