Chilkat Online Tools

GetTableMetadata PureBasic Example

Athena

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, "athena")
    ; SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
    CkRest::ckSetAuthAws(rest,authAws)

    ; URL: https://athena.us-west-2.amazonaws.com/
    ; Use the same region as specified above.
    success = CkRest::ckConnect(rest,"athena.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,"CatalogName","string")
    CkJsonObject::ckUpdateString(json,"DatabaseName","string")
    CkJsonObject::ckUpdateString(json,"TableName","string")

    ; The JSON request body created by the above code:

    ; {
    ;   "CatalogName": "string",
    ;   "DatabaseName": "string",
    ;   "TableName": "string"
    ; }

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

    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

    Comment.s
    v_Type.s

    CreateTime.i = CkJsonObject::ckIntOf(jResp,"TableMetadata.CreateTime")
    LastAccessTime.i = CkJsonObject::ckIntOf(jResp,"TableMetadata.LastAccessTime")
    Name.s = CkJsonObject::ckStringOf(jResp,"TableMetadata.Name")
    v_String.s = CkJsonObject::ckStringOf(jResp,"TableMetadata.Parameters.string")
    TableType.s = CkJsonObject::ckStringOf(jResp,"TableMetadata.TableType")
    i.i = 0
    count_i.i = CkJsonObject::ckSizeOfArray(jResp,"TableMetadata.Columns")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Comment = CkJsonObject::ckStringOf(jResp,"TableMetadata.Columns[i].Comment")
        Name = CkJsonObject::ckStringOf(jResp,"TableMetadata.Columns[i].Name")
        v_Type = CkJsonObject::ckStringOf(jResp,"TableMetadata.Columns[i].Type")
        i = i + 1
    Wend
    i = 0
    count_i = CkJsonObject::ckSizeOfArray(jResp,"TableMetadata.PartitionKeys")
    While i < count_i
        CkJsonObject::setCkI(jResp, i)
        Comment = CkJsonObject::ckStringOf(jResp,"TableMetadata.PartitionKeys[i].Comment")
        Name = CkJsonObject::ckStringOf(jResp,"TableMetadata.PartitionKeys[i].Name")
        v_Type = CkJsonObject::ckStringOf(jResp,"TableMetadata.PartitionKeys[i].Type")
        i = i + 1
    Wend

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

    ; {
    ;   "TableMetadata": {
    ;     "Columns": [
    ;       {
    ;         "Comment": "string",
    ;         "Name": "string",
    ;         "Type": "string"
    ;       }
    ;     ],
    ;     "CreateTime": number,
    ;     "LastAccessTime": number,
    ;     "Name": "string",
    ;     "Parameters": {
    ;       "string": "string"
    ;     },
    ;     "PartitionKeys": [
    ;       {
    ;         "Comment": "string",
    ;         "Name": "string",
    ;         "Type": "string"
    ;       }
    ;     ],
    ;     "TableType": "string"
    ;   }
    ; }


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


    ProcedureReturn
EndProcedure