(SQL Server) REST Asynchronous Streaming Upload File

See more REST Examples

Demonstrates how to asynchronous streaming upload a file to cloud storage. This particular example demonstrates an upload to the Azure Cloud Storage service. The same concepts apply to S3, Google Cloud, and Google Drive.

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

    -- Connect to the Azure Storage Blob Service
    DECLARE @bTls int
    SELECT @bTls = 1
    DECLARE @port int
    SELECT @port = 443
    DECLARE @bAutoReconnect int
    SELECT @bAutoReconnect = 1
    -- In this example, the storage account name is "chilkat".
    DECLARE @success int
    EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'chilkat.blob.core.windows.net', @port, @bTls, @bAutoReconnect
    IF @success <> 1
      BEGIN
        EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @rest
        RETURN
      END

    -- Provide Azure Cloud credentials for the REST call.
    DECLARE @azAuth int
    -- Use "Chilkat_9_5_0.AuthAzureStorage" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.AuthAzureStorage', @azAuth OUT

    EXEC sp_OASetProperty @azAuth, 'AccessKey', 'AZURE_ACCESS_KEY'
    -- The account name used here should match the 1st part of the domain passed in the call to Connect (above).
    EXEC sp_OASetProperty @azAuth, 'Account', 'chilkat'
    EXEC sp_OASetProperty @azAuth, 'Scheme', 'SharedKey'
    EXEC sp_OASetProperty @azAuth, 'Service', 'Blob'
    -- This causes the "x-ms-version: 2021-08-06" header to be automatically added.
    EXEC sp_OASetProperty @azAuth, 'XMsVersion', '2021-08-06'
    EXEC sp_OAMethod @rest, 'SetAuthAzureStorage', @success OUT, @azAuth

    -- Set some request headers.
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'x-ms-blob-content-disposition', 'attachment; filename="thisIsATest.txt"'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'x-ms-blob-type', 'BlockBlob'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'x-ms-meta-m1', 'v1'
    EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'x-ms-meta-m2', 'v2'

    -- Note: The application does not need to explicitly set the following
    -- headers: x-ms-date, Authorization, and Content-Length.  These headers
    -- are automatically set by Chilkat.

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

    -- Define the source data for the stream to be a file.
    EXEC sp_OASetProperty @sendStream, 'SourceFile', 'qa_data/hamlet.xml'

    -- Create a background thread task to upload from the stream
    -- The name of the Azure storage container is "test".
    DECLARE @task int
    EXEC sp_OAMethod @rest, 'FullRequestStreamAsync', @task OUT, 'PUT', '/test/thisIsATest.txt', @sendStream

    -- Start the task. 
    EXEC sp_OAMethod @task, 'Run', @success OUT

    -- In this example, we'll simply sleep and periodically
    -- check to see if the REST upload if finished.
    DECLARE @curPctDone int
    SELECT @curPctDone = 0
    EXEC sp_OAGetProperty @task, 'Finished', @iTmp0 OUT
    WHILE @iTmp0 <> 1
      BEGIN
        EXEC sp_OAMethod @task, 'SleepMs', NULL, 100
      END

    -- Check to see if the call to FullRequestStream in the background thread pool succeeded.
    EXEC sp_OAGetProperty @task, 'TaskSuccess', @iTmp0 OUT
    IF @iTmp0 <> 1
      BEGIN
        -- Show what would've been the LastErrorText had FullRequestStream been called synchronously
        EXEC sp_OAGetProperty @task, 'ResultErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @task

        EXEC @hr = sp_OADestroy @rest
        EXEC @hr = sp_OADestroy @azAuth
        EXEC @hr = sp_OADestroy @sendStream
        RETURN
      END

    DECLARE @responseStatusCode int
    EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @responseStatusCode OUT

    -- When successful, the Azure Storage service will respond with a 201 response code,
    -- with an empty body.  Therefore, in the success condition, the responseStr is empty.
    IF @responseStatusCode = 201
      BEGIN

        PRINT 'File uploaded.'
      END
    ELSE
      BEGIN
        -- It failed, so examine the response body, if one was returned:
        -- Given that FullRequestStream returns a string, the return value is obtained via GetResultString.
        DECLARE @responseBodyStr nvarchar(4000)
        EXEC sp_OAMethod @task, 'GetResultString', @responseBodyStr OUT

        PRINT 'response body (if any): ' + @responseBodyStr

        -- Examine the request/response to see what happened.

        EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @iTmp0 OUT
        PRINT 'response status code = ' + @iTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseStatusText', @sTmp0 OUT
        PRINT 'response status text = ' + @sTmp0

        EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
        PRINT 'response header: ' + @sTmp0

        PRINT '---'

        EXEC sp_OAGetProperty @rest, 'LastRequestStartLine', @sTmp0 OUT
        PRINT 'LastRequestStartLine: ' + @sTmp0

        EXEC sp_OAGetProperty @rest, 'LastRequestHeader', @sTmp0 OUT
        PRINT 'LastRequestHeader: ' + @sTmp0
      END

    EXEC @hr = sp_OADestroy @task


    EXEC @hr = sp_OADestroy @rest
    EXEC @hr = sp_OADestroy @azAuth
    EXEC @hr = sp_OADestroy @sendStream


END
GO