Chilkat Online Tools

DescribeTable Perl Example

Amazon Redshift Data API

use chilkat();

# This example requires the Chilkat API to have been previously unlocked.
# See Global Unlock Sample for sample code.

$rest = chilkat::CkRest->new();

$authAws = chilkat::CkAuthAws->new();
$authAws->put_AccessKey("AWS_ACCESS_KEY");
$authAws->put_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.)
$authAws->put_Region("us-west-2");
$authAws->put_ServiceName("redshift-data");
# SetAuthAws causes Chilkat to automatically add the following headers: Authorization, X-Amz-Date
$rest->SetAuthAws($authAws);

# URL: https://redshift-data.us-west-2.amazonaws.com/
# Use the same region as specified above.
$success = $rest->Connect("redshift-data.us-west-2.amazonaws.com",443,1,1);
if ($success != 1) {
    print "ConnectFailReason: " . $rest->get_ConnectFailReason() . "\r\n";
    print $rest->lastErrorText() . "\r\n";
    exit;
}

# 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 = chilkat::CkJsonObject->new();
$json->UpdateString("ClusterIdentifier","string");
$json->UpdateString("ConnectedDatabase","string");
$json->UpdateString("Database","string");
$json->UpdateString("DbUser","string");
$json->UpdateInt("MaxResults",123);
$json->UpdateString("NextToken","string");
$json->UpdateString("Schema","string");
$json->UpdateString("SecretArn","string");
$json->UpdateString("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"
# }

$rest->AddHeader("Content-Type","application/x-amz-json-1.1");
$rest->AddHeader("X-Amz-Target","RedshiftData.DescribeTable");

$sbRequestBody = chilkat::CkStringBuilder->new();
$json->EmitSb($sbRequestBody);
$sbResponseBody = chilkat::CkStringBuilder->new();
$success = $rest->FullRequestSb("POST","/",$sbRequestBody,$sbResponseBody);
if ($success != 1) {
    print $rest->lastErrorText() . "\r\n";
    exit;
}

$respStatusCode = $rest->get_ResponseStatusCode();
print "response status code = " . $respStatusCode . "\r\n";
if ($respStatusCode != 200) {
    print "Response Header:" . "\r\n";
    print $rest->responseHeader() . "\r\n";
    print "Response Body:" . "\r\n";
    print $sbResponseBody->getAsString() . "\r\n";
    exit;
}

$jResp = chilkat::CkJsonObject->new();
$jResp->LoadSb($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

$NextToken = $jResp->stringOf("NextToken");
$TableName = $jResp->stringOf("TableName");
$i = 0;
$count_i = $jResp->SizeOfArray("ColumnList");
while ($i < $count_i) {
    $jResp->put_I($i);
    $columnDefault = $jResp->stringOf("ColumnList[i].columnDefault");
    $isCaseSensitive = $jResp->IntOf("ColumnList[i].isCaseSensitive");
    $isCurrency = $jResp->IntOf("ColumnList[i].isCurrency");
    $isSigned = $jResp->IntOf("ColumnList[i].isSigned");
    $label = $jResp->stringOf("ColumnList[i].label");
    $length = $jResp->IntOf("ColumnList[i].length");
    $name = $jResp->stringOf("ColumnList[i].name");
    $nullable = $jResp->IntOf("ColumnList[i].nullable");
    $precision = $jResp->IntOf("ColumnList[i].precision");
    $scale = $jResp->IntOf("ColumnList[i].scale");
    $schemaName = $jResp->stringOf("ColumnList[i].schemaName");
    $tableName = $jResp->stringOf("ColumnList[i].tableName");
    $typeName = $jResp->stringOf("ColumnList[i].typeName");
    $i = $i + 1;
}

# 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"
# }