https://github.com/cstamas/vertx-orientdb

https://github.com/cstamas/vertx-orientdb

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/cstamas/vertx-orientdb
• Owner: cstamas
• License: apache-2.0
• Created: 2016-04-29T22:23:40.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2017-11-21T14:55:03.000Z (about 7 years ago)
• Last Synced: 2024-10-02T09:59:10.686Z (4 months ago)
• Language: Java
• Size: 176 KB
• Stars: 7
• Watchers: 5
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

• vertx-awesome - OrientDB - Non-blocking OrientDB server integration. (Database Clients)

README

        
# Vert.x OrientDB Integration

Integrates [OrientDB 2.x](http://orientdb.com/docs/2.2/index.html) with Vert.x. It

supports `plocal`, `remote` and `memory` databases, and OrientGraph for graph/Tinkerpop 2.x

uses.

[![wercker status](https://app.wercker.com/status/ba9343552def99973ea803d929ba7c51/m "wercker status")](https://app.wercker.com/project/bykey/ba9343552def99973ea803d929ba7c51)

[![Maven](https://img.shields.io/maven-central/v/org.cstamas.vertx.orientdb/vertx-orientdb.svg)](https://repo1.maven.org/maven2/org/cstamas/vertx/orientdb/)

# Using it

To use the OrientDB in Vert.x, you need to include following dependency to your project:

```

    

      org.cstamas.vertx.orientdb

      database

      5.1.0

    

```

To use it in your code, you must perform these steps:

* instantiate manager

* open manager (with large databases this may be lengthy operation)

* create/open a named database instance

* use the database

Both, the database instance and manager implement `io.vertx.core.Closeable`. Closing database closes only the given

database, while closing manager closes all opened databases and the manager itself.

Examples found in the `vertx-orientdb-examples` subproject.

Integration configuration:

```

{

  "orientHome" : "orient",

  "serverEnabled" : false

}

```

The `orientHome` path should point to a directory (if not exists, will be created) where OrientDB Home is. OrientDB

"home" directory is where it's configuration, databases, etc. reside.

The `serverEnabled` boolean sets whether to enable OrientDB Server on startup, hence, allow *incoming remote

connections* to Vert.x managed OrientDB Server or not. When server enabled, the OrientDB server configuration is

searched on path `$orientHome/config/orientdb-server-config.xml` and all the "usual business" applies how OrientDB

configures itself (see OrientDB documentation). If server disabled, the integration still allows to access

local, in-memory or remote databases, but no incoming OrientDB connection (database or console) will be possible.

In that case, databases are placed in `$orientHome/databases` directory.

If server enabled, but no configuration provided, this integration will copy the "default" configuration to it's place

and use that, but that mode is not recommended for production use (configuration is copied from default OrientDB

distribution).

## Branches and building

* master - uses latest OrientDB 2.2.x and Vert.x 3.4

Have fun!  

~t~