Lua

Clear the SFTP Session Log

Demonstrates the Chilkat SFtp.ClearSessionLog method, which clears the in-memory text stored in the SessionLog property. It takes no arguments.

Background: With session logging enabled, the SessionLog accumulates a running record of the session's activity that is invaluable for diagnosing a failed transfer. Over a long-lived session that log grows unbounded, so clearing it frees memory — and, more usefully, lets you capture the log for one specific operation in isolation by clearing it just before and reading it just after.

Chilkat Lua Downloads

Download Chilkat for Lua

Lua

local chilkat = require("chilkat")

-- Demonstrates the SFtp.ClearSessionLog method, which clears the in-memory text stored in the
-- SessionLog property.  It takes no arguments.

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

-- When KeepSessionLog is enabled, the SessionLog property accumulates a record of the session's
-- activity, which is useful for debugging.
sftp.keep_session_log = true

-- ... perform operations ...

-- Clear the accumulated log, for example before starting a new logical operation whose log you
-- want to capture in isolation.
sftp:clear_session_log()
print("Session log cleared.")

sftp:disconnect()