PHP 8.5.0 Alpha 2 available for testing

MongoDB\Driver\Manager::startSession

(mongodb >=1.4.0)

MongoDB\Driver\Manager::startSessionInicia una nueva sesión de cliente para ser utilizada con este cliente

Descripción

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

Crear una MongoDB\Driver\Session para las opciones dadas. La sesión puede luego ser especificada durante la ejecución de comandos, consultas y operaciones de escritura.

Nota: Una MongoDB\Driver\Session solo puede ser utilizada con el MongoDB\Driver\Manager desde el cual fue creada.

Parámetros

options

options
Option Type Description Default
causalConsistency bool

Configura la coherencia causal en una sesión. Si true, cada operación en la sesión será ordenada de manera causal después de la operación de lectura o escritura previa. Definir a false para desactivar la coherencia causal.

Ver » Consistencia causal en el manual de MongoDB para más información.

true
defaultTransactionOptions array

Las opciones por defecto a aplicar a las transacciones recién creadas. Estas opciones se utilizan a menos que sean reemplazadas cuando una transacción es iniciada con un valor diferente para cada opción.

options
Option Type Description
maxCommitTimeMS integer

El tiempo máximo en milisegundos para permitir que una sola comando commitTransaction se ejecute.

Si se especifica, maxCommitTimeMS debe ser un entero 32 bits con signo superior o igual a cero.

readConcern MongoDB\Driver\ReadConcern

Una preocupación de lectura a aplicar a la operación.

Esta opción está disponible en MongoDB 3.2+ y se traducirá en una excepción en el momento de la ejecución si se especifica para una versión más antigua del servidor.

readPreference MongoDB\Driver\ReadPreference

Una preferencia de lectura a utilizar para seleccionar un servidor para la operación.

writeConcern MongoDB\Driver\WriteConcern

Una preocupación de escritura a aplicar a la operación.

Esta opción está disponible en MongoDB 4.0+.

[]
snapshot bool

Configura las lecturas instantáneas en una sesión. Si true, un timestamp será obtenido de la primera operación de lectura soportada en la sesión (es decir, find, aggregate, o distinct no fragmentado). Las operaciones de lectura posteriores en la sesión utilizarán luego un nivel de coherencia de lectura "snapshot" para leer datos mayoritariamente comprometidos desde ese timestamp. Definir a false para desactivar las lecturas instantáneas.

Las lecturas instantáneas requieren MongoDB 5.0+ y no pueden ser utilizadas con la coherencia causal, transacciones o operaciones de escritura. Si "snapshot" es true, "causalConsistency" será por defecto false.

Ver » Read Concern "instantáneas" en el manual de MongoDB para más información.

false

Valores devueltos

Devuelve una MongoDB\Driver\Session.

Errores/Excepciones

Historial de cambios

Versión Descripción
PECL mongodb 1.11.0

La opción "snapshot" fue añadida.

PECL mongodb 1.6.0

La opción "maxCommitTimeMS" fue añadida a "defaultTransactionOptions".

PECL mongodb 1.5.0

La opción "defaultTransactionOptions" fue añadida.

Ver también

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top