Skip to content

Latest commit

 

History

History
78 lines (64 loc) · 3.16 KB

README.md

File metadata and controls

78 lines (64 loc) · 3.16 KB
Raw

vertx-mongodata

An async access framework for mongodb

Import

Maven

<dependency>
  <groupId>info.pascalkrause</groupId>
  <artifactId>vertx-mongodata</artifactId>
  <version>0.0.2</version>
  <scope>compile</scope>
</dependency>

Gradle

compile 'info.pascalkrause:vertx-mongodata:0.0.2'

MongoCollection

MongoCollection is a tool to store objects of any type in a MongoDB. It's the nature of MongoDB, that it can only handle json objects. To store objects of another type, it's necessary to provide encode and decode functions. MongoCollection helps to bundle all necessary logic at one point.

MongoCollection provides actions to access and manipulate data in a MongoDB. A list of supported actions can be found here.

MongoCollectionFactory

MongoCollectionFactory is a factory to build MongoCollection instances. An instance of MongoCollectionFactory can be created by calling the using method with an instance of MongoClient or MongoService.

    public static MongoCollectionFactory using(MongoClient client);
    public static MongoCollectionFactory using(MongoService ms);

The MongoCollectionFactory itsef can create MongoCollection instances by calling the method build. The build method needs a collection name and functions to decode and encode the resource type.

public <T> MongoCollection<T> build(String collectionName, Function<T, JsonObject> encode, Function<JsonObject, T> decode);

Resource Transformation

If attributes of a resource don't fit to the JSON data types, have a look at MongoDB extend JSON support. This could be very helpful especially in the case that an attribute is a binary.

MongoService

With MongoService you can access a MongoDB via the Vertx EventBus with all advantages of MongoCollection. Just deploy a MongoServiceVerticle somewhere in the Vertx cluster and create a MongoService instance.

// Create MongoServiceVerticle with serviceAddress and MongoDB configurations
vertx.deployVerticle(new MongoServiceVerticle(serviceAddress, mongoConfig)

// Create a MongoService instance
MongoService ms = MongoService.createEventBusProxy(vertx, serviceAddress);

Contribute

We are using Gerrit, so PRs in Github will be ignored. Please use GerritHub.io to contribute changes. The project name is caspal/vertx-mongodata

Code Style

  1. Encoding must be in UTF-8.
  2. Change must have a commit message.
  3. The line endings must be LF (linux).
  4. The maximum length of a line should be between 80 and 120 characters.
  5. Use spaces instead of tabs.
  6. Use 4 spaces for indentation
    • If the project already uses 2, adapt the project rules
  7. No trailing whitespaces.
  8. Avoid unnecessary empty lines.
  9. Adapt your code to the surroundings.
  10. Follow the default language style guide.