Upload Text to an SFTP Server (StringBuilder)

See more SFTP Examples

Demonstrates the Chilkat SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads it to a remote file. The arguments are the StringBuilder, the remote file path, the charset, and whether to prepend a byte-order mark.

Note: This example uses relative local paths, which are resolved against the application's current working directory. Absolute local paths may also be used. Supply the paths appropriate to your own environment.

local chilkat = require("chilkat")

-- Demonstrates the SFtp.UploadSb method, which encodes the text in a StringBuilder and uploads
-- it to a remote file.  The 1st argument is the StringBuilder, the 2nd is the remote file path,
-- the 3rd is the charset, and the 4th selects whether a byte-order mark is prepended.

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

-- Build the text to upload.
local sb = chilkat.StringBuilder.new()
sb:append("name,quantity\n")
sb:append("widgets,42\n")
sb:append("gadgets,17\n")

-- Upload as UTF-8 without a byte-order mark.  If the remote file exists, it is truncated first.
local includeBom = false
success = sftp:upload_sb(sb, "subdir/inventory.csv", "utf-8", includeBom)
if not success then
    print(sftp.last_error_text)
    return
end

print("Uploaded text file.")

sftp:disconnect()