(SQL Server) SFTP SyncTreeDownload - Find out what files were downloaded

See more SFTP Examples

Demonstrates how to find out which files were downloaded in a SyncTreeDownload method call.

Chilkat ActiveX Downloads ActiveX for 32-bit and 64-bit Windows

-- Important: See this note about string length limitations for strings returned by sp_OAMethod calls.
--
CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @iTmp0 int
    -- Important: Do not use nvarchar(max).  See the warning about using nvarchar(max).
    DECLARE @sTmp0 nvarchar(4000)
    -- This example requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    DECLARE @sftp int
    -- Use "Chilkat_9_5_0.SFtp" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.SFtp', @sftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'my-ssh-server.com', 22
    IF @success = 1
      BEGIN
        EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'mySshLogin', 'mySshPassword'
      END
    IF @success = 1
      BEGIN
        EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
      END
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Synchronize the remote directory tree rooted at "syncDownloadTest/xml"
    -- with the local directory tree rooted at "qa_output"
    -- Both directories are relative paths.  The remote directory
    -- is relative to the HOME directory of the SSH user account.
    -- The local directory is relative to the current working directory of the process.
    -- It is also possible to use absolute paths.

    DECLARE @remoteDir nvarchar(4000)
    SELECT @remoteDir = 'syncDownloadTest'
    DECLARE @localDir nvarchar(4000)
    SELECT @localDir = 'qa_output'

    -- Possible modes that can be passed to the SyncTreeDownload method are:
    -- mode=0: Download all files
    -- mode=1: Download all files that do not exist on the local filesystem.
    -- mode=2: Download newer or non-existant files.
    -- mode=3: Download only newer files. If a file does not already exist on the local filesystem, it is not downloaded from the server.
    -- mode=5: Download only missing files or files with size differences.
    -- mode=6: Same as mode 5, but also download newer files.
    -- mode=99: Do not download files, but instead delete remote files that do not exist locally.

    -- This example will use mode 6 to download missing, newer, or files with size differences.
    DECLARE @mode int
    SELECT @mode = 6
    -- This example will turn on recursion to synchronize the entire tree. 
    -- Recursion can be turned off to synchronize the files of a single directory.
    DECLARE @recursive int
    SELECT @recursive = 1
    EXEC sp_OAMethod @sftp, 'SyncTreeDownload', @success OUT, @remoteDir, @localDir, @mode, @recursive
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Examine the list of downloaded files.
    -- The downloaded files are listed one per line in the SyncedFiles property.
    -- Local directories that were created will be listed with a trailing "/" char.
    DECLARE @fileList nvarchar(4000)
    EXEC sp_OAGetProperty @sftp, 'SyncedFiles', @fileList OUT

    PRINT @fileList

    PRINT ''

    -- For example:

    -- data/
    -- chiliPepper.gif
    -- helloWorld.pdf
    -- alice.key
    -- anter_cert.pem
    -- text/
    -- accentedLatin1.txt
    -- accentedUtf8.txt
    -- abc/
    -- abc/chiliPepper.gif
    -- abc/ghk/
    -- text/something/
    -- text/PolishEmailBody.txt
    -- text/frenchUtf8.txt
    -- text/helloWorld.txt
    -- data/chiliPepper.gif
    -- data/xyz/
    -- data/xyz/dkimHtmlBody.txt
    -- data/xyz/emailForCreateDsn.eml
    -- data/xyz/dkimVerifyTest.eml

    -- You could load the strings into a Chilkat string table..
    DECLARE @sb int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sb OUT

    EXEC sp_OAMethod @sb, 'Append', @success OUT, @fileList

    DECLARE @st int
    -- Use "Chilkat_9_5_0.StringTable" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringTable', @st OUT

    EXEC sp_OAMethod @st, 'AppendFromSb', @success OUT, @sb

    -- Find out how many files + dirs

    EXEC sp_OAGetProperty @st, 'Count', @iTmp0 OUT
    PRINT 'Total count = ' + @iTmp0

    DECLARE @i int
    SELECT @i = 0
    EXEC sp_OAGetProperty @st, 'Count', @iTmp0 OUT
    WHILE @i < @iTmp0
      BEGIN
        EXEC sp_OAMethod @st, 'StringAt', @sTmp0 OUT, @i
        PRINT @sTmp0
        SELECT @i = @i + 1
      END


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @sftp
    EXEC @hr = sp_OADestroy @sb
    EXEC @hr = sp_OADestroy @st


END
GO