DescribeTable SQL Server Example
CREATE PROCEDURE ChilkatSample
AS
BEGIN
DECLARE @hr int
DECLARE @iTmp0 int
DECLARE @sTmp0 nvarchar(max)
-- This example requires the Chilkat API to have been previously unlocked.
-- See Global Unlock Sample for sample code.
DECLARE @rest int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.Rest', @rest OUT
IF @hr <> 0
BEGIN
PRINT 'Failed to create ActiveX component'
RETURN
END
DECLARE @success int
DECLARE @authAws int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.AuthAws', @authAws OUT
EXEC sp_OASetProperty @authAws, 'AccessKey', 'AWS_ACCESS_KEY'
EXEC sp_OASetProperty @authAws, 'SecretKey', 'AWS_SECRET_KEY'
-- Don't forget to change the region to your particular region. (Also make the same change in the call to Connect below.)
EXEC sp_OASetProperty @authAws, 'Region', 'us-west-2'
EXEC sp_OASetProperty @authAws, 'ServiceName', 'redshift-data'
-- SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
EXEC sp_OAMethod @rest, 'SetAuthAws', @success OUT, @authAws
-- URL: https://redshift-data.us-west-2.amazonaws.com/
-- Use the same region as specified above.
EXEC sp_OAMethod @rest, 'Connect', @success OUT, 'redshift-data.us-west-2.amazonaws.com', 443, 1, 1
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @rest, 'ConnectFailReason', @iTmp0 OUT
PRINT 'ConnectFailReason: ' + @iTmp0
EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @authAws
RETURN
END
-- The following code creates the JSON request body.
-- The JSON created by this code is shown below.
-- Use this online tool to generate code from sample JSON:
-- Generate Code to Create JSON
DECLARE @json int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @json OUT
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ClusterIdentifier', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'ConnectedDatabase', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Database', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'DbUser', 'string'
EXEC sp_OAMethod @json, 'UpdateInt', @success OUT, 'MaxResults', 123
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'NextToken', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Schema', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'SecretArn', 'string'
EXEC sp_OAMethod @json, 'UpdateString', @success OUT, 'Table', 'string'
-- The JSON request body created by the above code:
-- {
-- "ClusterIdentifier": "string",
-- "ConnectedDatabase": "string",
-- "Database": "string",
-- "DbUser": "string",
-- "MaxResults": number,
-- "NextToken": "string",
-- "Schema": "string",
-- "SecretArn": "string",
-- "Table": "string"
-- }
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'Content-Type', 'application/x-amz-json-1.1'
EXEC sp_OAMethod @rest, 'AddHeader', @success OUT, 'X-Amz-Target', 'RedshiftData.DescribeTable'
DECLARE @sbRequestBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbRequestBody OUT
EXEC sp_OAMethod @json, 'EmitSb', @success OUT, @sbRequestBody
DECLARE @sbResponseBody int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.StringBuilder', @sbResponseBody OUT
EXEC sp_OAMethod @rest, 'FullRequestSb', @success OUT, 'POST', '/', @sbRequestBody, @sbResponseBody
IF @success <> 1
BEGIN
EXEC sp_OAGetProperty @rest, 'LastErrorText', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @authAws
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @respStatusCode int
EXEC sp_OAGetProperty @rest, 'ResponseStatusCode', @respStatusCode OUT
PRINT 'response status code = ' + @respStatusCode
IF @respStatusCode <> 200
BEGIN
PRINT 'Response Header:'
EXEC sp_OAGetProperty @rest, 'ResponseHeader', @sTmp0 OUT
PRINT @sTmp0
PRINT 'Response Body:'
EXEC sp_OAMethod @sbResponseBody, 'GetAsString', @sTmp0 OUT
PRINT @sTmp0
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @authAws
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
RETURN
END
DECLARE @jResp int
EXEC @hr = sp_OACreate 'Chilkat_9_5_0.JsonObject', @jResp OUT
EXEC sp_OAMethod @jResp, 'LoadSb', @success OUT, @sbResponseBody
-- The following code parses the JSON response.
-- A sample JSON response is shown below the sample code.
-- Use this online tool to generate parsing code from sample JSON:
-- Generate Parsing Code from JSON
DECLARE @columnDefault nvarchar(max)
DECLARE @isCaseSensitive int
DECLARE @isCurrency int
DECLARE @isSigned int
DECLARE @label nvarchar(max)
DECLARE @length int
DECLARE @name nvarchar(max)
DECLARE @nullable int
DECLARE @precision int
DECLARE @scale int
DECLARE @schemaName nvarchar(max)
DECLARE @tableName nvarchar(max)
DECLARE @typeName nvarchar(max)
DECLARE @NextToken nvarchar(max)
EXEC sp_OAMethod @jResp, 'StringOf', @NextToken OUT, 'NextToken'
DECLARE @TableName nvarchar(max)
EXEC sp_OAMethod @jResp, 'StringOf', @TableName OUT, 'TableName'
DECLARE @i int
SELECT @i = 0
DECLARE @count_i int
EXEC sp_OAMethod @jResp, 'SizeOfArray', @count_i OUT, 'ColumnList'
WHILE @i < @count_i
BEGIN
EXEC sp_OASetProperty @jResp, 'I', @i
EXEC sp_OAMethod @jResp, 'StringOf', @columnDefault OUT, 'ColumnList[i].columnDefault'
EXEC sp_OAMethod @jResp, 'IntOf', @isCaseSensitive OUT, 'ColumnList[i].isCaseSensitive'
EXEC sp_OAMethod @jResp, 'IntOf', @isCurrency OUT, 'ColumnList[i].isCurrency'
EXEC sp_OAMethod @jResp, 'IntOf', @isSigned OUT, 'ColumnList[i].isSigned'
EXEC sp_OAMethod @jResp, 'StringOf', @label OUT, 'ColumnList[i].label'
EXEC sp_OAMethod @jResp, 'IntOf', @length OUT, 'ColumnList[i].length'
EXEC sp_OAMethod @jResp, 'StringOf', @name OUT, 'ColumnList[i].name'
EXEC sp_OAMethod @jResp, 'IntOf', @nullable OUT, 'ColumnList[i].nullable'
EXEC sp_OAMethod @jResp, 'IntOf', @precision OUT, 'ColumnList[i].precision'
EXEC sp_OAMethod @jResp, 'IntOf', @scale OUT, 'ColumnList[i].scale'
EXEC sp_OAMethod @jResp, 'StringOf', @schemaName OUT, 'ColumnList[i].schemaName'
EXEC sp_OAMethod @jResp, 'StringOf', @tableName OUT, 'ColumnList[i].tableName'
EXEC sp_OAMethod @jResp, 'StringOf', @typeName OUT, 'ColumnList[i].typeName'
SELECT @i = @i + 1
END
-- A sample JSON response body parsed by the above code:
-- {
-- "ColumnList": [
-- {
-- "columnDefault": "string",
-- "isCaseSensitive": boolean,
-- "isCurrency": boolean,
-- "isSigned": boolean,
-- "label": "string",
-- "length": number,
-- "name": "string",
-- "nullable": number,
-- "precision": number,
-- "scale": number,
-- "schemaName": "string",
-- "tableName": "string",
-- "typeName": "string"
-- }
-- ],
-- "NextToken": "string",
-- "TableName": "string"
-- }
EXEC @hr = sp_OADestroy @rest
EXEC @hr = sp_OADestroy @authAws
EXEC @hr = sp_OADestroy @json
EXEC @hr = sp_OADestroy @sbRequestBody
EXEC @hr = sp_OADestroy @sbResponseBody
EXEC @hr = sp_OADestroy @jResp
END
GO
