Lua

Create a Hard Link on an SFTP Server

Demonstrates the Chilkat SFtp.HardLink method, which creates a hard link to an existing remote file. The first argument is the existing file and the second is the new link path. It uses the OpenSSH hardlink@openssh.com extension and succeeds only when the server supports it.

Background: A hard link is a second name for the same file data, not a pointer to a path: both names are equal, the data persists until the last name is removed, and there is no "original" to break. Unlike a symbolic link it cannot span filesystems and cannot target a directory. Because it depends on a non-standard OpenSSH extension, expect it to fail against servers that do not implement it.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.HardLink method, which creates a hard link to an existing remote file.
-- The 1st argument is the existing file and the 2nd is the new link 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

-- Create a hard link.  This uses the OpenSSH hardlink@openssh.com extension and succeeds only
-- when the server supports it.
success = sftp:hard_link("subdir/data.bin", "subdir/data_backup.bin")
if not success then
    print(sftp.last_error_text)
    return
end

print("Hard link created.")

sftp:disconnect()