(SQL Server) Setting Environment Variables for SCP Transfers

Demonstrates how to set remote environment variables for an SCP transfer.

Note 1: This example requires Chilkat v9.5.0.79 or greater.

Note 2: Setting environment variables for SCP is only supported by some SSH servers.

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
    -- 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 @ssh int
    -- Use "Chilkat_9_5_0.Ssh" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Ssh', @ssh OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    -- First connect to an SSH server.
    DECLARE @success int
    EXEC sp_OAMethod @ssh, 'Connect', @success OUT, 'example.com', 22
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- Wait a max of 5 seconds when reading responses..
    EXEC sp_OASetProperty @ssh, 'IdleTimeoutMs', 5000

    -- Authenticate..
    EXEC sp_OAMethod @ssh, 'AuthenticatePw', @success OUT, 'myLogin', 'myPassword'
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @ssh, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        RETURN
      END

    -- After the SSH object is connected and authenticated, we use it
    -- as the underlying transport in our SCP object.
    DECLARE @scp int
    -- Use "Chilkat_9_5_0.Scp" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.Scp', @scp OUT

    EXEC sp_OAMethod @scp, 'UseSsh', @success OUT, @ssh
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @scp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @scp
        RETURN
      END

    -- Specify the environment variables to be set in JSON as follows.
    -- This example sets two environment variables.  One is named "LCS_PASSWORD" and the other "MY_TEST_NAME".
    DECLARE @jsonEnvVars int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @jsonEnvVars OUT

    EXEC sp_OASetProperty @jsonEnvVars, 'EmitCompact', 0
    EXEC sp_OAMethod @jsonEnvVars, 'UpdateString', @success OUT, 'LCS_PASSWORD', 'secret'
    EXEC sp_OAMethod @jsonEnvVars, 'UpdateString', @success OUT, 'MY_TEST_NAME', 'abc'
    DECLARE @strEnvVars nvarchar(4000)
    EXEC sp_OAMethod @jsonEnvVars, 'Emit', @strEnvVars OUT


    PRINT @strEnvVars

    -- Setting the SendEnv property causes Chilkat to set each environment variable on the SSH server
    -- prior to doing the upload or download.
    EXEC sp_OASetProperty @scp, 'SendEnv', @strEnvVars

    -- Do the upload..
    DECLARE @remotePath nvarchar(4000)
    SELECT @remotePath = 'starfish.jpg'
    DECLARE @localPath nvarchar(4000)
    SELECT @localPath = 'qa_data/jpg/starfish.jpg'
    EXEC sp_OAMethod @scp, 'UploadFile', @success OUT, @localPath, @remotePath
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @scp, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @ssh
        EXEC @hr = sp_OADestroy @scp
        EXEC @hr = sp_OADestroy @jsonEnvVars
        RETURN
      END


    PRINT 'SCP upload file success.'

    -- Disconnect
    EXEC sp_OAMethod @ssh, 'Disconnect', NULL

    EXEC @hr = sp_OADestroy @ssh
    EXEC @hr = sp_OADestroy @scp
    EXEC @hr = sp_OADestroy @jsonEnvVars


END
GO