Lua

Rename or Move a Remote File or Directory

Demonstrates the Chilkat SFtp.RenameFileOrDir method, which renames or moves a remote file or directory. The first argument is the old path and the second is the new path.

Background: Rename and move are the same operation in SFTP: changing only the final path component renames in place, while changing the directory portion relocates the item. When source and destination are on the same filesystem the server does this as a fast metadata change rather than copying data, which is why moving even a large file is near-instant. Moving across filesystems, or onto an existing target, may fail depending on the server.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.RenameFileOrDir method, which renames or moves a remote file or
-- directory.  The 1st argument is the old path and the 2nd is the new path.

local sftp = chilkat.SFtp.new()

-- Connect, authenticate, and initialize the SFTP subsystem.
local port = 22
local success = sftp:connect("sftp.example.com", port)
if not success then
    print(sftp.last_error_text)
    return
end

-- Normally you would not hard-code the password in source.  You should instead obtain it
-- from an interactive prompt, environment variable, or a secrets vault.
local password = "mySshPassword"

success = sftp:authenticate_pw("mySshLogin", password)
if not success then
    print(sftp.last_error_text)
    return
end

success = sftp:initialize_sftp()
if not success then
    print(sftp.last_error_text)
    return
end

-- Rename a file within the same directory.
success = sftp:rename_file_or_dir("subdir/report.txt", "subdir/report_final.txt")
if not success then
    print(sftp.last_error_text)
    return
end

-- Because rename can also move, the same method relocates an item to a different directory.
success = sftp:rename_file_or_dir("subdir/report_final.txt", "archive/report_final.txt")
if not success then
    print(sftp.last_error_text)
    return
end

print("Renamed and moved.")

sftp:disconnect()