databases

Creates, updates, deletes, gets or lists a databases resource.

Overview

Name	databases
Type	Resource
Id	aws.timestream_write.databases

Fields

The following fields are returned by SELECT queries:

describe_database

Name	Datatype	Description
arn	string	The Amazon Resource Name that uniquely identifies this database.
creation_time	string (date-time)	The time when the database was created, calculated from the Unix epoch time.
database_name	string	The name of the Timestream database.
kms_key_id	string	The identifier of the KMS key used to encrypt the data stored in the database.
last_updated_time	string (date-time)	The last time that this database was updated.
table_count	integer (int64)	The total number of tables found within a Timestream database.

list_databases

Name	Datatype	Description
databases	array	A list of database names.
next_token	string	The pagination token. This parameter is returned when the response is truncated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
describe_database	select	region		Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.
list_databases	select	region		Returns a list of your Timestream databases. Service quotas apply. See code sample for details.
create_database	insert	region, DatabaseName		Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.
update_database	update	region, DatabaseName, KmsKeyId		Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins. See code sample for details.
delete_database	delete	region		Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered. All tables in the database must be deleted first, or a ValidationException error will be thrown. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. See code sample for details.
write_records	exec	region, DatabaseName, TableName, Records		Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply. See code sample for details. Upserts You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with its Version when it receives a write request with a higher Version number for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases. For example, suppose you write a new record without indicating Version in the request. Timestream stores this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException.

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

describe_database

Returns information about the database, including the database name, time that the database was created, and the total number of tables found within the database. Service quotas apply. See code sample for details.

SELECT
arn,
creation_time,
database_name,
kms_key_id,
last_updated_time,
table_count
FROM aws.timestream_write.databases
WHERE region = '{{ region }}' -- required
;

list_databases

Returns a list of your Timestream databases. Service quotas apply. See code sample for details.

SELECT
databases,
next_token
FROM aws.timestream_write.databases
WHERE region = '{{ region }}' -- required
;

INSERT examples

create_database

Creates a new Timestream database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys. Service quotas apply. For details, see code sample.

INSERT INTO aws.timestream_write.databases (
DatabaseName,
KmsKeyId,
Tags,
region
)
SELECT 
'{{ DatabaseName }}' /* required */,
'{{ KmsKeyId }}',
'{{ Tags }}',
'{{ region }}'
RETURNING
database
;

Manifest

# Description fields are for documentation purposes
- name: databases
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the databases resource.
  - name: DatabaseName
    value: "{{ DatabaseName }}"
    description: |
      The name of the Timestream database.
  - name: KmsKeyId
    value: "{{ KmsKeyId }}"
    description: |
      The KMS key for the database. If the KMS key is not specified, the database will be encrypted with a Timestream managed KMS key located in your account. For more information, see Amazon Web Services managed keys.
  - name: Tags
    description: |
      A list of key-value pairs to label the table.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_database

Modifies the KMS key for an existing database. While updating the database, you must specify the database name and the identifier of the new KMS key to be used (KmsKeyId). If there are any concurrent UpdateDatabase requests, first writer wins. See code sample for details.

UPDATE aws.timestream_write.databases
SET 
DatabaseName = '{{ DatabaseName }}',
KmsKeyId = '{{ KmsKeyId }}'
WHERE 
region = '{{ region }}' --required
AND DatabaseName = '{{ DatabaseName }}' --required
AND KmsKeyId = '{{ KmsKeyId }}' --required
RETURNING
database;

DELETE examples

delete_database

Deletes a given Timestream database. This is an irreversible operation. After a database is deleted, the time-series data from its tables cannot be recovered. All tables in the database must be deleted first, or a ValidationException error will be thrown. Due to the nature of distributed retries, the operation can return either success or a ResourceNotFoundException. Clients should consider them equivalent. See code sample for details.

DELETE FROM aws.timestream_write.databases
WHERE region = '{{ region }}' --required
;

Lifecycle Methods

write_records

Enables you to write your time-series data into Timestream. You can specify a single data point or a batch of data points to be inserted into the system. Timestream offers you a flexible schema that auto detects the column names and data types for your Timestream tables based on the dimension names and data types of the data points you specify when invoking writes into the database. Timestream supports eventual consistency read semantics. This means that when you query data immediately after writing a batch of data into Timestream, the query results might not reflect the results of a recently completed write operation. The results may also include some stale data. If you repeat the query request after a short time, the results should return the latest data. Service quotas apply. See code sample for details. Upserts You can use the Version parameter in a WriteRecords request to update data points. Timestream tracks a version number with each record. Version defaults to 1 when it's not specified for the record in the request. Timestream updates an existing record’s measure value along with its Version when it receives a write request with a higher Version number for that record. When it receives an update request where the measure value is the same as that of the existing record, Timestream still updates Version, if it is greater than the existing value of Version. You can update a data point as many times as desired, as long as the value of Version continuously increases. For example, suppose you write a new record without indicating Version in the request. Timestream stores this record, and set Version to 1. Now, suppose you try to update this record with a WriteRecords request of the same record with a different measure value but, like before, do not provide Version. In this case, Timestream will reject this update with a RejectedRecordsException since the updated record’s version is not greater than the existing value of Version. However, if you were to resend the update request with Version set to 2, Timestream would then succeed in updating the record’s value, and the Version would be set to 2. Next, suppose you sent a WriteRecords request with this same record and an identical measure value, but with Version set to 3. In this case, Timestream would only update Version to 3. Any further updates would need to send a version number greater than 3, or the update requests would receive a RejectedRecordsException.

EXEC aws.timestream_write.databases.write_records 
@region='{{ region }}' --required 
@@json=
'{
"DatabaseName": "{{ DatabaseName }}", 
"TableName": "{{ TableName }}", 
"CommonAttributes": "{{ CommonAttributes }}", 
"Records": "{{ Records }}"
}'
;