(SQL Server) SFTP Upload and Download to a StringBuilder Object

See more SFTP Examples

Demonstrates how to SFTP upload from a Chilkat StringBuilder object, and download into a StringBuilder object.

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

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

    -- Connect to the SSH server and then authenticate.
    DECLARE @port int
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, 'MY-SSH-SERVER-DOMAIN-OR-IP', @port
    IF @success = 1
      BEGIN
        EXEC sp_OAMethod @sftp, 'AuthenticatePw', @success OUT, 'MY-SSH-LOGIN', 'MY-SSH-PASSWORD'
        IF @success = 1
          BEGIN
            EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
          END
      END
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        RETURN
      END

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

    EXEC sp_OAMethod @sbA, 'LoadFile', @success OUT, 'qa_data/hamlet.xml', 'utf-8'

    -- Upload the contents of sbA to the SSH/SFTP server.
    DECLARE @bIncludeBOM int
    SELECT @bIncludeBOM = 0
    DECLARE @remotePath nvarchar(4000)
    SELECT @remotePath = 'sftpTesting/hamlet.xml'
    EXEC sp_OAMethod @sftp, 'UploadSb', @success OUT, @sbA, @remotePath, 'utf-8', @bIncludeBOM
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @sbA
        RETURN
      END

    -- Download the file..
    DECLARE @sbB int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbB OUT

    EXEC sp_OAMethod @sftp, 'DownloadSb', @success OUT, @remotePath, 'utf-8', @sbB
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sftp
        EXEC @hr = sp_OADestroy @sbA
        EXEC @hr = sp_OADestroy @sbB
        RETURN
      END

    -- Verify that sbA and sbB have the exact same contents.

    EXEC sp_OAGetProperty @sbA, 'Length', @iTmp0 OUT
    PRINT 'size of sbA: ' + @iTmp0
    DECLARE @bCaseSensitive int
    SELECT @bCaseSensitive = 1
    EXEC sp_OAMethod @sbA, 'ContentsEqualSb', @iTmp0 OUT, @sbB, @bCaseSensitive
    IF @iTmp0 = 1
      BEGIN

        PRINT 'Contents are equal. Success.'
      END
    ELSE
      BEGIN

        PRINT 'Contents are NOT equal.  Failed.'
      END

    EXEC sp_OAMethod @sftp, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @sftp
    EXEC @hr = sp_OADestroy @sbA
    EXEC @hr = sp_OADestroy @sbB


END
GO