Amazon QLDB Driver for Java

This package provides an interface to Amazon QLDB for Java.

With the Amazon QLDB Driver for Java you can create a session with connectivity to a specific ledger in QLDB. This session enables you to execute PartiQL statements and retrieve the results of those statements. You can also take control over transactions to group multiple executions within a transaction.

Version 1.x is still supported.

Getting Started

1. Sign up for AWS — Before you begin, you need an AWS account. For more information about creating an AWS account and retrieving your AWS credentials, see [AWS Account and Credentials][docs-signup] in the AWS SDK for Java Developer Guide.
2. Minimum requirements — To use the Amazon QLDB Driver for Java, you'll need Java 1.8+. For more information about Amazon QLDB Driver for Java requirements, see Amazon QLDB Driver for Java in the Amazon QLDB Developer Guide.
3. Install the QLDB driver — The driver binaries are in Maven Central. For more information, see Amazon QLDB documentation for the Java driver section of the Amazon Qldb documentaiton for the java Driver.
4. Using the Amazon QLDB Driver for Java — The best way to get familiar with the Amazon QLDB Driver for Java is to read Getting Started with the Amazon QLDB Driver in the Amazon QLDB Developer Guide.

Getting Help

Please use these community resources for getting help.

• Ask a question on StackOverflow and tag it with the amazon-qldb tag.
• Open a support ticket with AWS Support.
• Make a new thread at AWS QLDB Forum.
• If you think you may have found a bug, please open an issue.

Opening Issues

If you encounter a bug with the Amazon QLDB Java Driver, we would like to hear about it. Please search the existing issues and see if others are also experiencing the issue before opening a new issue. When opening a new issue, we will need the version of Amazon QLDB Java Driver, Java language version, and OS you’re using. Please also include reproduction case for the issue when appropriate.

The GitHub issues are intended for bug reports and feature requests. For help and questions with using Amazon QLDB Java Driver, please make use of the resources listed in the Getting Help section. Keeping the list of open issues lean will help us respond in a timely manner.

Features

• Provides an easy-to-use programming model for working with transactions with Amazon QLDB.
• Provides a session pool so the sessions can be reused when future transactions are sent to the ledger database.

See also

1. Driver Recommendations — Check them out in the Best Practices in the QLDB documentation.
2. Exception handling when using QLDB Drivers — Refer to the section Common Errors while using the Amazon QLDB Drivers which describes runtime exceptions that can be thrown by the Amazon QLDB Driver when calling the qldb-session APIs.
3. Using Amazon Ion Java — Amazon Ion is a richly-typed, self-describing, hierarchical data serialization format offering interchangeable binary and text representations. For more information read the Ion docs for Amazon Ion Java
4. Using PartiQL — Amazon QLDB uses PartiQL to send requests to the ledger database. You can get started with the PartiQL Tutorial. Also read the PartiQL Reference from the Amazon QLDB Developer Guide.

License

This library is licensed under the Apache 2.0 License.