Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
230 changes: 230 additions & 0 deletions reference/mongodb/mongodb/driver/manager/startsession.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,230 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 330a38c4d45556b49e06ebe6d39e0e311534cd8c Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="mongodb-driver-manager.startsession" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\Driver\Manager::startSession</refname>
<refpurpose>Startet eine neue Client-Sitzung zur Verwendung mit diesem Client</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>MongoDB\Driver\Session</type><methodname>MongoDB\Driver\Manager::startSession</methodname>
<methodparam choice="opt"><type class="union"><type>array</type><type>null</type></type><parameter>options</parameter><initializer>&null;</initializer></methodparam>
</methodsynopsis>
<simpara>
Erzeugt eine <classname>MongoDB\Driver\Session</classname> für die
angegebenen Optionen. Die Sitzung kann anschließend bei der Ausführung von
Befehlen, Abfragen und Schreiboperationen angegeben werden.
</simpara>
<note>
<simpara>
Eine <classname>MongoDB\Driver\Session</classname> kann nur mit dem
<classname>MongoDB\Driver\Manager</classname> verwendet werden, von dem sie
erstellt wurde.
</simpara>
</note>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
<variablelist>
<varlistentry>
<term><parameter>options</parameter></term>
<listitem>
<para>
<table>
<title>options</title>
<tgroup cols="4">
<thead>
<row>
<entry>Option</entry>
<entry>Typ</entry>
<entry>Beschreibung</entry>
<entry>Standardwert</entry>
</row>
</thead>
<tbody>
<row>
<entry>causalConsistency</entry>
<entry><type>bool</type></entry>
<entry>
<simpara>
Konfiguriert die kausale Konsistenz in einer Sitzung. Wenn &true;,
wird jede Operation in der Sitzung kausal nach der vorherigen Lese-
oder Schreiboperation geordnet. Auf &false; setzen, um die kausale
Konsistenz zu deaktivieren.
</simpara>
<simpara>
Weitere Informationen finden sich unter
<link xlink:href="&url.mongodb.docs;core/read-isolation-consistency-recency/#causal-consistency">Causal Consistency</link>
im MongoDB-Handbuch.
</simpara>
</entry>
<entry>&true;</entry>
</row>
<row>
<entry>defaultTransactionOptions</entry>
<entry><type>array</type></entry>
<entry>
<simpara>
Standardoptionen, die auf neu erstellte Transaktionen angewendet
werden. Diese Optionen werden verwendet, sofern sie nicht
überschrieben werden, wenn eine Transaktion mit einem anderen Wert
für die jeweilige Option gestartet wird.
</simpara>
<para>
<table>
<title>options</title>
<tgroup cols="3">
<thead>
<row>
<entry>Option</entry>
<entry>Typ</entry>
<entry>Beschreibung</entry>
</row>
</thead>
<tbody>
&mongodb.option.maxCommitTimeMS;
&mongodb.option.readConcern;
&mongodb.option.readPreference;
&mongodb.option.writeConcern;
</tbody>
</tgroup>
</table>
</para>
<simpara>
Diese Option ist ab MongoDB 4.0 verfügbar.
</simpara>
</entry>
<entry><literal>[]</literal></entry>
</row>
<row>
<entry>snapshot</entry>
<entry><type>bool</type></entry>
<entry>
<simpara>
Konfiguriert Snapshot-Lesevorgänge in einer Sitzung. Wenn &true;,
wird ein Zeitstempel von der ersten unterstützten Leseoperation in
der Sitzung bezogen (d. h. <literal>find</literal>,
<literal>aggregate</literal> oder nicht-shardiertes
<literal>distinct</literal>). Nachfolgende Leseoperationen
innerhalb der Sitzung verwenden dann ein
<literal>"snapshot"</literal>-Read-Concern-Level, um
mehrheitlich bestätigte Daten ab diesem Zeitstempel zu lesen. Auf
&false; setzen, um Snapshot-Lesevorgänge zu deaktivieren.
</simpara>
<simpara>
Snapshot-Lesevorgänge erfordern MongoDB 5.0 oder neuer und können
nicht mit kausaler Konsistenz, Transaktionen oder
Schreiboperationen verwendet werden. Wenn
<literal>"snapshot"</literal> &true; ist, wird
<literal>"causalConsistency"</literal> standardmäßig &false; sein.
</simpara>
<simpara>
Weitere Informationen finden sich unter
<link xlink:href="&url.mongodb.docs;reference/read-concern-snapshot/#read-concern-and-atclustertime">Read Concern "snapshot"</link>
im MongoDB-Handbuch.
</simpara>
</entry>
<entry>&false;</entry>
</row>
</tbody>
</tgroup>
</table>
</para>
</listitem>
</varlistentry>
</variablelist>
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt eine <classname>MongoDB\Driver\Session</classname> zurück.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
<member>Wirft eine <classname>MongoDB\Driver\Exception\InvalidArgumentException</classname>, wenn die Optionen <literal>"causalConsistency"</literal> und <literal>"snapshot"</literal> beide &true; sind.</member>
<member>Wirft eine <classname>MongoDB\Driver\Exception\RuntimeException</classname>, wenn die Sitzung nicht erstellt werden konnte (z. B. weil libmongoc keine Kryptografie unterstützt).</member>
</simplelist>
</refsect1>

