Crate qldb[][src]

Amazon’s QLDB Driver

Driver for Amazon’s QLDB Database implemented in pure rust.

Documentation Crates.io

The driver is fairly tested and should be ready to test in real projects. We are using it internally, so we will keep it updated.

Example

use qldb::QLDBClient;
use std::collections::HashMap;

let client = QLDBClient::default("rust-crate-test").await?;

let mut value_to_insert = HashMap::new();
// This will insert a documents with a key "test_column"
// with the value "IonValue::String(test_value)"
value_to_insert.insert("test_column", "test_value");

client
    .transaction_within(|client| async move {   
        client
            .query("INSERT INTO TestTable VALUE ?")
            .param(value_to_insert)
            .execute()
            .await?;
        Ok(())
    })
    .await?;

Test

For tests you will need to have some AWS credentials in your PC (as env variables or in ~/.aws/credentials). There needs to be a QLDB database with the name “rust-crate-test” in the aws account. The tests need to be run sequentially, so in order to run the tests please run the following command:

RUST_TEST_THREADS=1 cargo test

Structs

Cursor

Cursor allows to get all values from a statement page by page.

Document

It contains the IonValue representing the QLDB Document.

DocumentCollection

Represents a collection of documents. It implements so you can call in order to use it in for loops or with .

QLDBClient

It allows to start transactions. In QLDB all queries are transactions. So you always need to create a transaction for every query.

QueryBuilder

Represents the query being built. It allows to add parameters and to execute the query.

Transaction

Every query in QLDB is within a transaction. Ideally you will interact with this object via the method QLDBClient::transaction_within.

Enums

QLDBError
QLDBExtractError
Region

An AWS region.

Type Definitions

QLDBExtractResult
QLDBResult