Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/quarkiverse/quarkus-jnosql

The Quarkus JNoSql Extension adds support for JNoSQL, an implementation of Jakarta NoSQL.
https://github.com/quarkiverse/quarkus-jnosql

jnosql nosql quarkus-extension

Last synced: about 2 months ago
JSON representation

The Quarkus JNoSql Extension adds support for JNoSQL, an implementation of Jakarta NoSQL.

Host: GitHub
URL: https://github.com/quarkiverse/quarkus-jnosql
Owner: quarkiverse
License: apache-2.0
Created: 2023-03-20T15:12:20.000Z (almost 2 years ago)
Default Branch: master
Last Pushed: 2024-11-07T09:12:02.000Z (about 2 months ago)
Last Synced: 2024-11-07T10:23:11.363Z (about 2 months ago)
Topics: jnosql, nosql, quarkus-extension
Language: Java
Homepage: http://www.jnosql.org/
Size: 450 KB
Stars: 13
Watchers: 7
Forks: 4
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        # Quarkus JNoSQL

[![All Contributors](https://img.shields.io/badge/all_contributors-1-orange.svg?style=flat-square)](#contributors-)

[![Version](https://img.shields.io/maven-central/v/io.quarkiverse.jnosql/quarkus-jnosql-core?logo=apache-maven&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.jnosql/quarkus-jnosql-core)

This documentation provides instructions on how to integrate [JNoSQL](https://www.jnosql.org/), an implementation of [Jakarta NoSQL](https://jakarta.ee/specifications/nosql/), into a Quarkus project using the Quarkus JNoSQL Extension. This extension supports JNoSQL and facilitates using NoSQL databases in your Quarkus applications.

:information_source: **Recommended Quarkus version: `3.2.2.Final` or higher**

## Getting Started

To begin using JNoSQL with Quarkus, follow these steps:

1. Add the Quarkus JNoSQL Extension to your project's dependencies. You can find the latest version on Maven Central:

   [![Version](https://img.shields.io/maven-central/v/io.quarkiverse.jnosql/quarkus-jnosql-core?logo=apache-maven&style=flat-square)](https://search.maven.org/artifact/io.quarkiverse.jnosql/quarkus-jnosql-core)

2. Define your entities using JNoSQL annotations. Here's an example entity class:

   ```java

   import jakarta.nosql.Column;

   import jakarta.nosql.Entity;

   import jakarta.nosql.Id;

   @Entity

   public class TestEntity {

       

       @Id

       private String id;

       

       @Column

       private String testField;

   }

   ```

## KeyValue

### Configuration

Configure the JNoSql KeyValue Quarkus extension by specifying the database's name in your `application.properties`:

```properties

jnosql.keyvalue.database=my-database-name

```

### Usage

Inject the `KeyValueTemplate` into your class and use it to interact with the KeyValue database:

```java

import jakarta.inject.Inject;

import org.jnosql.artemis.key.KeyValueTemplate;

@Inject

private KeyValueTemplate template;

public void insert(TestEntity entity) {

    template.insert(entity);

}

```

### Database Specific Configuration

#### ArangoDB

Add the ArangoDB dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-keyvalue-arangodb

```

For specific configuration details, please refer to the [ArangoDB JNoSQL driver](https://github.com/eclipse/jnosql-databases#arangodb).

#### DynamoDB

Add the DynamoDB dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-keyvalue-dynamodb

```

Please refer to the [DynamoDB Quarkiverse extension](https://quarkiverse.github.io/quarkiverse-docs/quarkus-amazon-services/dev/amazon-dynamodb.html) for specific configuration details.

#### Hazelcast

Add the Hazelcast dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-keyvalue-hazelcast

```

Please refer to the [Quarkus Hazelcast extension](https://github.com/hazelcast/quarkus-hazelcast-client) for specific configuration details.

#### Redis

Add the Redis dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-keyvalue-redis

```

For specific configuration details, please refer to the [Redis Quarkus extension](https://quarkus.io/guides/redis-reference).

## Document

### Configuration

Configure the JNoSql Document Quarkus extension by specifying the database's name in your `application.properties`:

```properties

jnosql.document.database=my-database-name

```

### Usage

Inject the `DocumentTemplate` into your class and use it to interact with the Document database:

```java

import jakarta.inject.Inject;

import org.jnosql.artemis.document.DocumentTemplate;

@Inject

private DocumentTemplate template;

public void insert(TestDocumentEntity entity) {

    template.insert(entity);

}

```

### Database Specific Configuration

#### ArangoDB

Add the ArangoDB dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-document-arangodb

```

For specific configuration details, please refer to the [ArangoDB JNoSQL driver](https://github.com/eclipse/jnosql-databases#arangodb).

#### CouchDB

Add the CouchDB dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-document-couchdb

```

For specific configuration details, please refer to the [CouchDB JNoSQL driver](https://github.com/eclipse/jnosql-databases#couchdb).

#### Elasticsearch

Add the Elasticsearch dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-document-elasticsearch

```

Please refer to the [Elasticsearch Quarkus extension](https://quarkus.io/guides/elasticsearch#using-the-elasticsearch-java-client) for specific configuration details.

#### MongoDB

Add the MongoDB dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-document-mongodb

```

For specific configuration details, please refer to the [MongoDB Quarkus extension](https://quarkus.io/guides/mongodb).

#### Solr

Add the Solr dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-document-solr

```

For specific configuration details, please refer to the [Solr JNoSQL driver](https://github.com/eclipse/jnosql-databases#solr).

## Column

### Configuration

Configure the JNoSql Column Quarkus extension by specifying the database's name in your `application.properties`:

```properties

jnosql.column.database=my-database-name

```

### Usage

Inject the `ColumnTemplate` into your class and use it to interact with the Column database:

```java

import jakarta.inject.Inject;

import org.jnosql.artemis.column.ColumnTemplate;

@Inject

private ColumnTemplate template;

public void insert(TestColumnEntity entity) {

    template.insert(entity);

}

```

### Database Specific Configuration

#### Cassandra

Add the Cassandra dependency to your project's `pom.xml`:

```xml

    io.quarkiverse.jnosql

    quarkus-jnosql-column-cassandra

```

Please refer to the [Cassandra Quarkus extension](https://quarkus.io/guides/cassandra) for specific configuration details.

## Contributors ✨

Thanks to these wonderful people for their contributions:

- [amoscatelli](https://github.com/amoscatelli) 💻 🚧

- [dearrudam](https://github.com/dearrudam) 💻 🚧

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind are welcome!