

Configuration¶

Core orient integration is provided by OrientModule:

install(new OrientModule(url, user, password));

See orient documentation for supported db types. In short:

'memory:dbname' to use in-memory database
'plocal:dbname' to use embedded database (no server required, local fs folder will be used); db name must be local fs path
'remote:dbname' to use remote db (you need to start server to use it)

By default use admin/admin user.

Auto database creation¶

Auto database creation for local types (all except 'remote') is enabled by default, but you can switch it off. Auto creation is nice for playing/developing/testing phase, but most likely will not be useful for production.

install(new OrientModule(url, user, password)
                .autoCreateLocalDatabase(false));

Default transaction type¶

Default transactions configuration may be specified as additional module parameter. By default, OPTIMISTIC transactions used (use optimistic locking based on object version, same way as hibernate optimistic locking). NOTX mode disables transactions.

For example, to switch off transactions use:

install(new OrientModule(url, user, password)
                .defaultTransactionConfig(new TxConfig(OTransaction.TXTYPE.NOTX));

Custom orient types¶

You may need to use orient custom types (custom converter to/from object, used only in object connection).

To register custom type:

install(new OrientModule(url, user, password)
                .withCustomTypes(MyTypeSerializer.class));

where MyTypeSerializer implements OObjectSerializer

Serializers are assumed to be guice beans: declare it in guice module if required, otherwise guice JIT will be used to obtain converter instance.

Custom converters are collected using guice multibinder feature, so you can also install custom converter by using multibinder directly:

Multibinder.newSetBinder(binder(), OObjectSerializer.class)
        .addBinding().to(serializerClass);

Scheme initialization¶

To initialize (or migrate) scheme register implementation of

ru.vyarus.guice.persist.orient.db.scheme.SchemeInitializer

Example:

install(new OrientModule(url, user, password));
bind(SchemeInitializer.class).to(MySchemeInitializer.class);

Scheme initializer is called in NOTX unit of work (orient requires database scheme updates to be performed without transaction).

By default, no-op implementation enabled.

Object scheme mapping¶

If you use object api you can use provided object scheme mapper to create (or update) database from pojo beans (JPA like).

Tip

it is also able to mix object mapping with graph types, so you can mix object and graph apis (see @EdgeType and @VertexType).

See object scheme mapper guide for details.

Note

Custom migration annotations could be easily added.

Data initialization¶

To initialize (or migrate) data register implementation of

ru.vyarus.guice.persist.orient.db.data.DataInitializer

By default, no-op implementation enabled.

Example:

bind(DataInitializer.class).to(YourDataInitializerImpl.class);

Initializer is called WITHOUT predefined unit of work, because of different possible requirements. You should define unit of work (maybe more than one) yourself (with annotation or manual).

Lifecycle¶

You need to manually start/stop persist service in your code (because only you can control application lifecycle). On start connection pools will be initialized, database created (if required) and scheme/data initializers called. Stop will shutdown all connection pools.

@Inject
PersistService orientService

public void onAppStartup(){
    orientService.start()
}

public void onAppShutdown(){
    orientService.stop()
}

Orient configuration¶

Configuration could be done on instance:

db.getStorage().getConfiguration()

Or globally:

OGlobalConfiguration.MVRBTREE_NODE_PAGE_SIZE.setValue(2048);

Read about all configuration options