https://github.com/areeb-gillani/vertx-boost-db

This project (BoostDB) provides easier ways to write code for a data-access layer. Keeping in mind the learning curve of vertx, this project is designed to be as close to the SpringData layer as possible. This project provides a multi-tenant approach to configuring multiple data sources using connection configuration.
https://github.com/areeb-gillani/vertx-boost-db

database database-management orm sql vertx

Last synced: 4 months ago
JSON representation

This project (BoostDB) provides easier ways to write code for a data-access layer. Keeping in mind the learning curve of vertx, this project is designed to be as close to the SpringData layer as possible. This project provides a multi-tenant approach to configuring multiple data sources using connection configuration.

• Host: GitHub
• URL: https://github.com/areeb-gillani/vertx-boost-db
• Owner: Areeb-Gillani
• License: apache-2.0
• Created: 2023-09-03T20:40:18.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-09-07T21:45:41.000Z (5 months ago)
• Last Synced: 2024-09-26T07:40:12.602Z (4 months ago)
• Topics: database, database-management, orm, sql, vertx
• Language: Java
• Homepage:
• Size: 107 KB
• Stars: 23
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![](https://jitpack.io/v/Areeb-Gillani/vertx-boost-db.svg)](https://jitpack.io/#Areeb-Gillani/vertx-boost-db)

# vertx-boost-db

This project (BoostDB) provides easier ways to write code for a data-access layer. Keeping in mind the learning curve of vertx, this project is designed to be as close to the SpringData layer as possible. This project provides a multi-tenant approach to configuring multiple data sources using connection configuration.

# Background & Basics

### Vertx vs. Spring

Vertx is an event-driven toolkit backed by the Eclipse Foundation. It's a polyglot and is used for highly concurrent code writing. When compared to spring, people usually use hibernate or spring data. They are heavy with their own pros and cons. For instance, in hibernate, one can't bypass its L1 cache. Vertx on the other hand provides lightweight clients for most of the popular databases to get things going. This component is covering MySQL, MSSQL, Postgres, and Oracle databases for now.

### Why Vertx?

When compared to Spring (Webflux or Boot), Vertx is exceptionally fast. In my performance testing, I found Vertex to be 75% faster than Spring. Techempower has also shared more interesting results on their site: https://www.techempower.com/benchmarks/#section=data-r22. Now considering this, if you want to develop a state-of-the art application with high throughput, one should go for vertx, as it is Java's fastest unopinionated framework available today (Techempower's results also back this statement).

### Basics of Vertx

Vertx, out of the box, provides SQL and NoSQL clients. Whereas those clients are event-driven, non-blocking, and have low overhead.

### Why BoostDB?

BoostDB helps you code in a very similar way to what you are used to in Spring. Just because the learning curve of vertx itself is a little tricky, it will also be a bit messy to arrange your code in the best possible way. This project helps you in the best possible way to write performance-efficient code without worrying about the bits and pieces of low-end code.

# Dependency

### Repository

#### build.gradle

```kotlin

allprojects {

        repositories {

            maven ("https://jitpack.io")

        }

    }

```

#### pom.xml

```xml

  ...

  

      jitpack.io

      https://jitpack.io

  

```

### Dependency

#### build.gradle

```kotlin

dependencies {

  implementation ("com.github.Areeb-Gillani:vertx-boost-db:0.0.7")

}

```

#### pom.xml

```xml

  ...

	

	    com.github.Areeb-Gillani

	    vertx-boost-db

	    0.0.7

	

```

# Config

One can add multiple connection configurations in this way, and upon creating the repository, please make sure you pass the right connection name so that if the connection is not available in the application, it will be created.

```json

{

  "dbConnections": {

    "Primary": {

      "dbName": "example_database",

      "dbHost":"localhost",

      "dbPort": 3306,

      "dbUsername": "root",

      "dbPassword": "password",

      "dbConnectionPoolSize": 10,

      "dbType": "MYSQL",

      "dbRetryCount": 5,

      "dbRetryInterval": 1000

    },

    "MySecondConnection": {

      "dbName": "example_database",

      "dbHost":"192.168.1.10",

      "dbPort": 1521,

      "dbUsername": "root",

      "dbPassword": "password",

      "serviceName":"o19c"

      "dbConnectionPoolSize": 10,

      "dbType": "ORACLE",

      "dbRetryCount": 5,

      "dbRetryInterval": 1000

    }

  }

}

```

 

# Usage

This project out of the box gives CrudRepository, MySQLRepository, MSSQLRepository, PostgresRepository, and OracleRepository which a user can extend. It is preferred to use CrudRepository as its factory can create all types of repos based on the dbType attribute present in the connection configuration. 

 

```java

@Repository("MyDbConfig")

public class DatabaseRepo extends CrudRepository{

   public DatabaseRepo (String connectionName, JsonObject config){

      super(connectionName, config);

   }

    //Write other db operations here your CRUD operations are already covered above 

}

```

VertxBoost's ([![](https://jitpack.io/v/Areeb-Gillani/vertx-boost.svg)](https://jitpack.io/#Areeb-Gillani/vertx-boost)) service class has been used in order to demo the usage

```java

@Service("SomeWorker")

public class ExampleService extends AbstractService {

    @Autowired

    DatabaseRepo repo;

    //Please code other related stuff here.

}

```

#### Note: Please include the specific client driver in your build.gradle in order to make this code work.

```kotlin

    dependencies{

          implementation ("io.vertx:vertx-mysql-client:4.5.8")

    }

```