<refsect1 role="changelog">
&reftitle.changelog;
<informaltable>
<tgroup cols="2">
<thead>
<row>
<entry>&Version;</entry>
<entry>&Description;</entry>
</row>
</thead>
<tbody>
<row>
<entry>PECL mongodb 1.11.0</entry>
<entry>
<simpara>
Die Option <literal>"snapshot"</literal> wurde hinzugefügt.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 1.6.0</entry>
<entry>
<simpara>
Die Option <literal>"maxCommitTimeMS"</literal> wurde zu
<literal>"defaultTransactionOptions"</literal> hinzugefügt.
</simpara>
</entry>
</row>
<row>
<entry>PECL mongodb 1.5.0</entry>
<entry>
<simpara>
Die Option <literal>"defaultTransactionOptions"</literal> wurde
hinzugefügt.
</simpara>
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><classname>MongoDB\Driver\Session</classname></member>
<member><link xlink:href="&url.mongodb.docs;core/read-isolation-consistency-recency/#causal-consistency">Causal Consistency</link> im MongoDB-Handbuch</member>
</simplelist>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
121 changes: 121 additions & 0 deletions reference/mongodb/mongodb/driver/readconcern/isdefault.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<?xml version="1.0" encoding="utf-8"?>
<!-- EN-Revision: 330a38c4d45556b49e06ebe6d39e0e311534cd8c Maintainer: lacatoire Status: ready -->
<!-- Reviewed: no -->

<refentry xml:id="mongodb-driver-readconcern.isdefault" xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink">
<refnamediv>
<refname>MongoDB\Driver\ReadConcern::isDefault</refname>
<refpurpose>Prüft, ob dies das standardmäßige Read Concern ist</refpurpose>
</refnamediv>

<refsect1 role="description">
&reftitle.description;
<methodsynopsis>
<modifier>final</modifier> <modifier>public</modifier> <type>bool</type><methodname>MongoDB\Driver\ReadConcern::isDefault</methodname>
<void />
</methodsynopsis>
<simpara>
Gibt zurück, ob dies das standardmäßige Read Concern ist (d. h. ob keine
Optionen angegeben sind). Diese Methode ist in erster Linie zur Verwendung in
Verbindung mit
<methodname>MongoDB\Driver\Manager::getReadConcern</methodname> gedacht, um
festzustellen, ob der Manager ohne Read-Concern-Optionen konstruiert wurde.
</simpara>
<simpara>
Der Treiber bindet kein standardmäßiges Read Concern in seine
Leseoperationen ein (z. B.
<methodname>MongoDB\Driver\Manager::executeQuery</methodname>), damit der
Server seinen eigenen Standardwert anwenden kann. Bibliotheken, die auf das
Read Concern des Managers zugreifen, um es in ihre eigenen Lesebefehle
einzubinden, sollten diese Methode verwenden, um sicherzustellen, dass
standardmäßige Read Concerns nicht gesetzt bleiben.
</simpara>
</refsect1>

<refsect1 role="parameters">
&reftitle.parameters;
&no.function.parameters;
</refsect1>

<refsect1 role="returnvalues">
&reftitle.returnvalues;
<simpara>
Gibt &true; zurück, wenn dies das standardmäßige Read Concern ist, und
andernfalls &false;.
</simpara>
</refsect1>

<refsect1 role="errors">
&reftitle.errors;
<simplelist>
&mongodb.throws.argumentparsing;
</simplelist>
</refsect1>

<refsect1 role="examples">
&reftitle.examples;
<example>
<title><function>MongoDB\Driver\ReadConcern::isDefault</function> Beispiel</title>
<programlisting role="php">
<![CDATA[
<?php

$rc = new MongoDB\Driver\ReadConcern(null);
var_dump($rc->isDefault());

$rc = new MongoDB\Driver\ReadConcern(MongoDB\Driver\ReadConcern::MAJORITY);
var_dump($rc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/?readConcernLevel=majority');
$rc = $manager->getReadConcern();
var_dump($rc->isDefault());

$manager = new MongoDB\Driver\Manager('mongodb://127.0.0.1/');
$rc = $manager->getReadConcern();
var_dump($rc->isDefault());

?>
]]>
</programlisting>
&example.outputs;
<screen>
<![CDATA[
bool(true)
bool(false)
bool(false)
bool(true)
]]>
</screen>
</example>
</refsect1>

<refsect1 role="seealso">
&reftitle.seealso;
<simplelist>
<member><methodname>MongoDB\Driver\Manager::getReadConcern</methodname></member>
<member><link xlink:href="&url.mongodb.docs.readconcern;">Read-Concern-Referenz</link></member>
</simplelist>
</refsect1>

</refentry>

<!-- Keep this comment at the end of the file
Local variables:
mode: sgml
sgml-omittag:t
sgml-shorttag:t
sgml-minimize-attributes:nil
sgml-always-quote-attributes:t
sgml-indent-step:1
sgml-indent-data:t
indent-tabs-mode:nil
sgml-parent-document:nil
sgml-default-dtd-file:"~/.phpdoc/manual.ced"
sgml-exposed-tags:nil
sgml-local-catalogs:nil
sgml-local-ecat-files:nil
End:
vim600: syn=xml fen fdm=syntax fdl=2 si
vim: et tw=78 syn=sgml
vi: ts=1 sw=1
-->
Loading
Loading