Java API - Reference
OrientDB is written in Java and as such you can utilize the Java API without the need for any additional drivers or adapters. Instead, with the addition of a dependency you can import OrientDB's code directly into your application to either query or manipulate data from a running instance of OrientDB or to embed the OrientDB Server itself within your application.
This chapter provides reference documentation for the OrientDB Java API. The list of classes and methods documented here is not exhaustive, but rather pragmatic: focusing on those developers are more likely to use in building applications around OrientDB.
Classes
Class | Description |
---|---|
OClass |
Manages database classes |
OCluster |
Manages physical and memory clusters |
ODatabaseDocument |
Manages databases. This is the unified multi-model API. It works with all supported database models (i.e., graph, document, object and so on). |
ODatabaseSession |
Subclass of ODatabaseDocument , used to manage database sessions. |
OEdge |
Handles edge records. It is a subclass of OElement |
OElement |
Handles document records, superclass to OVertex and OEdge records |
OFunctionLibrary |
Manages the functions available in OrientDB SQL on the database |
OIntent |
Manages intents (server optimizations) for particular tasks |
OLiveQueryResultListener |
Super class used to manage Live Queries |
OMetadata |
Interface used to store database metadata, such as the function library, schema and security |
OProperty |
Manages properties on an OClass instance |
OResult |
Interface for operating on records in a result-set |
OResultSet |
Result-set returned by queries |
ORID |
Record ID for OElement , OEdge and OVertex instances |
OrientDB |
Connects to and interacts with the OrientDB Server |
ORule |
Defines rule for resources that a user or role can access |
OSchema |
Defines a schema for the database to enforce |
OSecurityRole |
Controls a role and the access it has to database resources |
OSecurityUser |
Controls a user and the access it has to database resources |
OServer |
Embeds the OrientDB Server |
OTransaction |
Controls a transaction on the database |
OType |
Defines the data-types of properties |
OVertex |
Handles vertex records. It is a subclass of OElement |
In the event that you don't find a page for the class or method you're looking for, see the Javadocs.