OrientDB
OrientDB is a multi-model database, supporting graph, document, key/value, and object models, but the relationships are managed as in graph databases with direct connections between records. It supports schema-less, schema-full and schema-mixed modes. It has a strong security profiling system based on users and roles and supports querying with Gremlin along with SQL extended for graph traversal.
For more information about OrientDB please visit the official documentation, more details are available in the OrientDB manual.
The Alpakka OrientDB connector provides Akka Stream sources and sinks for OrientDB.
Project Info: Alpakka OrientDB | |
---|---|
Artifact | com.lightbend.akka
akka-stream-alpakka-orientdb
1.1.2
|
JDK versions | OpenJDK 8 |
Scala versions | 2.12.7, 2.11.12, 2.13.0 |
JPMS module name | akka.stream.alpakka.orientdb |
License | |
Readiness level |
Since 0.17, 2018-02-19
|
Home page | https://doc.akka.io/docs/alpakka/current |
API documentation | |
Forums | |
Release notes | In the documentation |
Issues | Github issues |
Sources | https://github.com/akka/alpakka |
Artifacts
- sbt
libraryDependencies += "com.lightbend.akka" %% "akka-stream-alpakka-orientdb" % "1.1.2"
- Maven
<dependency> <groupId>com.lightbend.akka</groupId> <artifactId>akka-stream-alpakka-orientdb_2.12</artifactId> <version>1.1.2</version> </dependency>
- Gradle
dependencies { compile group: 'com.lightbend.akka', name: 'akka-stream-alpakka-orientdb_2.12', version: '1.1.2' }
The table below shows direct dependencies of this module and the second tab shows all libraries it depends on transitively.
- Direct dependencies
Organization Artifact Version License com.orientechnologies orientdb-graphdb 3.0.13 Apache 2 com.orientechnologies orientdb-object 3.0.13 Apache 2 com.typesafe.akka akka-stream_2.12 2.5.23 Apache License, Version 2.0 org.scala-lang scala-library 2.12.7 BSD 3-Clause - Dependency tree
com.orientechnologies orientdb-graphdb 3.0.13 Apache 2 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 com.orientechnologies orientdb-server 3.0.13 Apache 2 com.orientechnologies orientdb-client 3.0.13 Apache 2 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 com.orientechnologies orientdb-tools 3.0.13 Apache 2 com.orientechnologies orientdb-client 3.0.13 Apache 2 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 javax.xml.bind jaxb-api 2.3.0 CDDL 1.1 com.sun.xml.bind jaxb-core 2.3.0.1 CDDL+GPL License com.sun.xml.bind jaxb-impl 2.3.0.1 CDDL+GPL License javax.mail mail 1.4.7 CDDL javax.activation activation 1.1 Common Development and Distribution License (CDDL) v1.0 javax.xml.bind jaxb-api 2.3.0 CDDL 1.1 com.orientechnologies orientdb-tools 3.0.13 Apache 2 com.orientechnologies orientdb-client 3.0.13 Apache 2 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 javax.xml.bind jaxb-api 2.3.0 CDDL 1.1 com.tinkerpop.blueprints blueprints-core 2.6.0 BSD 3-Clause com.carrotsearch hppc 0.6.0 The Apache Software License, Version 2.0 com.fasterxml.jackson.core jackson-databind 2.2.3 The Apache Software License, Version 2.0 com.fasterxml.jackson.core jackson-annotations 2.2.3 The Apache Software License, Version 2.0 com.fasterxml.jackson.core jackson-core 2.2.3 The Apache Software License, Version 2.0 commons-configuration commons-configuration 1.6 The Apache Software License, Version 2.0 commons-beanutils commons-beanutils-core 1.8.0 The Apache Software License, Version 2.0 commons-digester commons-digester 1.8 The Apache Software License, Version 2.0 commons-beanutils commons-beanutils 1.7.0 commons-lang commons-lang 2.4 The Apache Software License, Version 2.0 commons-logging commons-logging 1.1.1 The Apache Software License, Version 2.0 org.codehaus.jettison jettison 1.3.3 Apache License, Version 2.0 stax stax-api 1.0.1 The Apache Software License, Version 2.0 com.orientechnologies orientdb-object 3.0.13 Apache 2 com.orientechnologies orientdb-core 3.0.13 Apache 2 com.googlecode.concurrentlinkedhashmap concurrentlinkedhashmap-lru 1.4.2 The Apache Software License, Version 2.0 net.java.dev.jna jna-platform 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 net.java.dev.jna jna 4.5.0 LGPL, version 2.1 org.lz4 lz4-java 1.4.0 The Apache Software License, Version 2.0 org.hibernate.javax.persistence hibernate-jpa-2.0-api 1.0.1.Final Unknown License org.javassist javassist 3.23.1-GA MPL 1.1 com.typesafe.akka akka-stream_2.12 2.5.23 Apache License, Version 2.0 com.typesafe.akka akka-actor_2.12 2.5.23 Apache License, Version 2.0 com.typesafe config 1.3.3 Apache License, Version 2.0 org.scala-lang.modules scala-java8-compat_2.12 0.8.0 BSD 3-clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause com.typesafe.akka akka-protobuf_2.12 2.5.23 Apache License, Version 2.0 org.scala-lang scala-library 2.12.7 BSD 3-Clause com.typesafe ssl-config-core_2.12 0.3.7 Apache-2.0 com.typesafe config 1.3.3 Apache License, Version 2.0 org.scala-lang.modules scala-parser-combinators_2.12 1.1.1 BSD 3-clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause org.reactivestreams reactive-streams 1.0.2 CC0 org.scala-lang scala-library 2.12.7 BSD 3-Clause org.scala-lang scala-library 2.12.7 BSD 3-Clause
Database connection
Sources, Flows and Sinks provided by this connector need a OPartitionedDatabasePool
to access to OrientDB. It is your responsibility to close the database connection eg. at actor system termination. This API has become deprecated in OrientDB, please suggest a Pull Request to use the latest APIs instead.
- Scala
-
import com.orientechnologies.orient.core.db.OPartitionedDatabasePool val url = "remote:127.0.0.1:2424/" val dbName = "GratefulDeadConcertsScala" val dbUrl = s"$url$dbName" val username = "root" val password = "root" val oDatabase: OPartitionedDatabasePool = new OPartitionedDatabasePool(dbUrl, username, password, Runtime.getRuntime.availableProcessors(), 10) system.registerOnTermination(() -> oDatabase.close())
- Java
-
import com.orientechnologies.orient.core.db.OPartitionedDatabasePool; private static String url = "remote:127.0.0.1:2424/"; private static String dbName = "GratefulDeadConcertsJava"; private static String dbUrl = url + dbName; private static String username = "root"; private static String password = "root"; oDatabase = new OPartitionedDatabasePool( dbUrl, username, password, Runtime.getRuntime().availableProcessors(), 10); system.registerOnTermination(() -> oDatabase.close());
Reading ODocument
from OrientDB
Now we can stream messages which contain OrientDB’s ODocument
(in Scala or Java) from or to OrientDB by providing the ODatabaseDocumentTx
to the OrientDbSource
OrientDbSource
.
- Scala
-
val result: Future[immutable.Seq[String]] = OrientDbSource( sink4, OrientDbSourceSettings(oDatabase) ).map { message: OrientDbReadResult[ODocument] => message.oDocument.field[String]("book_title") } .runWith(Sink.seq)
- Java
-
CompletionStage<List<String>> result = OrientDbSource.create(sinkClass1, OrientDbSourceSettings.create(oDatabase)) .map(m -> m.oDocument().<String>field("book_title")) .runWith(Sink.seq(), materializer);
Typed messages
Also, it’s possible to stream messages which contains any classes.
- Java
-
public static class source1 { private String book_title; public void setBook_title(String book_title) { this.book_title = book_title; } public String getBook_title() { return book_title; } } public static class sink2 { private String book_title; public void setBook_title(String book_title) { this.book_title = book_title; } public String getBook_title() { return book_title; } }
Use OrientDbSource.typed
and OrientDbSink.typed
to create source and sink instead.
- Scala
-
val streamCompletion: Future[Done] = OrientDbSource .typed(sourceClass, OrientDbSourceSettings(oDatabase), classOf[OrientDbTest.source1]) .map { m: OrientDbReadResult[OrientDbTest.source1] => val db: ODatabaseDocumentTx = oDatabase.acquire db.setDatabaseOwner(new OObjectDatabaseTx(db)) ODatabaseRecordThreadLocal.instance.set(db) val sink: OrientDbTest.sink2 = new OrientDbTest.sink2 sink.setBook_title(m.oDocument.getBook_title) OrientDbWriteMessage(sink) } .groupedWithin(10, 10.millis) .runWith(OrientDbSink.typed(sinkClass2, OrientDbWriteSettings.create(oDatabase), classOf[OrientDbTest.sink2]))
- Java
-
CompletionStage<Done> f1 = OrientDbSource.typed( sourceClass, OrientDbSourceSettings.create(oDatabase), source1.class, null) .map( readResult -> { ODatabaseDocumentTx db = oDatabase.acquire(); db.setDatabaseOwner(new OObjectDatabaseTx(db)); ODatabaseRecordThreadLocal.instance().set(db); sink2 sink = new sink2(); sink.setBook_title(readResult.oDocument().getBook_title()); return OrientDbWriteMessage.create(sink); }) .groupedWithin(10, Duration.ofMillis(10)) .runWith( OrientDbSink.typed( sinkClass2, OrientDbWriteSettings.create(oDatabase), sink2.class), materializer);
Source configuration
We can configure the source by OrientDbSourceSettings
.
- Scala
-
// re-iterating default values val sourceSettings = OrientDbSourceSettings(oDatabase) .withSkip(0) .withLimit(10)
- Java
-
// re-iterating default values OrientDbSourceSettings sourceSettings = OrientDbSourceSettings.create(oDatabase).withSkip(0).withLimit(10);
Parameter | Default | Description |
---|---|---|
skip | 0 | Rows skipped in the beginning of the result. |
limit | 10 | Result items fetched per query. |
Writing to OrientDB
You can also build flow stages. The API is similar to creating Sinks.
- Scala
-
val f1 = OrientDbSource( sourceClass, OrientDbSourceSettings(oDatabase) ).map { message: OrientDbReadResult[ODocument] => OrientDbWriteMessage(message.oDocument) } .groupedWithin(10, 50.millis) .via( OrientDbFlow.create( sink5, OrientDbWriteSettings(oDatabase) ) ) .runWith(Sink.seq) - Java
-
CompletionStage<List<List<OrientDbWriteMessage<ODocument, NotUsed>>>> f1 = OrientDbSource.create(sourceClass, OrientDbSourceSettings.create(oDatabase), null) .map(m -> OrientDbWriteMessage.create(m.oDocument())) .groupedWithin(10, Duration.ofMillis(10)) .via(OrientDbFlow.create(sink3, OrientDbWriteSettings.create(oDatabase))) .runWith(Sink.seq(), materializer);
Passing data through OrientDBFlow
When streaming documents from Kafka, you might want to commit to Kafka AFTER the document has been written to OrientDB.
- Scala
-
// We're going to pretend we got messages from kafka. // After we've written them to oRIENTdb, we want // to commit the offset to Kafka case class KafkaOffset(offset: Int) case class KafkaMessage(book: Book, offset: KafkaOffset) val messagesFromKafka = List( KafkaMessage(Book("Book 1"), KafkaOffset(0)), KafkaMessage(Book("Book 2"), KafkaOffset(1)), KafkaMessage(Book("Book 3"), KafkaOffset(2)) ) var committedOffsets = List[KafkaOffset]() def commitToKafka(offset: KafkaOffset): Unit = committedOffsets = committedOffsets :+ offset val f1 = Source(messagesFromKafka) .map { kafkaMessage: KafkaMessage => val book = kafkaMessage.book val id = book.title println("title: " + book.title) OrientDbWriteMessage(new ODocument().field("book_title", id), kafkaMessage.offset) } .groupedWithin(10, 50.millis) .via( OrientDbFlow.createWithPassThrough( sink7, OrientDbWriteSettings(oDatabase) ) ) .map { messages: Seq[OrientDbWriteMessage[ODocument, KafkaOffset]] => messages.foreach { message => commitToKafka(message.passThrough) } } .runWith(Sink.ignore)
- Java
-
// We're going to pretend we got messages from kafka. // After we've written them to OrientDB, we want // to commit the offset to Kafka List<Integer> committedOffsets = new ArrayList<>(); List<messagesFromKafka> messagesFromKafkas = Arrays.asList( new messagesFromKafka("Akka Concurrency", new KafkaOffset(0)), new messagesFromKafka("Akka in Action", new KafkaOffset(1)), new messagesFromKafka("Effective Akka", new KafkaOffset(2))); Consumer<KafkaOffset> commitToKafka = new Consumer<KafkaOffset>() { @Override public void accept(KafkaOffset kafkaOffset) { committedOffsets.add(kafkaOffset.getOffset()); } }; Source.from(messagesFromKafkas) .map( kafkaMessage -> { String book_title = kafkaMessage.getBook_title(); return OrientDbWriteMessage.create( new ODocument().field("book_title", book_title), kafkaMessage.kafkaOffset); }) .groupedWithin(10, Duration.ofMillis(10)) .via(OrientDbFlow.createWithPassThrough(sink6, OrientDbWriteSettings.create(oDatabase))) .map( messages -> { ODatabaseDocumentTx db = oDatabase.acquire(); db.setDatabaseOwner(new OObjectDatabaseTx(db)); ODatabaseRecordThreadLocal.instance().set(db); messages.stream() .forEach( message -> { commitToKafka.accept(((KafkaOffset) message.passThrough())); }); return NotUsed.getInstance(); }) .runWith(Sink.seq(), materializer) .toCompletableFuture() .get(10, TimeUnit.SECONDS);