Skip to main content
Jump to: navigation, search


EclipseLink JPA

Mailing ListForumsIRCmattermost
OpenHelp WantedBug Day
Browse Source


NoSQL is a classification of database systems that do not support the SQL standard. These include document databases, key-value stores, and various other non-standard databases. EclipseLink supports persistence of Java objects to NoSQL databases through the Java Persistence API (JPA). EclipseLink's native API is also supported with NoSQL databases.

The NoSQL classification can also be expanded to include Enterprise Information Systems (EIS) including application databases, legacy databases, messaging systems, and transaction processing monitors.

EclipseLink's NoSQL support includes:

  • MongoDB
  • Oracle NoSQL
  • XML files
  • JMS
  • Oracle AQ


Mapping to NoSQL data is configured through the EclipseLink @NoSQL annotation, and <no-sql> XML element. @NoSQL defines the class as mapping to non-relational data. @NoSQL can be specified with @Entity or @Embeddable classes.

The @NoSQL annotation defines a dataType and a dataFormat. The dataType is name for the entities structure, the meaning of the dataType is dependent on the NoSQL platform. For MongoDB, it is the collection name that the JSON documents are stored to. For Oracle NoSQL the dataType is the first part of the major key value. For the XML file adapter it is the file name.

The dataFormat specifies the type of structure the data is stored as. The dataFormat is defined by the DataFormatType enum. Three types of NoSQL data formats are supported:

  • XML - maps a class to an XML document, this can be used with XML data-stores, XML files, XML messaging systems, and other XML systems.
  • MAPPED - maps a class to a set of nested key/value pairs, a value can be an embedded map or list. This can be used to map to key/value stores, JSON databases, and other structured data systems.
  • INDEXED - maps a class to an array of values.

The dataFormat is dependent on the NoSQL platform. MongoDB must use the MAPPED format. Oracle NoSQL can use either the MAPPED format for key/value data, or the XML format for a single XML document value. XML files and XML messaging use the XML format.

NoSQL MAPPED example

@NoSQL(dataType="orders", dataFormat=DataFormatType.MAPPED)
public class Order {
  private long id;
  private String description;
  private Address deliveryAddress
  private List<OrderLine> orderLines;
  private Customer customer;
public class OrderLine {
    private int lineNumber;
    private String itemName;
    private int quantity;  

This would produce the following mapped data. The mapped format could map to many different structures, this example shows it as a JSON document.

  "_id": "4F99702B271B1948027FAF06",
  "description": "widget order",
  "deliveryAddress": {
      "street": "1712 Hasting Street",
      "city": "Ottawa",
      "province": "ON",
      "postalCode": "L5J1H5",
  "orderLines": [
      {"lineNumber": "1", "itemName": "widget A", "quantity": "5"},
      {"lineNumber": "2", "itemName": "widget B", "quantity": "1"},
      {"lineNumber": "3", "itemName": "widget C", "quantity": "2"}
  "customerId": "4F99702B271B1948027FAF08",

Version: 2.4.0 DRAFT
Other versions...

Back to the top