The Bold BI Dashboard Designer supports connecting the Amazon Athena database using the SQL Live Query (C# API).
To configure the Amazon Athena data source, follow these steps:
NOTE: You can also create a data source from the home page by clicking the Data Sources menu from the left menu panel and Create Data Source from the data sources page.
Amazon Athena data source can be accessed in Bold BI using the live connection mode.
After clicking the data source, the NEW DATA SOURCE configuration panel opens. Follow the given steps to create an Amazon Athena data source:
You can use the Code View option for passing a query to display data.
NOTE: In the future, you can edit the connection information using the Edit Connection option.
Type while creating the data source needs to be amazonathena.
Parameters | Details |
---|---|
RegionEndpoint required | `string`
Region in which the server is available
The region code must be provided. Examples: us-east-1, ap-south-1, and more. A list of available regions is provided in the following link.
The available AWS regions
|
AwsAccessKeyId required | `string` AWS access key of the account. |
AwsSecretAccessKey required | `string` AWS secret key of the account. |
OutputLocation required | `string`
A valid S3 location to store the query results. Format: s3://bucketname/foldername
The following link explains the s3 output location in Athena and its usage.
Output location in the Athena.
|
Database required | `string` database which needs to be connected |
Schemaname required for table mode | `string` Enter a valid Schemaname which will mostly be the database name. |
Tablename required for table mode | `string` Enter a valid Tablename |
Query required for code view mode | `string` Enter a valid Query |
AdvancedSettings optional | `string` Additional optional connection parameters can be provided. By default, it is empty. |
Expressions optional | `Array of Objects` |
Parameters | Details |
---|---|
Name required | `string` Name of the Expression |
Expression required | `string`
Expression
|
NOTE: For editing Data Source via API. All the parameters are optional. The parameter which needs to be changed can be provided.
Parameters | Details |
---|---|
Name required | `string` Name of the Expression |
Expression required | `string`
Expression
|
Action optional | `string` add/delete/edit By default, it is add. |
NewName optional | `string` For renaming the expression. This is applicable only if the Action is edit |
"Connection": [
{
"RegionEndpoint": "string",
"AwsAccessKeyId": "string",
"AwsSecretAccessKey": "string",
"OutputLocation": "string",
"Database": "string",
"Schemaname": "string",
"Tablename": "string",
"AdvancedSettings": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
}]
}
]
"Connection": [
{
"RegionEndpoint": "string",
"AwsAccessKeyId": "string",
"AwsSecretAccessKey": "string",
"OutputLocation": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)",
"NewName" : "Sum",
"Action": "edit"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
"Action": "delete"
}]
}
]
NOTE: Through Rest API, the data source can be created or edited with only one table. If different table is provided in edit data source, the table will be replaced. The widgets will be retained only if the schema is same as the previous table.
"Connection": [
{
"RegionEndpoint": "string",
"AwsAccessKeyId": "string",
"AwsSecretAccessKey": "string",
"OutputLocation": "string",
"Database": "string",
"Query": "string",
"AdvancedSettings": "string",
"Expressions" : [{
"Name": "Expression1",
"Expression" : "SUM(numeric expression)"
},
{
"Name": "Expression2",
"Expression" : "UPPER(string expression)"
}]
}
]