Open a Session

To open session use the openSession method from DocumentStore.

Syntax

There are three overloads of openSession methods

// Open session for a 'default' database configured in 'DocumentStore'
IDocumentSession openSession();

// Open session for a specified database
IDocumentSession openSession(String database);

IDocumentSession openSession(SessionOptions sessionOptions);

The first method is an equivalent of doing

store.openSession(new SessionOptions());

The second method is an equivalent of doing

SessionOptions sessionOptions = new SessionOptions();
sessionOptions.setDatabase(databaseName);
store.openSession(sessionOptions);

Options

private String database;
private boolean noTracking;
private boolean noCaching;
private RequestExecutor requestExecutor;
private TransactionMode transactionMode;

// getters and setters

Example I

try (IDocumentSession session = store.openSession()) {
    // code here
}

Example II - Disabling Entities Tracking

SessionOptions sessionOptions = new SessionOptions();
sessionOptions.setNoTracking(true);
try (IDocumentSession session = store.openSession()) {
    Employee employee1 = session.load(Employee.class, "employees/1-A");
    Employee employee2 = session.load(Employee.class, "employees/1-A");

    // because NoTracking is set to 'true'
    // each load will create a new Employee instance
    Assert.assertNotSame(employee1, employee2);
}

Remarks