Lua

Write Text to a Remote SFTP File (Sequential)

Demonstrates the Chilkat SFtp.WriteFileText method, which encodes text using a charset and writes it at the current sequential write position of an open handle. The arguments are the handle, the charset, and the text.

Background: Chilkat tracks a write position per handle, so successive WriteFileText calls append naturally — the pattern for building a file a piece at a time, such as writing rows to a report. Opening with openOrCreate starts writing at the current end of the file. The charset determines the bytes actually stored, which matters whenever the text contains non-ASCII characters.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.WriteFileText method, which encodes text and writes it at the current
-- sequential write position of an open handle.  The 1st argument is the handle, the 2nd is the
-- charset, and the 3rd is the text.

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

-- Open (creating/truncating) the remote file for writing.
local handle = sftp:open_file("subdir/notes.txt", "writeOnly", "createTruncate")
if not sftp.last_method_success then
    print(sftp.last_error_text)
    return
end

-- Write text as UTF-8.  Successive writes continue from where the previous write ended.
success = sftp:write_file_text(handle, "utf-8", "First line.\n")
if not success then
    print(sftp.last_error_text)
    return
end

success = sftp:write_file_text(handle, "utf-8", "Second line.\n")
if not success then
    print(sftp.last_error_text)
    return
end

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

print("Wrote text file.")

sftp:disconnect()