You are currently browsing legacy 3.0 version of documentation. Click here to switch to the newest 4.2 version.

We can help you with migration to the latest RavenDB

Contact Us Now
see on GitHub

How to create a document store?

To create an instance of the DocumentStore you need to specify the URL address that points to the RavenDB server. The URL must contains the TCP port on which the server is listening (the default port number is 8080).

try (IDocumentStore store = new DocumentStore("http://localhost:8080").initialize()) {
  // ...
}

This will instantiate a communication channel between your application and the local RavenDB server instance.

Initialization and disposal

The above code contains two things you should pay special attention. The first one is that you have to call initialize method on the DocumentStore to get the fully initialized instance of IDocumentStore that you will be able to work with. The second thing you should note is that the whole DocumentStore initialization code is placed inside the try statement to ensure the object disposal. This is needed to guarantee a proper cleanup. In a real case scenario it should be done when an application shuts down.

Singleton

Because the document store is a heavyweight object, it should be only one instance created per application (singleton). The document store is a thread safe object and its typical initialization looks like below:

public static class DocumentStoreHolder {
  private static IDocumentStore store;

  public static IDocumentStore getInstance() {
    if (store == null) {
      synchronized (DocumentStoreHolder.class) {
        if (store == null) {
          store = createStore();
        }
      }
    }
    return store;
  }

  @SuppressWarnings("hiding")
  private static IDocumentStore createStore() {
    IDocumentStore store = new DocumentStore("http://localhost:8080", "Northwind");
    store.initialize();
    return store;
  }
}