SFTP Read Text File to String

Demonstrates how to download a text file from an SSH server directly into a string variable.

Download Chilkat SSH / SFTP ActiveX

CREATE PROCEDURE ChilkatSample
AS
BEGIN
    DECLARE @hr int
    DECLARE @sTmp0 nvarchar(4000)
    --  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

    --  Any string automatically begins a fully-functional 30-day trial.
    DECLARE @success int

    EXEC sp_OAMethod @sftp, 'UnlockComponent', @success OUT, 'Anything for 30-day trial'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

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

    --  Connect to the SSH server.
    --  The standard SSH port = 22
    --  The hostname may be a hostname or IP address.
    DECLARE @port int

    DECLARE @hostname nvarchar(4000)

    SELECT @hostname = 'www.my-ssh-server.com'
    SELECT @port = 22
    EXEC sp_OAMethod @sftp, 'Connect', @success OUT, @hostname, @port
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        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 <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  After authenticating, the SFTP subsystem must be initialized:
    EXEC sp_OAMethod @sftp, 'InitializeSftp', @success OUT
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Open a file on the server:
    DECLARE @handle nvarchar(4000)

    EXEC sp_OAMethod @sftp, 'OpenFile', @handle OUT, 'hamlet.xml', 'readOnly', 'openExisting'
    IF @handle Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  Get the total size of this file (in bytes)
    DECLARE @bFollowLinks int

    SELECT @bFollowLinks = 0
    DECLARE @bIsHandle int

    SELECT @bIsHandle = 1
    DECLARE @numBytes int

    --  bFollowLinks is ignored because we are passing a handle
    --  and not a remote filename.
    --  There are atlernative methods for handling file sizes
    --  greater than 32-bit.  (See the reference documentation.)
    EXEC sp_OAMethod @sftp, 'GetFileSize32', @numBytes OUT, @handle, @bFollowLinks, @bIsHandle
    IF @numBytes < 0
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    --  The charset indicates the character encoding of the text
    --  file on the SSH server.   Setting the charset correctly
    --  allows the Chilkat SFTP component to correctly interpret
    --  the bytes that represent the characters.
    DECLARE @charset nvarchar(4000)

    SELECT @charset = 'ansi'
    DECLARE @offset32 int

    SELECT @offset32 = 0
    DECLARE @fileContents nvarchar(4000)

    EXEC sp_OAMethod @sftp, 'ReadFileText32', @fileContents OUT, @handle, @offset32, @numBytes, @charset
    IF @fileContents Is NULL 
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END
    ELSE
      BEGIN

        PRINT 'Received file:'

        PRINT @fileContents
      END

    --  Close the file.
    EXEC sp_OAMethod @sftp, 'CloseHandle', @success OUT, @handle
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @sftp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        RETURN
      END

    PRINT 'Success.'
END
GO