Open a Session

• Use openSession() to open a session from the Document Store.
• The following overloads are available:

// Open session for a 'default' database configured in 'DocumentStore'
public function openSession(): DocumentSessionInterface;

// Open session for a specified database
public function openSession(string $database): DocumentSessionInterface;

public function openSession(SessionOptions $sessionOptions): DocumentSessionInterface;

• The sessionOptions object contains various options to configure the Session's behavior.

• Experts Only:

Example 1

$store->openSession(new SessionOptions());

Example 2

$sessionOptions = new SessionOptions();
$sessionOptions->setDatabase($databaseName);
$store->openSession($sessionOptions);

Example 3 - Releasing session resources

$session = $store->openSession();
try {
    // code here
} finally {
    $session->close();
}

Example 4 - Disable entities tracking

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

    // because NoTracking is set to 'true'
    // each load will create a new Employee instance
    $this->assertNotSame($employee1, $employee2);
} finally {
    $session->close();
}

Example 5 - Disable session caching

$sessionOptions = new SessionOptions();
$sessionOptions->setNoCaching(true);
$session = $store->openSession();
try {
    // code here
} finally {
    $session->close();
}