Rename a file or folder

Renames a file or folder. You can optionally move the item to a different folder or drive in the same operation. Placeholder functions (e.g. <<FUN_NOW>> or <<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>) are supported for dynamic target names.

Standard SQL query example

This is the base query accepted by the connector. To execute it in SQL Server, you have to pass it to the Data Gateway via a Linked Server. See how to accomplish this using the examples below.

SELECT *
FROM move_rename_item
WITH
(
    -- ##### SOURCE #####
    -- Source Drive
    , DriveId = 'me'
    -- OR use another user's / shared drive
    -- , DriveId = 'b!GtLN726LE0eXXXXXXXXXXXX'

    -- Item to rename (choose ONE)
    -- Path format: root:/path/to/item:
    , ItemId  = 'root:/myfile.pdf:'
	-- , ItemId  = 'root:/myfolder/myfile.pdf:'	
    -- , ItemId = '01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW'  -- by ID (preferred)

    -- ##### TARGET #####
    -- Target Drive (only required when moving across drives)
    -- , TargetDriveId = 'me'
    -- , TargetDriveId = 'b!0zqXLXXJh0uXXXXXXXXXXXXxxxxxxxxx'

    -- ##### TARGET FOLDER #####
    -- Optional: specify ONLY when renaming + moving
    -- Choose ONE format: Path OR Id

    -- , TargetType       = 'Path'
    -- , TargetFolderPath = '/myfolder/subfolder'	
    -- , TargetFolderPath = '/myfolder/export_<<yyyy-MM-dd,FUN_NOW>>'  -- folder must exist

    -- , TargetType     = 'Id'
    -- , TargetFolderId = '01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN'
    -- , TargetFolderId = 'root'

    -- ##### OPTIONS #####
    -- Required for rename
    , TargetItemName =
        'new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf'

    -- Required for large items or cross-drive moves (async)
    -- , Prefer = 'respond-async'
);

Using OPENQUERY in SQL Server

SELECT * FROM OPENQUERY([LS_TO_ONEDRIVE_IN_GATEWAY], 'SELECT *
FROM move_rename_item
WITH
(
    -- ##### SOURCE #####
    -- Source Drive
    , DriveId = ''me''
    -- OR use another user''s / shared drive
    -- , DriveId = ''b!GtLN726LE0eXXXXXXXXXXXX''

    -- Item to rename (choose ONE)
    -- Path format: root:/path/to/item:
    , ItemId  = ''root:/myfile.pdf:''
	-- , ItemId  = ''root:/myfolder/myfile.pdf:''	
    -- , ItemId = ''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''  -- by ID (preferred)

    -- ##### TARGET #####
    -- Target Drive (only required when moving across drives)
    -- , TargetDriveId = ''me''
    -- , TargetDriveId = ''b!0zqXLXXJh0uXXXXXXXXXXXXxxxxxxxxx''

    -- ##### TARGET FOLDER #####
    -- Optional: specify ONLY when renaming + moving
    -- Choose ONE format: Path OR Id

    -- , TargetType       = ''Path''
    -- , TargetFolderPath = ''/myfolder/subfolder''	
    -- , TargetFolderPath = ''/myfolder/export_<<yyyy-MM-dd,FUN_NOW>>''  -- folder must exist

    -- , TargetType     = ''Id''
    -- , TargetFolderId = ''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
    -- , TargetFolderId = ''root''

    -- ##### OPTIONS #####
    -- Required for rename
    , TargetItemName =
        ''new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf''

    -- Required for large items or cross-drive moves (async)
    -- , Prefer = ''respond-async''
);')

Using EXEC in SQL Server (handling larger SQL text)

The major drawback of OPENQUERY is its inability to incorporate variables within SQL statements. This often leads to the use of cumbersome dynamic SQL (with numerous ticks and escape characters).

Fortunately, starting with SQL 2005 and onwards, you can utilize the EXEC (your_sql) AT [LS_TO_ONEDRIVE_IN_GATEWAY] syntax.

DECLARE @MyQuery NVARCHAR(MAX) = 'SELECT *
FROM move_rename_item
WITH
(
    -- ##### SOURCE #####
    -- Source Drive
    , DriveId = ''me''
    -- OR use another user''s / shared drive
    -- , DriveId = ''b!GtLN726LE0eXXXXXXXXXXXX''

    -- Item to rename (choose ONE)
    -- Path format: root:/path/to/item:
    , ItemId  = ''root:/myfile.pdf:''
	-- , ItemId  = ''root:/myfolder/myfile.pdf:''	
    -- , ItemId = ''01R65QTTRARZ42C4BN6FF2WOH3AONX4GUW''  -- by ID (preferred)

    -- ##### TARGET #####
    -- Target Drive (only required when moving across drives)
    -- , TargetDriveId = ''me''
    -- , TargetDriveId = ''b!0zqXLXXJh0uXXXXXXXXXXXXxxxxxxxxx''

    -- ##### TARGET FOLDER #####
    -- Optional: specify ONLY when renaming + moving
    -- Choose ONE format: Path OR Id

    -- , TargetType       = ''Path''
    -- , TargetFolderPath = ''/myfolder/subfolder''	
    -- , TargetFolderPath = ''/myfolder/export_<<yyyy-MM-dd,FUN_NOW>>''  -- folder must exist

    -- , TargetType     = ''Id''
    -- , TargetFolderId = ''01R65QTTTBPH6V2AP36VD33CYYDXJSNHLN''
    -- , TargetFolderId = ''root''

    -- ##### OPTIONS #####
    -- Required for rename
    , TargetItemName =
        ''new_file_name_<<yyyy-MM-dd-HH-mm-ss-fff,FUN_NOW>>.pdf''

    -- Required for large items or cross-drive moves (async)
    -- , Prefer = ''respond-async''
);'
EXEC (@MyQuery) AT [LS_TO_ONEDRIVE_IN_GATEWAY]