(SQL Server) Manage Cloud Storage Bucket Labels

See more Google Cloud Storage Examples

Demonstrates how to add, update, and delete labels for a Cloud Storage bucket.

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.

    -- This example uses a previously obtained access token having permission for the 
    -- scope "https://www.googleapis.com/auth/cloud-platform"

    -- In this example, Get Google Cloud Storage OAuth2 Access Token, 
    -- the service account access token was saved to a text file.  This example fetches the access token from the file..
    DECLARE @sbToken int
    -- Use "Chilkat_9_5_0.StringBuilder" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.StringBuilder', @sbToken OUT
    IF @hr <> 0
    BEGIN
        PRINT 'Failed to create ActiveX component'
        RETURN
    END

    DECLARE @success int
    EXEC sp_OAMethod @sbToken, 'LoadFile', @success OUT, 'qa_data/tokens/googleCloudStorageAccessToken.txt', 'utf-8'

    -- ---- Step 1
    -- Create the JSON body of the PATCH request that will be sent.
    -- This specifies labels to be added, updated, and/or deleted.
    -- (To delete a label, set its value equal to null.)

    -- {
    --   "labels": {
    --     "new_label_key": "new_label_value",
    --     "existing_label_key": "updated_label_value",
    --     "old_label_key": null
    --   }
    -- }

    -- ---------
    -- Important
    -- ---------
    -- You can apply multiple labels to each bucket, with a maximum of 64 labels per bucket.

    --     - Keys and values cannot be longer than 63 characters each.
    --     - Keys and values can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed.
    --     - Label keys must start with a lowercase letter and international characters are allowed.
    --     - Label keys cannot be empty.

    -- Build JSON to update labels.
    -- 
    -- During the testing of this example, my bucket already has the following labels:
    -- {
    --  "labels": {
    --   "test1": "xyz",
    --   "test": "abc",
    --   "a": "abc"
    --  }
    -- }

    -- For this example, I'm going to add a label "b", delete the label "test1", and update
    -- the label "test".
    DECLARE @json int
    -- Use "Chilkat_9_5_0.JsonObject" for versions of Chilkat < 10.0.0
    EXEC @hr = sp_OACreate 'Chilkat.JsonObject', @json OUT

    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels.b', 'bbb'
    EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'labels.test', 'abc123'
    EXEC sp_OAMethod @json, 'UpdateNull', @success OUT, 'labels.test1'

    -- ---- Step 2
    -- Send a PATCH equivalent to this curl command

    -- curl -X PATCH --data-binary @[JSON_FILE_NAME].json \
    --     -H "Authorization: Bearer [OAUTH2_TOKEN]" \
    --     -H "Content-Type: application/json" \
    --     "https://www.googleapis.com/storage/v1/b/[BUCKET_NAME]?fields=labels"

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

    EXEC sp_OAMethod @sbToken, 'GetAsString', @sTmp0 OUT
    EXEC sp_OASetProperty @http, 'AuthToken', @sTmp0

    EXEC sp_OAMethod @http, 'SetUrlVar', @success OUT, 'bucket_name', 'chilkat-ocean'
    DECLARE @url nvarchar(4000)
    SELECT @url = 'https://www.googleapis.com/storage/v1/b/{$bucket_name}?fields=labels'
    DECLARE @resp int
    EXEC sp_OAMethod @json, 'Emit', @sTmp0 OUT
    EXEC sp_OAMethod @http, 'PText', @resp OUT, 'PATCH', @url, @sTmp0, 'utf-8', 'application/json', 0, 0
    EXEC sp_OAGetProperty @http, 'LastMethodSuccess', @iTmp0 OUT
    IF @iTmp0 = 0
      BEGIN
        EXEC sp_OAGetProperty @http, 'LastErrorText', @sTmp0 OUT
        PRINT @sTmp0
        EXEC @hr = sp_OADestroy @sbToken
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    DECLARE @responseCode int
    EXEC sp_OAGetProperty @resp, 'StatusCode', @responseCode OUT
    IF @responseCode = 401
      BEGIN
        EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
        PRINT @sTmp0

        PRINT 'If invalid credentials, then it is likely the access token expired.'

        PRINT 'Your app should automatically fetch a new access token and re-try.'
        EXEC @hr = sp_OADestroy @resp

        EXEC @hr = sp_OADestroy @sbToken
        EXEC @hr = sp_OADestroy @json
        EXEC @hr = sp_OADestroy @http
        RETURN
      END

    -- Note: A 400 response code is likely caused by illegal characters used for a label name and/or value.


    PRINT 'Response code: ' + @responseCode

    PRINT 'Response body'
    EXEC sp_OAGetProperty @resp, 'BodyStr', @sTmp0 OUT
    PRINT @sTmp0

    -- A response code = 200 indicates success, and the response body contains the JSON
    -- for the new/updated set of labels
    -- Response code: 200
    -- Response body
    -- {
    --  "labels": {
    --   "test": "abc123",
    --   "a": "abc",
    --   "b": "bbb"
    --  }
    -- }

    EXEC @hr = sp_OADestroy @resp


    EXEC @hr = sp_OADestroy @sbToken
    EXEC @hr = sp_OADestroy @json
    EXEC @hr = sp_OADestroy @http


END
GO