tables
Creates, updates, deletes, gets or lists a tables resource.
Overview
| Name | tables |
| Type | Resource |
| Id | aws.bcm_data_exports.tables |
Fields
The following fields are returned by SELECT queries:
- get_table
- list_tables
| Name | Datatype | Description |
|---|---|---|
description | string | The table description. (pattern: <code>[\S\s]*</code>) |
schema | array | The schema of the table. |
table_name | string | The name of the table. (pattern: <code>[\S\s]*</code>) |
table_properties | object | TableProperties are additional configurations you can provide to change the data and schema of a table. Each table can have different TableProperties. Tables are not required to have any TableProperties. Each table property has a default value that it assumes if not specified. |
| Name | Datatype | Description |
|---|---|---|
description | string | The description for the table. (pattern: <code>[\S\s]*</code>) |
table_name | string | The name of the table. (pattern: <code>[\S\s]*</code>) |
table_properties | array | The properties for the table. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
get_table | select | region | Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions. | |
list_tables | select | region | Lists all available tables in data exports. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- get_table
- list_tables
Returns the metadata for the specified table and table properties. This includes the list of columns in the table schema, their data types, and column descriptions.
SELECT
description,
schema,
table_name,
table_properties
FROM aws.bcm_data_exports.tables
WHERE region = '{{ region }}' -- required
;
Lists all available tables in data exports.
SELECT
description,
table_name,
table_properties
FROM aws.bcm_data_exports.tables
WHERE region = '{{ region }}' -- required
;