# Amazon QLDB Java DMV Sample App
[![license](https://img.shields.io/badge/license-Apache%202.0-blue)](https://github.com/awslabs/amazon-qldb-driver-java/blob/master/LICENSE)
[![AWS Provider](https://img.shields.io/badge/provider-AWS-orange?logo=amazon-aws&color=ff9900)](https://aws.amazon.com/qldb/)

The samples in this project demonstrate several uses of Amazon QLDB.

For our tutorial, see [Java and Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/getting-started.java.html).

## Requirements

### Basic Configuration

See [Accessing Amazon QLDB](https://docs.aws.amazon.com/qldb/latest/developerguide/accessing.html) for information on connecting to AWS.

See [Setting Region](https://docs.aws.amazon.com/sdk-for-java/latest/developer-guide/region-selection.html) page for more information on using the AWS SDK for Java. You will need to set a region before running the sample code.

### Java 8 and Gradle

The examples are written in Java 8 using the Gradle build tool. Java 8 must be installed to build the examples, however 
the Gradle wrapper is bundled in the project and does not need to be installed. Please see the link below for more 
detail to install Java 8 and information on Gradle:

* [Java 8 Installation](https://docs.oracle.com/javase/8/docs/technotes/guides/install/install_overview.html)
* [Gradle](https://gradle.org/)
* [Gradle Wrapper](https://docs.gradle.org/3.3/userguide/gradle_wrapper.html)

## Running the Sample code

The sample code creates a ledger with tables and indexes, and inserts some documents into those tables,
among other things. Each of the examples in this project can be run in the following way:

Windows:

```
gradlew run -Dtutorial=CreateLedger
```

Unix:

```
./gradlew run -Dtutorial=CreateLedger
```

The above example will build the CreateLedger class with the necessary dependencies and create a ledger named:
`vehicle-registration`. You may run other examples after creating a ledger.

### Samples

Below is a list of the sample applications included in this repository with the recommended order of execution.

### Setting up the test ledger

- CreateLedger
- ListLedgers
- DescribeLedger
- ConnectToLedger
- CreateTable
- CreateIndex
- ConnectToLedger: Run it again to see the created tables.
- InsertDocument
- ScanTable

### Transaction management, PartiQL queries examples and History

- AddSecondaryOwner
- DeregisterDriversLicense
- FindVehicles
- RegisterDriversLicense
- RenewDriversLicense
- TransferVehicleOwnership
- DeregisterDriversLicense
- QueryHistory
- InsertIonTypes

### Exporting data

- ExportJournal

- ListJournalExports

- DescribeJournalExport

  **Note:** To execute this test, you need to pass the ExportId that will be in the output of `ListJournalExports`. You can execute the test like this:

  ```bash
  ./gradlew run -Dtutorial=DescribeJournalExport --args="<Export Id obtained from the output of ListJournalExports>"	
  ```

### Verifying data

- GetRevision
- GetDigest
- GetBlock
- ValidateQldbHashChain

### Other Ledger management operations

- TagResource
- DeletionProtection
- DeleteLedger

### 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 <reporting/>) using the given stylesheet (defined in <reporting/>), and with an help page (default value for nohelp is true).

```mvn javadoc:javadoc```

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

Please see [Javadoc usage](https://maven.apache.org/plugins/maven-javadoc-plugin/usage.html).

## Security

See [CONTRIBUTING](CONTRIBUTING.md#security-issue-notifications) for more information.


## License

This library is licensed under the Apache 2.0 license.