GitPlanet

Cheap and reliable Node.js hosting starts at $3/month, and $1/month static HTML hosting

Created with love in Canada, visit hostnodejs.com today

Feel like to post an Ad? Learn Details
All Projects → awslabs → amazon-qldb-driver-java

awslabs / amazon-qldb-driver-java

Licence: Apache-2.0 license
A Java implementation of a driver for Amazon QLDB.

Programming Languages

java
68154 projects - #9 most used programming language

Labels

amazon-qldb

Projects that are alternatives of or similar to amazon-qldb-driver-java

amazon-qldb-dmv-sample-nodejs
A DMV based example application which demonstrates how to use QLDB with the QLDB Driver for Node.js
Stars: ✭ 38 (+192.31%)
Mutual labels:  amazon-qldb
amazon-qldb-dmv-sample-python
A DMV based example application which demonstrates how to use QLDB with the QLDB Driver for Python.
Stars: ✭ 23 (+76.92%)
Mutual labels:  amazon-qldb
amazon-qldb-dmv-sample-java
A DMV based example application which demonstrates best-practices for using QLDB & the QLDB Driver for Java.
Stars: ✭ 26 (+100%)
Mutual labels:  amazon-qldb

Amazon QLDB Driver for Java

Maven Central Javadoc Java CI with Maven codecov license AWS Provider

This is the Java driver for Amazon Quantum Ledger Database (QLDB), which allows Java developers to write software that makes use of Amazon QLDB.

Version 1.x is still supported.

For getting started with the driver, see Java and Amazon QLDB.

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.

Basic Configuration

See Accessing Amazon QLDB for information on connecting to AWS.

Getting Started

Please see the Quickstart guide for the Amazon QLDB Driver for Java.

  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 Accessing Amazon QLDB in the Amazon QLDB Developer Guide.
  2. 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 documentation for the Java Driver.
  3. 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.

See also

  1. Getting Started with Amazon QLDB Java Driver A guide that gets you started with executing transactions with the QLDB Java driver.
  2. QLDB Java Driver Cookbook The cookbook provides code samples for some simple QLDB Java driver use cases.
  3. Amazon QLDB Java Driver Tutorial: In this tutorial, you use the QLDB Driver for Java to create an Amazon QLDB ledger and populate it with tables and sample data.
  4. Amazon QLDB Java Driver Samples: A DMV based example application which demonstrates how to use QLDB with the QLDB Driver for Java.
  5. QLDB Java driver accepts and returns Amazon ION Documents. 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.
  6. Amazon QLDB supports the PartiQL query language. PartiQL provides SQL-compatible query access across multiple data stores containing structured data, semistructured data, and nested data. For more information read the PartiQL docs.
  7. Refer the section Common Errors while using the Amazon QLDB Drivers which describes runtime errors that can be thrown by the Amazon QLDB Driver when calling the qldb-session APIs.

Development

Setup

Please see the Setting up the Java environment.

To install the driver, please see Installing the Java driver.

Running Tests

Assuming you use JetBrain's IntelliJ IDE, please see Running Tests in IntelliJ IDEA.

Documentation

Javadoc is used for documentation. You can generate HTML locally with the following:

mvn site

It will generate the Javadoc for public members (defined in ) using the given stylesheet (defined in ), and with an help page (default value for nohelp is true).

mvn javadoc:javadoc

It will generate the Javadoc for private members (defined in ) using the stylesheet (defined in ), and with no help page (defined in ).

Please see Javadoc usage.

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.

License

This library is licensed under the Apache 2.0 License.

Note that the project description data, including the texts, logos, images, and/or trademarks, for each open source project belongs to its rightful owner. If you wish to add or remove any projects, please contact us at [email protected].