MongoDB\Driver\Manager::startSession

(mongodb >=1.4.0)

MongoDB\Driver\Manager::startSessionInicia uma nova sessão de cliente para uso com este cliente

Descrição

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

Cria um objeto MongoDB\Driver\Session para as opções fornecidas. A sessão pode então ser especificada ao executar comandos, consultas e operações de gravação.

Note: Um MongoDB\Driver\Session só pode ser usado com o MongoDB\Driver\Manager a partir do qual foi criado.

Parâmetros

options

Opções
Opção Tipo Descrição Default
causalConsistency bool

Configura a consistência causal em uma sessão. Se true, cada operação na sessão será ordenada causalmente após a operação anterior de leitura ou gravação. Se definido como false, desativa a consistência causal.

Consulte » Consistência Causal no manual do MongoDB para obter mais informações.

true
defaultTransactionOptions array

Opções padrão a serem aplicadas a transações recém-criadas. Estas opções são utilizadas a menos que sejam substituídas quando uma transação é iniciada com valores diferentes para cada opção.

Opções
Opção Tipo Descrição
maxCommitTimeMS integer

A quantidade máxima de tempo em milissegundos para permitir que um único comando commitTransaction seja executado.

Se especificada, maxCommitTimeMS deve ser um inteiro de 32 bits com sinal com valor maior ou igual a zero.

readConcern MongoDB\Driver\ReadConcern

Um read concern a ser aplicado à operação.

Esta opção está disponível no MongoDB 3.2+ e resultará em uma exceção em tempo de execução se for especificada para uma versão de servidor mais antiga.

readPreference MongoDB\Driver\ReadPreference

Uma preferência de leitura a ser usada para selecionar um servidor para a operação.

writeConcern MongoDB\Driver\WriteConcern

Um write concern a ser aplicado à operação.

Esta opção está disponível no MongoDB 4.0+.

[]
snapshot bool

Configure leituras de instantâneos em uma sessão. Se true, um timestamp será obtido da primeira operação de leitura suportada na sessão (ou seja, find, aggregate ou distinct não fragmentado). As operações de leitura subsequentes dentro da sessão utilizarão um nível de preocupação de leitura "snapshot" (instantâneo) para ler os dados confirmados pela maioria daquele timestamp. Se definido como false, desativa leituras de instantâneos.

As leituras de instantâneo requerem MongoDB 5.0+ e não podem ser usadas com consistência causal, transações ou operações de gravação. Se "snapshot" for true, "causalConsistency" será padronizado como false.

Consulte » Preocupação de Leitura "snapshot" no manual do MongoDB para obter mais informações.

false

Valor Retornado

Retorna um MongoDB\Driver\Session.

Erros/Exceções

Registro de Alterações

Versão Descrição
PECL mongodb 1.11.0

A opção "snapshot" foi adicionada.

PECL mongodb 1.6.0

A opção "maxCommitTimeMS" foi adicionada a "defaultTransactionOptions".

PECL mongodb 1.5.0

A opção "defaultTransactionOptions" foi adicionada.

Veja Também