<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>The MongoDB\Driver\Session class</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-bulkwrite.update.html">MongoDB\Driver\BulkWrite::update</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-session.aborttransaction.html">MongoDB\Driver\Session::abortTransaction</a></div>
<div class="up"><a href="book.mongodb.html">MongoDB\Driver</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="class.mongodb-driver-session" class="reference">
<h1 class="title">The MongoDB\Driver\Session class</h1>
<div class="partintro"><p class="verinfo">(mongodb >=1.4.0)</p>
<div class="section" id="mongodb-driver-session.intro">
<h2 class="title">Introduction</h2>
<p class="para">
The <strong class="classname">MongoDB\Driver\Session</strong> class represents a
client session and is returned by
<span class="methodname"><a href="mongodb-driver-manager.startsession.html" class="methodname">MongoDB\Driver\Manager::startSession()</a></span>. Commands,
queries, and write operations may then be associated the session.
</p>
</div>
<div class="section" id="mongodb-driver-session.synopsis">
<h2 class="title">Class synopsis</h2>
<div class="classsynopsis">
<div class="ooclass"></div>
<div class="classsynopsisinfo">
<span class="modifier">final</span>
<span class="ooclass">
<strong class="classname">MongoDB\Driver\Session</strong>
</span>
{</div>
<div class="classsynopsisinfo classsynopsisinfo_comment">/* Methods */</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.aborttransaction.html" class="methodname">abortTransaction</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.advanceclustertime.html" class="methodname">advanceClusterTime</a></span>
( <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$clusterTime</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.advanceoperationtime.html" class="methodname">advanceOperationTime</a></span>
( <span class="methodparam"><span class="type"><span class="type MongoDB\BSON\TimestampInterface">MongoDB\BSON\TimestampInterface</span></span> <code class="parameter">$operationTime</code></span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.committransaction.html" class="methodname">commitTransaction</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">private</span> <span class="methodname"><a href="mongodb-driver-session.construct.html" class="methodname">__construct</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.endsession.html" class="methodname">endSession</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">object|null</span> <span class="methodname"><a href="mongodb-driver-session.getclustertime.html" class="methodname">getClusterTime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">object</span> <span class="methodname"><a href="mongodb-driver-session.getlogicalsessionid.html" class="methodname">getLogicalSessionId</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">MongoDB\BSON\Timestamp|null</span> <span class="methodname"><a href="mongodb-driver-session.getoperationtime.html" class="methodname">getOperationTime</a></span>
( <span class="methodparam">void</span>
)</div>
<div class="methodsynopsis dc-description">
<span class="modifier">final</span> <span class="modifier">public</span> <span class="type">void</span> <span class="methodname"><a href="mongodb-driver-session.starttransaction.html" class="methodname">startTransaction</a></span>
( <span class="methodparam"><span class="type"><span class="type array|object">array|object</span></span> <code class="parameter">$options</code></span>
)</div>
}</div>
</div>
</div>
<h2>Table of Contents</h2><ul class="chunklist chunklist_reference"><li><a href="mongodb-driver-session.aborttransaction.html">MongoDB\Driver\Session::abortTransaction</a> — Aborts a transaction</li><li><a href="mongodb-driver-session.advanceclustertime.html">MongoDB\Driver\Session::advanceClusterTime</a> — Advances the cluster time for this session</li><li><a href="mongodb-driver-session.advanceoperationtime.html">MongoDB\Driver\Session::advanceOperationTime</a> — Advances the operation time for this session</li><li><a href="mongodb-driver-session.committransaction.html">MongoDB\Driver\Session::commitTransaction</a> — Commits a transaction</li><li><a href="mongodb-driver-session.construct.html">MongoDB\Driver\Session::__construct</a> — Create a new Session (not used)</li><li><a href="mongodb-driver-session.endsession.html">MongoDB\Driver\Session::endSession</a> — Terminates a session</li><li><a href="mongodb-driver-session.getclustertime.html">MongoDB\Driver\Session::getClusterTime</a> — Returns the cluster time for this session</li><li><a href="mongodb-driver-session.getlogicalsessionid.html">MongoDB\Driver\Session::getLogicalSessionId</a> — Returns the logical session ID for this session</li><li><a href="mongodb-driver-session.getoperationtime.html">MongoDB\Driver\Session::getOperationTime</a> — Returns the operation time for this session</li><li><a href="mongodb-driver-session.starttransaction.html">MongoDB\Driver\Session::startTransaction</a> — Starts a transaction</li></ul>
</div>
<hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="mongodb-driver-bulkwrite.update.html">MongoDB\Driver\BulkWrite::update</a></div>
<div class="next" style="text-align: right; float: right;"><a href="mongodb-driver-session.aborttransaction.html">MongoDB\Driver\Session::abortTransaction</a></div>
<div class="up"><a href="book.mongodb.html">MongoDB\Driver</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
