Skip to content

Latest commit

 

History

History
88 lines (59 loc) · 5.91 KB

Java-API.md

File metadata and controls

88 lines (59 loc) · 5.91 KB
Raw

Java API

OrientDB is written completely in the Java language. This means that you can use its Java API's without needing to install any additional drivers or adapters.

For more information, see the OrientDB Java Documentation

Component Architecture

image

OrientDB provides three different Java API's that allow you to work with OrientDB.

  • Graph API Use this Java API if you work with graphs and want portable code across TinkerPop Blueprints implementations. It is easiest to switch to this when migrating from other Graph Databases, such as Neo4J or Titan. If you used TinkerPop standard on these, you can use OrientDB as a drop-in replacement.
  • Document API Use this Java API if your domain fits Document Database use case with schema-less structures. It is easiest to switch to this when migrating from other Document Databases, such as MongoDB and CouchDB.
  • Object API Use this Java API if you need a full Object Oriented abstraction that binds all database entities to POJO (that is, Plain Old Java Objects). It is easiest to switch to this when migrating from JPA applications.

Each Java API has its own pros and cons. For more information on determining which Java API to use with your application, see Choosing between the Graph or Document API.

Graph Document Object
API Graph API Document API Object Database
Java class OrientGraph ODatabaseDocumentTx OObjectDatabaseTx
Query Yes Yes Yes
Schema Less Yes Yes Yes
Schema full Yes Yes Yes
Speed1 90% 100% 50%

1: Speed comparisons show for generic CRUD operations, such as queries, insertions, updates and deletions. Large values are better, where 100% indicates the fastest possible.

In general, the cost of high-level abstraction is a speed penalty, but remember that OrientDB is orders of magnitude faster than the class Relational Database. So, using the Object Database provides a high-level of abstraction with much less code to develop and maintain.

Graph API

With this Java API, you can use OrientDB as a Graph Database, allowing you to work with Vertices and Edges. The Graph API is compliant with the TinkerPop standard.

API: Graph API

Document API

With this Java API, you can handle records and documents. Documents are comprised of fields and fields can be any of the supported types. You can use it with a schema, without, or in a mixed mode.

Additionally, it does not require a Java domain POJO, as is the case with Object Databases.

API: Document API

Object API

With this Java API, you can use OrientDB with JPA-like interfaces where POJO, (that is, Plain Old Java Objects), are automatically bound to the database as documents. You can use this in schema-less or schema-full modes.

Bear in mind that this Java API has not received improvements since OrientDB version 1.5. Consider using the Document API or Graph API instead, with an additional layer to map to your POJO's.

While you can use both the Graph API and Document API at the same time, the Object API is only compatible with the Document API. It doesn't work well with the Graph API. The main reason is that it requires you to create POJO's that mimic the Vertex and Edge classes, which provides sub-optimal performance in comparison with using the Graph API directly. For this reason, it is recommended that you don't use the Object API with a Graph domain. To evaluate Object Mapping on top of OrientDB Blueprints Graph API, see TinkerPop Frames, Ferma and Totorom.

API: Object Database

Supported Libraries

OrientDB ships with a number of JAR files in the $ORIENTDB_HOME/lib directory.

  • orientdb-core-*.jar Provides the core library.
    • Required: Always.
    • Dependencies: snappy-*.jar
    • Performance Pack (Optional):
      • orientdb-nativeos-*.jar
      • jna-*.jar
      • jna-platform-*.jar.
  • orientdb-client-*.jar Provides the remote client.
    • Required: When your application connects with a remote server.
  • orientdb-enterprise-*.jar Provides the base package with the protocol and network classes shared by the client and server. Deprecated since version 2.2.
    • Required: When your application connects to a remote server.
  • orientdb-server-*.jar Provides the server component.
    • Required: When building an embedded server. Used by the OrientDB Server.
  • orientdb-tools-*.jar Provides the console and console commands.
    • Required: When you need to execute console commands directly through your application. Used by the OrientDB Console.
  • orientdb-object-*.jar Provides the Object Database interface.
    • Required: When you want to use this interface.
    • Dependencies: javassist.jar and persistence-api-1.0.jar.
  • orientdb-graphdb-*.jar Provides the Graph Database interface.
    • Required: When you want to use this interface.
    • Dependencies: blueprints-core-*.jar.
  • orientdb-distributed-*.jar Provides the distributed database plugin.
    • Required: When you want to use a server cluster.
    • Dependencies: hazelcast-*.jar.