Skip to content

Commit 7c630a9

Browse files
committed
docs: added dynamodb documentation
Signed-off-by: Maximillian Arruda <[email protected]>
1 parent 5c7dab6 commit 7c630a9

File tree

1 file changed

+57
-0
lines changed

1 file changed

+57
-0
lines changed

README.adoc

Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -516,6 +516,62 @@ jnosql.couchdb.username=admin
516516
jnosql.couchdb.password=password
517517
----
518518

519+
== DynamoDB
520+
521+
image::https://user-images.githubusercontent.com/6509926/70553550-f033b980-1b40-11ea-9192-759b3b1053b3.png[Redis Project,align="center" width=50%,height=50%]
522+
523+
https://aws.amazon.com/dynamodb/[Amazon DynamoDB] is a fully managed, serverless, key-value NoSQL database designed to run high-performance applications at any scale. DynamoDB offers built-in security, continuous backups, automated multi-Region replication, in-memory caching, and data import and export tools.
524+
525+
This driver provides support for the *Key-Value* NoSQL API.
526+
527+
=== How To Install
528+
529+
You can use either the Maven or Gradle dependencies:
530+
531+
[source,xml]
532+
----
533+
<dependency>
534+
<groupId>org.eclipse.jnosql.databases</groupId>
535+
<artifactId>jnosql-dynamodb</artifactId>
536+
<version>1.0.0-b6</version>
537+
</dependency>
538+
----
539+
540+
=== Configuration
541+
542+
This API provides the ```DynamoDBConfigurations``` class to programmatically establish the credentials.
543+
Please note that you can establish properties using the https://microprofile.io/microprofile-config/[MicroProfile Config] specification.
544+
545+
[cols="DynamoDB"]
546+
|===
547+
|Configuration property |Description
548+
549+
|`jnosql.dynamodb.endpoint`
550+
|DynamoDB’s URL
551+
552+
|`jnosql.dynamodb.region`
553+
|Configure the region with which the application should communicate.
554+
555+
|`jnosql.dynamodb.profile`
556+
| Define the name of the profile that should be used by this credentials provider.
557+
558+
|`jnosql.dynamodb.awsaccesskey`
559+
|The AWS access key, used to identify the user interacting with AWS.
560+
561+
|`jnosql.dynamodb.secretaccess`
562+
|The AWS secret access key, used to authenticate the user interacting with AWS.
563+
564+
565+
|===
566+
567+
This is an example using DynamoDB's Key-Value API with MicroProfile Config.
568+
569+
[source,properties]
570+
----
571+
jnosql.keyvalue.provider=org.eclipse.jnosql.databases.dynamodb.communication.DynamoDBKeyValueConfiguration
572+
jnosql.keyvalue.database=heroes
573+
----
574+
519575
== Elasticsearch
520576

521577
image::https://jnosql.github.io/img/logos/elastic.svg[Elasticsearch Project,align="center"width=25%,height=25%]
@@ -1155,6 +1211,7 @@ jnosql.document.provider=org.eclipse.jnosql.databases.ravendb.communication.Rave
11551211
jnosql.document.database=heroes
11561212
----
11571213

1214+
11581215
== Redis
11591216

11601217
image::https://jnosql.github.io/img/logos/redis.png[Redis Project,align="center" width=25%,height=25%]

0 commit comments

Comments
 (0)