EclipseLink/UserGuide/JPA/Advanced JPA Development/NoSQL/Configuring

Notice: This Wiki is now read only and edits are no longer possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

< EclipseLink‎ | UserGuide‎ | JPA‎ | Advanced JPA Development‎ | NoSQL

For EclipseLink 2.4 (and newer) refer to "Understanding Non-relational Data Sources" in the EclipseLink Concepts Guide: http://www.eclipse.org/eclipselink/documentation/2.4/concepts/nosql.htm and "@NoSQL" in the EclipseLink JPA Extensions Reference Guide : http://www.eclipse.org/eclipselink/documentation/2.4/jpa/extensions/a_nosql.htm

EclipseLink JPA

EclipseLink
Website
Download
Community
Mailing List • Forums • IRC • mattermost
Issues
Open • Help Wanted • Bug Day
Contribute
Browse Source

Key API

Native API

EISDescriptor

1 @NoSql
- 1.1 NoSql MAPPED example
- 1.2 NoSQL XML example
2 Mapping Restrictions

@NoSql

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

@Entity
@NoSql(dataType="orders", dataFormat=DataFormatType.MAPPED)
public class Order {
  @Id
  @GeneratedValue
  @Field(name="_id")
  private long id;
  @Basic
  @Field(name="description")
  private String description;
  @Embedded
  @Field(name="deliveryAddress")
  private Address deliveryAddress
  @ElementCollection
  @Field(name="orderLines")
  private List<OrderLine> orderLines;
  @ManyToOne
  @JoinField(name="customerId")
  private Customer customer;
}
 
@Embeddable
@NoSql(dataFormat=DataFormatType.MAPPED)
public class OrderLine {
    @Field(name="lineNumber")
    private int lineNumber;
    @Field(name="itemName")
    private String itemName;
    @Field(name="quantity")
    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",
}

NoSQL XML example

@Entity
@NoSql(dataType="order")
public class Order {
  @Id
  @GeneratedValue
  @Field(name="@id")
  private long id;
  @Basic
  @Field(name="@description")
  private String description;
  @Embedded
  @Field(name="delivery-address")
  private Address deliveryAddress
  @ElementCollection
  @Field(name="orderLines/order-line")
  private List<OrderLine> orderLines;
  @ManyToOne
  @JoinField(name="customer-id")
  private Customer customer;
}
 
@Embeddable
@NoSql
public class OrderLine {
    @Field(name="@line-number")
    private int lineNumber;
    @Field(name="@item-name")
    private String itemName;
    @Field(name="@quantity")
    private int quantity;  
}

This would produce the following XML data.

<order id="4F99702B271B1948027FAF06" description="widget order">
  <deliveryAddress street="1712 Hasting Street" city="Ottawa" province="ON" postalCode="L5J1H5"/>
  <order-lines>
      <order-line lineNumber="1" itemName="widget A" quantity="5"/>
      <order-line lineNumber="2" itemName="widget B" quantity="1"/>
      <order-line lineNumber="3" itemName="widget C" quantity="2"/>
  <order-lines>
  <customer-id>4F99702B271B1948027FAF08</customer-id>
<order>

Mapping Restrictions

NoSql supports most JPA annotations, but some are not supported, and others have different restrictions than mapping relational data.

Supported mapping annotations:

@Entity - defines a root level object in the NoSQL data-store.
@Embeddable - defines an object embedded in another object's data structure.
@Basic, @Temporal, @Enumerated, @Lob - are supported.
@Convert, @Converter, @TypeConverter, @ObjectTypeConverter - are supported.
@Access, @Transient, @Mutable - are supported.
@Id, @EmbeddedId - are supported.
@GeneratedValue, @UuidGenerator - are supported.
@Version - is supported, but dependent on the NoSQL data-source to validate version write conflicts.
@Embedded - defines a reference that will be embedded in the parent's data structure as a nested structure.
@ElementCollection - defines a collection of values or embeddables that will be embedded in the parent's data structure as a list of nested structures.
@OneToOne, @ManyToOne - define a relationship to another root level object stored as a foreign key in the source object's data structure.
@OneToMany, @ManyToMany - define a relationship to a collection of other root level object stored as a list of foreign keys in the source object's data structure.
@Inheritance, @MappedSuperclass, @ClassExtractor - are supported.
@Cacheable, @Cache, @ReadOnly, @Noncacheable - are supported.
@NamedQuery - is supported on NoSQL data-sources that support querying.
@NamedNativeQuery - is supported on NoSQL data-sources that support native querying. The query language is not SQL, but specific to the NoSQL data-store.
@EntityListeners, @PrePersist, @PreUpdate, @PreRemove, @PreLoad, @PostPersist, @PostUpdate, @PostRemove, @PostLoad - are supported.
@Customizer - is supported.

Unsupported mapping annotations:

@Table, @SecondaryTable - are not supported with NoSQL, as objects are not mapped to tables, it is replaced by the dataType on the @NoSql annotation.
@Column - @Field should be used for NoSQL, as data is not stored in table columns, however @Column is still allowed, but just the name will be used.
@JoinColumn - is not supported with NoSQL, it is replaced by @JoinField.
@JoinTable - is not required or supported with NoSQL, OneToManys and ManyToManys are stored as collections of ids embedded in the source object's data structure.
@CollectionTable - is not required or supported with NoSQL, ElementCollections are embedded in the parent object's data structure.
@MapKeyColumn, @MapKeyClass, @MapKeyJoinColumn - are not currently supported.
@OrderBy, @OrderColumn - are not normally required or supported, as order in normally maintained by the object's data structure.
@SequenceGenerator, @TableGenerator - are not directly supported.
@AttributeOverride, @AssociationOverride - are supported with inheritance, but are not supported or required with embedded relationships as embedded objects are nested in their parent object's data structure, not flatten as in the case of relational data.
@JoinFetch, @BatchFetch are not supported.