Lua

Rename or Move a Remote FTP File

Demonstrates the Chilkat Ftp2.RenameRemoteFile method, which renames or moves a remote file or directory using the FTP RNFR/RNTO sequence. The first argument is the existing path and the second is the new path.

Background: Rename and move are the same RNFR/RNTO operation: changing only the final path component renames in place, while including directory components in the new path relocates the item within the same server. It is a metadata operation, so even a large file moves instantly — but both paths must be on the same server, and moving onto an existing target may fail depending on the server.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the Ftp2.RenameRemoteFile method, which renames or moves a remote file or
-- directory using the FTP RNFR/RNTO sequence.  The 1st argument is the existing path and the 2nd
-- is the new path.

local ftp = chilkat.Ftp2.new()

ftp.hostname = "ftp.example.com"
ftp.username = "myFtpLogin"

-- 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.
ftp.password = "myPassword"

local success = ftp:connect()
if not success then
    print(ftp.last_error_text)
    return
end

success = ftp:change_remote_dir("public_html")
if not success then
    print(ftp.last_error_text)
    return
end

-- Rename a file in place.
success = ftp:rename_remote_file("report.pdf", "report_final.pdf")
if not success then
    print(ftp.last_error_text)
    return
end

-- Include directory components in the new path to move the item within the same server.
success = ftp:rename_remote_file("report_final.pdf", "archive/report_final.pdf")
if not success then
    print(ftp.last_error_text)
    return
end

print("Renamed and moved.")

success = ftp:disconnect()
if not success then
    print(ftp.last_error_text)
    return
end