SQL Server

SFTP Read Directory Listing

See more SFTP Examples

Demonstrates how to download a directory listing and iterate over the files. SQL Server

-- 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)
    DECLARE @success int
    SELECT @success = 0

    -- This requires the Chilkat API to have been previously unlocked.
    -- See Global Unlock Sample for sample code.

    -- Important: It is helpful to send the contents of the
    -- sftp.LastErrorText property when requesting support.

    DECLARE @sftp int
    EXEC @hr = sp_OACreate 'Chilkat.SFtp', @sftp OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- Set some timeouts, in milliseconds:
    EXEC sp_OASetProperty @sftp, 'ConnectTimeoutMs', 5000
    EXEC sp_OASetProperty @sftp, 'IdleTimeoutMs', 10000

    -- Connect to the SSH server.  
    -- The standard SSH port = 22
    -- The hostname may be a hostname or IP address.
    DECLARE @hostname nvarchar(4000)
    SELECT @hostname = 'www.my-sftp-server.com'
    DECLARE @port int
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, @hostname, @port
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Authenticate with the SSH server.  Chilkat SFTP supports
    -- both password-based authenication as well as public-key
    -- authentication.  This example uses password authenication.
    EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- After authenticating, the SFTP subsystem must be initialized:
    EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Open a directory on the server...
    -- Paths starting with a slash are "absolute", and are relative 
    -- to the root of the file system. Names starting with any other 
    -- character are relative to the user's default directory (home directory).
    -- A path component of ".." refers to the parent directory, 
    -- and "." refers to the current directory. 
    DECLARE @handle nvarchar(4000)
    EXEC sp_OAMethod @sftp, 'OpenDir', @handle OUT, '.'
    EXEC sp_OAGetProperty @sftp, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

    -- Download the directory listing:

    DECLARE @dirListing int
    EXEC @hr = sp_OACreate 'Chilkat.SFtpDir', @dirListing OUT

    EXEC sp_OAMethod @sftp, 'ReadDirListing', @success OUT, @handle, @dirListing
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @dirListing
        RETURN
      END

    -- Close the handle for the directory listing.
    EXEC sp_OAMethod @sftp, 'CloseHandle', @success OUT, @handle
    IF @success = 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @dirListing
        RETURN
      END

    -- Iterate over the files.
    DECLARE @fileObj int
    EXEC @hr = sp_OACreate 'Chilkat.SFtpFile', @fileObj OUT

    DECLARE @i int
    SELECT @i = 0
    DECLARE @n int
    EXEC sp_OAGetProperty @dirListing, 'NumFilesAndDirs', @n OUT
    WHILE @i < @n
      BEGIN

        EXEC sp_OAMethod @dirListing, 'FileAt', @success OUT, @i, @fileObj
        IF @success = 0
          BEGIN
            EXEC sp_OAGetProperty @dirListing, 'LastErrorText', @sTmp0 OUT
            PRINT @sTmp0
            EXEC @hr = sp_OADestroy @sftp
            EXEC @hr = sp_OADestroy @dirListing
            EXEC @hr = sp_OADestroy @fileObj
            RETURN
          END

        EXEC sp_OAGetProperty @fileObj, 'Filename', @sTmp0 OUT
        PRINT @sTmp0
        EXEC sp_OAGetProperty @fileObj, 'FileType', @sTmp0 OUT
        PRINT @sTmp0

        EXEC sp_OAGetProperty @fileObj, 'Size32', @iTmp0 OUT
        PRINT 'Size in bytes: ' + @iTmp0

        PRINT '----'

        SELECT @i = @i + 1
      END


    PRINT 'Success.'

    EXEC @hr = sp_OADestroy @sftp
    EXEC @hr = sp_OADestroy @dirListing
    EXEC @hr = sp_OADestroy @fileObj


END
GO