ODBC guide

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.

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'
);