Chilkat Online Tools

DescribeStatement PureBasic Example

Amazon Redshift Data API

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,"Id","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "Id": "string"
    ; }

    CkRest::ckAddHeader(rest,"Content-Type","application/x-amz-json-1.1")
    CkRest::ckAddHeader(rest,"X-Amz-Target","RedshiftData.DescribeStatement")

    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

    name.s
    value.s

    ClusterIdentifier.s = CkJsonObject::ckStringOf(jResp,"ClusterIdentifier")
    CreatedAt.i = CkJsonObject::ckIntOf(jResp,"CreatedAt")
    Database.s = CkJsonObject::ckStringOf(jResp,"Database")
    DbUser.s = CkJsonObject::ckStringOf(jResp,"DbUser")
    Duration.i = CkJsonObject::ckIntOf(jResp,"Duration")
    Error.s = CkJsonObject::ckStringOf(jResp,"Error")
    HasResultSet.i = CkJsonObject::ckIntOf(jResp,"HasResultSet")
    Id.s = CkJsonObject::ckStringOf(jResp,"Id")
    QueryString.s = CkJsonObject::ckStringOf(jResp,"QueryString")
    RedshiftPid.i = CkJsonObject::ckIntOf(jResp,"RedshiftPid")
    RedshiftQueryId.i = CkJsonObject::ckIntOf(jResp,"RedshiftQueryId")
    ResultRows.i = CkJsonObject::ckIntOf(jResp,"ResultRows")
    ResultSize.i = CkJsonObject::ckIntOf(jResp,"ResultSize")
    SecretArn.s = CkJsonObject::ckStringOf(jResp,"SecretArn")
    Status.s = CkJsonObject::ckStringOf(jResp,"Status")
    UpdatedAt.i = CkJsonObject::ckIntOf(jResp,"UpdatedAt")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"QueryParameters")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        name = CkJsonObject::ckStringOf(jResp,"QueryParameters[i].name")
        value = CkJsonObject::ckStringOf(jResp,"QueryParameters[i].value")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"SubStatements")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        CreatedAt = CkJsonObject::ckIntOf(jResp,"SubStatements[i].CreatedAt")
        Duration = CkJsonObject::ckIntOf(jResp,"SubStatements[i].Duration")
        Error = CkJsonObject::ckStringOf(jResp,"SubStatements[i].Error")
        HasResultSet = CkJsonObject::ckIntOf(jResp,"SubStatements[i].HasResultSet")
        Id = CkJsonObject::ckStringOf(jResp,"SubStatements[i].Id")
        QueryString = CkJsonObject::ckStringOf(jResp,"SubStatements[i].QueryString")
        RedshiftQueryId = CkJsonObject::ckIntOf(jResp,"SubStatements[i].RedshiftQueryId")
        ResultRows = CkJsonObject::ckIntOf(jResp,"SubStatements[i].ResultRows")
        ResultSize = CkJsonObject::ckIntOf(jResp,"SubStatements[i].ResultSize")
        Status = CkJsonObject::ckStringOf(jResp,"SubStatements[i].Status")
        UpdatedAt = CkJsonObject::ckIntOf(jResp,"SubStatements[i].UpdatedAt")
        i = i + 1
    Wend

    ; A sample JSON response body parsed by the above code:

    ; {
    ;   "ClusterIdentifier": "string",
    ;   "CreatedAt": number,
    ;   "Database": "string",
    ;   "DbUser": "string",
    ;   "Duration": number,
    ;   "Error": "string",
    ;   "HasResultSet": boolean,
    ;   "Id": "string",
    ;   "QueryParameters": [
    ;     {
    ;       "name": "string",
    ;       "value": "string"
    ;     }
    ;   ],
    ;   "QueryString": "string",
    ;   "RedshiftPid": number,
    ;   "RedshiftQueryId": number,
    ;   "ResultRows": number,
    ;   "ResultSize": number,
    ;   "SecretArn": "string",
    ;   "Status": "string",
    ;   "SubStatements": [
    ;     {
    ;       "CreatedAt": number,
    ;       "Duration": number,
    ;       "Error": "string",
    ;       "HasResultSet": boolean,
    ;       "Id": "string",
    ;       "QueryString": "string",
    ;       "RedshiftQueryId": number,
    ;       "ResultRows": number,
    ;       "ResultSize": number,
    ;       "Status": "string",
    ;       "UpdatedAt": number
    ;     }
    ;   ],
    ;   "UpdatedAt": number
    ; }


    CkRest::ckDispose(rest)
    CkAuthAws::ckDispose(authAws)
    CkJsonObject::ckDispose(json)
    CkStringBuilder::ckDispose(sbRequestBody)
    CkStringBuilder::ckDispose(sbResponseBody)
    CkJsonObject::ckDispose(jResp)


    ProcedureReturn
EndProcedure