DescribeTable PureBasic Example
IncludeFile "CkJsonObject.pb"
IncludeFile "CkStringBuilder.pb"
IncludeFile "CkRest.pb"
IncludeFile "CkAuthAws.pb"
Procedure ChilkatExample()
; This example requires the Chilkat API to have been previously unlocked.
; See Global Unlock Sample for sample code.
rest.i = CkRest::ckCreate()
If rest.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success.i
authAws.i = CkAuthAws::ckCreate()
If authAws.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkAuthAws::setCkAccessKey(authAws, "AWS_ACCESS_KEY")
CkAuthAws::setCkSecretKey(authAws, "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.)
CkAuthAws::setCkRegion(authAws, "us-west-2")
CkAuthAws::setCkServiceName(authAws, "redshift-data")
; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
CkRest::ckSetAuthAws(rest,authAws)
; URL: https://redshift-data.us-west-2.amazonaws.com/
; Use the same region as specified above.
success = CkRest::ckConnect(rest,"redshift-data.us-west-2.amazonaws.com",443,1,1)
If success <> 1
Debug "ConnectFailReason: " + Str(CkRest::ckConnectFailReason(rest))
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
ProcedureReturn
EndIf
; 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
json.i = CkJsonObject::ckCreate()
If json.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckUpdateString(json,"ClusterIdentifier","string")
CkJsonObject::ckUpdateString(json,"ConnectedDatabase","string")
CkJsonObject::ckUpdateString(json,"Database","string")
CkJsonObject::ckUpdateString(json,"DbUser","string")
CkJsonObject::ckUpdateInt(json,"MaxResults",123)
CkJsonObject::ckUpdateString(json,"NextToken","string")
CkJsonObject::ckUpdateString(json,"Schema","string")
CkJsonObject::ckUpdateString(json,"SecretArn","string")
CkJsonObject::ckUpdateString(json,"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"
; }
CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
CkRest::ckAddHeader(rest,"X-Amz-Target","RedshiftData.DescribeTable")
sbRequestBody.i = CkStringBuilder::ckCreate()
If sbRequestBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckEmitSb(json,sbRequestBody)
sbResponseBody.i = CkStringBuilder::ckCreate()
If sbResponseBody.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
success = CkRest::ckFullRequestSb(rest,"POST","/",sbRequestBody,sbResponseBody)
If success <> 1
Debug CkRest::ckLastErrorText(rest)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
respStatusCode.i = CkRest::ckResponseStatusCode(rest)
Debug "response status code = " + Str(respStatusCode)
If respStatusCode <> 200
Debug "Response Header:"
Debug CkRest::ckResponseHeader(rest)
Debug "Response Body:"
Debug CkStringBuilder::ckGetAsString(sbResponseBody)
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
ProcedureReturn
EndIf
jResp.i = CkJsonObject::ckCreate()
If jResp.i = 0
Debug "Failed to create object."
ProcedureReturn
EndIf
CkJsonObject::ckLoadSb(jResp,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
columnDefault.s
isCaseSensitive.i
isCurrency.i
isSigned.i
label.s
length.i
name.s
nullable.i
precision.i
scale.i
schemaName.s
tableName.s
typeName.s
NextToken.s = CkJsonObject::ckStringOf(jResp,"NextToken")
TableName.s = CkJsonObject::ckStringOf(jResp,"TableName")
i.i = 0
count_i.i = CkJsonObject::ckSizeOfArray(jResp,"ColumnList")
While i < count_i
CkJsonObject::setCkI(jResp, i)
columnDefault = CkJsonObject::ckStringOf(jResp,"ColumnList[i].columnDefault")
isCaseSensitive = CkJsonObject::ckIntOf(jResp,"ColumnList[i].isCaseSensitive")
isCurrency = CkJsonObject::ckIntOf(jResp,"ColumnList[i].isCurrency")
isSigned = CkJsonObject::ckIntOf(jResp,"ColumnList[i].isSigned")
label = CkJsonObject::ckStringOf(jResp,"ColumnList[i].label")
length = CkJsonObject::ckIntOf(jResp,"ColumnList[i].length")
name = CkJsonObject::ckStringOf(jResp,"ColumnList[i].name")
nullable = CkJsonObject::ckIntOf(jResp,"ColumnList[i].nullable")
precision = CkJsonObject::ckIntOf(jResp,"ColumnList[i].precision")
scale = CkJsonObject::ckIntOf(jResp,"ColumnList[i].scale")
schemaName = CkJsonObject::ckStringOf(jResp,"ColumnList[i].schemaName")
tableName = CkJsonObject::ckStringOf(jResp,"ColumnList[i].tableName")
typeName = CkJsonObject::ckStringOf(jResp,"ColumnList[i].typeName")
i = i + 1
Wend
; 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"
; }
CkRest::ckDispose(rest)
CkAuthAws::ckDispose(authAws)
CkJsonObject::ckDispose(json)
CkStringBuilder::ckDispose(sbRequestBody)
CkStringBuilder::ckDispose(sbResponseBody)
CkJsonObject::ckDispose(jResp)
ProcedureReturn
EndProcedure
