Getting Started

As explained in the introduction, there are both client and server components to Breeze. Here we will tell you how to get both.

Downloading Breeze - JavaScript Client

You can get the latest build of BreezeJS from github. You’ll need either breeze.debug.js or breeze.min.js.

Prerequisites and Add-ons

BreezeJS requires 3rd-party libraries for its promise implementation and for its AJAX implementation.

If you are using AngularJS

Get breeze.bridge.angular.js. This sets up Breeze to use AngularJS’s $q for promises, and $http for AJAX. In your index.html you should have, in order:

<script src="Scripts/angular.js"></script>
<script src="Scripts/breeze.debug.js"></script>
<script src="Scripts/breeze.bridge.angular.js"></script>

See the Todo-AngularJS-Hibernate sample for an example Breeze+AngularJS application.

If you are using Aurelia

Get aurelia-breeze. This sets up breeze to use ES6 promises and Aurelia’s http-client for AJAX. In your index.html you’ll have just the bootstrapping code, since Aurelia uses modules. See the aurelia-breeze-northwind sample.

If you are using KnockoutJS

Get Q.js (for promises) and jQuery (for AJAX). You will also need the KO model libary for change tracking between Knockout and Breeze. In your index.html you should have, in order:

<script src="Scripts/jquery.min.js"></script>
<script src="Scripts/knockout.js"></script>
<script src="Scripts/q.min.js"></script>
<script src="Scripts/breeze.debug.js"></script>
<script src="Scripts/breeze.modelLibrary.ko.js"></script>

If you are using BackboneJS

Get Q.js (for promises) and jQuery (for AJAX). You will also need the Backbone model libary for change tracking between Backbone and Breeze. In your index.html you should have, in order:

<script src="Scripts/jquery.min.js"></script>
<script src="Scripts/underscore.js"></script>    
<script src="Scripts/backbone.js"></script> 
<script src="Scripts/q.min.js"></script>
<script src="Scripts/breeze.debug.js"></script>
<script src="Scripts/breeze.modelLibrary.backbone.js"></script>

Configuring the Client

There are two different URI formats that the Breeze client can use to send queries to the server: OData and JSON.

The Breeze Java Server only understands the JSON format, so you’ll need to configure the client:

breeze.core.config.initializeAdapterInstance("uriBuilder", "json");

Downloading Breeze - Java Server


Maven is a project management system that automatically downloads project dependencies during the build process. Breeze has a dedicated Maven repository on github. To use it, you will need to add the repository to your project’s POM file:

        <name>Breeze Repository</name>

Then you add the actual dependency information for breeze-hibernate and breeze-webserver:


JAR Download

If you are not using Maven, you can download the JARs manually from github:



Build it yourself

If you wish, you can build the Breeze JARs yourself. The Breeze code is open source and available at There are five projects:

  1. breeze-hibernate: Handles metadata, query, and save requests through Hibernate
  2. breeze-webserver: Handles HTTP requests and JSON serialization in front of breeze-hibernate.
  3. breeze-northwind: Data model for the Northwind database, used for integration testing
  4. breeze-webtest: Web app for running breeze integration tests.
  5. breeze-webtest-jersey: Jersey web app for running breeze integration tests.

Only the first two are needed for building a Breeze application. The others are for testing the Breeze features during development. Each project is set up for development using Eclipse and for builds using Maven. The build directory contains a master pom.xml that builds all the projects in the correct order.


The breeze-webserver library implements servlets to handle requests from the Breeze client. It extracts the data from the request and passes it on to breeze-hibernate. More information is found in the breeze-webserver topic page.


The breeze-hibernate library implements classes to perform the server-side data manipulation with Hibernate.

  • Generates Breeze metadata from Hibernate mappings
  • Parses breeze client EntityQuery instances encoded as JSON into Criteria queries
  • Executes these queries using Hibernate Sessions
  • Expands graphs of related entites using lazy loading.
  • Serializes query results to JSON, using $id/$ref syntax for handling references
  • Handles saving Breeze payloads in Hibernate

Using the API

There are three main classes that you will use to do most of the work: HibernateQueryProcessor, HibernateSaveProcessor, and HibernateMetadata. Each of these is a subclass of the generic QueryProcessor, SaveProcessor and Metadata classes respectively. Use of these classes is described in the following pages.