MongoDB\Driver\Manager::startSession

(mongodb >=1.4.0)

MongoDB\Driver\Manager::startSession — Démarre une nouvelle session client pour être utilisée avec ce client

Description

final public function MongoDB\Driver\Manager::startSession(?array $options = null): MongoDB\Driver\Session

Crée une MongoDB\Driver\Session pour les options données. La session peut ensuite être spécifiée lors de l'exécution de commandes, de requêtes et d'opérations d'écriture.

Note: Une MongoDB\Driver\Session ne peut être utilisée qu'avec le MongoDB\Driver\Manager à partir duquel elle a été créée.

Liste de paramètres

options

Option Type Description Défaut

causalConsistency bool Configure la cohérence causale dans une session. Si true, chaque opération dans la session sera ordonnée de manière causale après l'opération de lecture ou d'écriture précédente. Définir à false pour désactiver la cohérence causale. Voir » Consistance causale dans le manuel MongoDB pour plus d'informations. true

defaultTransactionOptions

array

Les options par défaut à appliquer aux transactions nouvellement créées. Ces options sont utilisées sauf si elles sont remplacées lorsqu'une transaction est démarrée avec une valeur différente pour chaque option.

**options**
Option	Type	Description
maxCommitTimeMS	integer	Le temps maximum en millisecondes pour permettre à une seule commande `commitTransaction` de s'exécuter. Si spécifié, `maxCommitTimeMS` doit être un entier 32 bits signé supérieur ou égal à zéro.
readConcern	MongoDB\Driver\ReadConcern	Une préoccupation de lecture à appliquer à l'opération. Cette option est disponible dans MongoDB 3.2+ et se traduira par une exception au moment de l'exécution si elle est spécifiée pour une version plus ancienne du serveur.
readPreference	MongoDB\Driver\ReadPreference	Une préférence de lecture à utiliser pour sélectionner un serveur pour l'opération.
writeConcern	MongoDB\Driver\WriteConcern	Une préoccupation d'écriture à appliquer à l'opération.

Cette option est disponible dans MongoDB 4.0+.

[]

snapshot bool Configure les lectures instantanées dans une session. Si true, un horodatage sera obtenu à partir de la première opération de lecture prise en charge dans la session (c'est-à-dire find, aggregate, ou distinct non fragmenté). Les opérations de lecture ultérieures dans la session utiliseront ensuite un niveau de cohérence de lecture "snapshot" pour lire des données majoritairement engagées à partir de cet horodatage. Définissez à false pour désactiver les lectures instantanées. Les lectures instantanées nécessitent MongoDB 5.0+ et ne peuvent pas être utilisées avec la cohérence causale, les transactions ou les opérations d'écriture. Si "snapshot" est true, "causalConsistency" sera par défaut à false. Voir » Read Concern "instantanés" dans le manuel MongoDB pour plus d'informations. false

Valeurs de retour

Renvoie une MongoDB\Driver\Session.

Erreurs / Exceptions

Lance une exception MongoDB\Driver\InvalidArgumentException lors d'une erreur survenue pendant l'analyse d'un argument.
Lance une MongoDB\Driver\Exception\InvalidArgumentException si les options "causalConsistency" et "snapshot" sont toutes les deux true.
Lance une MongoDB\Driver\Exception\RuntimeException si la session ne peut pas être créée (par exemple, libmongoc ne prend pas en charge le chiffrement).

Historique

Version	Description
PECL mongodb 1.11.0	L'option `"snapshot"` a été ajoutée.
PECL mongodb 1.6.0	L'option `"maxCommitTimeMS"` a été ajoutée à `"defaultTransactionOptions"`.
PECL mongodb 1.5.0	L'option `"defaultTransactionOptions"` a été ajoutée.

Voir aussi

MongoDB\Driver\Session
» Consistance causale dans le manuel MongoDB

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes

There are no user contributed notes for this page.