Para agentes de IA: um índice de documentação está disponível em https://www.mongodb.com/pt-br/docs/llms.txt — as versões de markdown de todas as páginas estão disponíveis anexando .md a qualquer caminho de URL.
Menu Docs
Página inicial do Docs
/ /
Conecte
Página inicial do Docs
/ /
Biblioteca PHP
/
Conecte
Página inicial do Docs
/
Bibliotecas do cliente
/
PHP
/
Biblioteca PHP
/
Conecte

Especificar opções de conexão

Visão geral

Esta página descreve as opções de conexão e autenticação MongoDB disponíveis na biblioteca PHP.

Definir opções de conexão

Você pode configurar sua conexão especificando opções no URI de conexão ou passando-as para o construtor MongoDB\Client .

Como utilizar o URI de conexão

Se você passar um URI de conexão para o construtor MongoDB\Client , poderá incluir opções de conexão no URI como pares <name>=<value> . No exemplo a seguir, o URI de conexão define a opção tls como true e a opção tlsCertificateKeyFile como /path/to/file.pem:

// Replace the placeholders with your actual hostname, port, and path to the certificate key file
$uri = 'mongodb://<hostname>:<port>/?tls=true&tlsCertificateKeyFile=/path/to/file.pem';
// Create a MongoDB client
$client = new MongoDB\Client($uri);

Usando um objeto MongoDB\Client

Você pode passar as opções de conexão para o construtor MongoDB\Client em vez de incluí-las em seu URI de conexão.

O exemplo seguinte mostra como utilizar o parâmetro $uriOptions do construtor MongoDB\Client para configurar opções de conexão:

// Replace the placeholders with your actual hostname and port
$uri = 'mongodb://<hostname>:<port>/';
// Set the connection options
// Replace the placeholder with the actual path to the certificate key file
$uriOptions = [
    'tls' => true,
    'tlsCertificateKeyFile' => '/path/to/file.pem',
];
// Create a MongoDB client with the URI and options
$client = new Client($uri, $uriOptions);

Observação

Se você especificar uma opção no parâmetro $uriOptions e no URI de conexão, o valor em $uriOptions terá precedência.

Opções de URI de conexão

As seções a seguir descrevem as opções que você pode definir para sua conexão com o MongoDB. Cada opção de conexão está vinculada à sua entrada correspondente no manual do MongoDB Server .

Importante

Codificação percentual

Se o valor de uma opção de conexão contiver caracteres especiais, você deverá codificar percentualmente o valor antes de incluí-lo no URI de conexão. Você pode usar o método rawurlencode() para codificar esses valores de acordo com a sintaxe URI especificada em RFC 3986.

Não codifique por cento as opções de conexão ao incluí-las no parâmetro $uriOptions .

Para saber mais, consulte os seguintes recursos:

Opções de conjunto de réplicas

Opção de conexão
Descrição

directConnection

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['directConnection' => true];
Exemplo de URI de conexão: directConnection=true

replicaSet

Tipo string
de dados: Exemplo MongoDB\Client: $uriOptions = ['replicaSet' => 'replicaSetName'];
Exemplo de URI de conexão: replicaSet=replicaSetName

Opções de conexão

Opções de TLS

Para saber mais sobre as opções de TLS disponíveis na biblioteca PHP, consulte a página TLS .

Opções de tempo limite

Opção de conexão
Descrição

connectTimeoutMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['connectTimeoutMS' => 2000];
Exemplo de URI de conexão: connectTimeoutMS=2000

socketTimeoutMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['socketTimeoutMS' => 20000];
Exemplo de URI de conexão: socketTimeoutMS=20000

Opções de compressão

Opção de conexão
Descrição

compressors

Tipo string
de dados: Exemplo MongoDB\Client: $uriOptions = ['compressors' => 'snappy,zstd,zlib'];
Exemplo de URI de conexão: compressors=snappy,zstd,zlib

zlibCompressionLevel

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['zlibCompressionLevel' => 3];
Exemplo de URI de conexão: zlibCompressionLevel=3

Opções de write concern

Opção de conexão
Descrição

w

Tipo string
de dados: Exemplo MongoDB\Client: $uriOptions = ['w' => 'majority'];
Exemplo de URI de conexão: w=majority

wTimeoutMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['wTimeoutMS' => 10000];
Exemplo de URI de conexão: wTimeoutMS=10000

journal

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['journal' => true];
Exemplo de URI de conexão: journal=true

Opções de read concern

Opção de conexão
Descrição

readConcernLevel

Tipo string
de dados: Exemplo MongoDB\Client: $uriOptions = ['readConcernLevel' => 'majority'];
Exemplo de URI de conexão: readConcernLevel=majority

Opções de read preference

Opção de conexão
Descrição

readPreference

Tipo de dados: MongoDB\Driver\ReadPreference
MongoDB\Client Exemplo: $uriOptions = ['readPreference' => 'secondaryPreferred'];
Exemplo de URI de conexão: readPreference=secondaryPreferred

maxStalenessSeconds

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['maxStalenessSeconds' => 30];
Exemplo de URI de conexão: maxStalenessSeconds=30

readPreferenceTags

Tipo de Dados: array
Exemplo MongoDB\Client:

$uriOptions = [
    'readPreferenceTags' => [
        ['dc' => 'ny', 'rack' => 'r1'],
        [],
    ],
];

Exemplo de URI de conexão: readPreferenceTags=dc:ny,rack:r1&readPreferenceTags=

Opções de autenticação

Para saber mais sobre as opções de autenticação disponíveis na biblioteca PHP, consulte Mecanismos de autenticação.

Seleção de servidor e opções de descoberta

Opção de conexão
Descrição

localThresholdMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['localThresholdMS' => 20];
Exemplo de URI de conexão: localThresholdMS=20

serverSelectionTimeoutMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['serverSelectionTimeoutMS' => 5000];
Exemplo de URI de conexão: serverSelectionTimeoutMS=5000

serverSelectionTryOnce

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['serverSelectionTryOnce' => false];
Exemplo de URI de conexão: serverSelectionTryOnce=false

heartbeatFrequencyMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['heartbeatFrequencyMS' => 30000];
Exemplo de URI de conexão: heartbeatFrequencyMS=30000

socketCheckIntervalMS

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['socketCheckIntervalMS' => 4000];
Exemplo de URI de conexão: socketCheckIntervalMS=4000

enableOverloadRetargeting

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['enableOverloadRetargeting' => true];
Exemplo de URI de conexão: enableOverloadRetargeting=true

maxAdaptiveRetries

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['maxAdaptiveRetries' => 3];
Exemplo de URI de conexão: maxAdaptiveRetries=3

Configurações diversas

Opção de conexão
Descrição

appName

Tipo string
de dados: Exemplo MongoDB\Client: $uriOptions = ['appName' => 'myApp'];
Exemplo de URI de conexão: appName=myApp

retryReads

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['retryReads' => false];
Exemplo de URI de conexão: retryReads=false

retryWrites

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['retryWrites' => false];
Exemplo de URI de conexão: retryWrites=false

loadBalanced

Tipo bool
de dados: Exemplo MongoDB\Client: $uriOptions = ['loadBalanced' => true];
Exemplo de URI de conexão: loadBalanced=true

srvMaxHosts

Tipo int
de dados: Exemplo MongoDB\Client: $uriOptions = ['srvMaxHosts' => 5];
Exemplo de URI de conexão: srvMaxHosts=5

Documentação da API

Para obter mais informações sobre a classe MongoDB\Client , consulte a seguinte documentação da API da biblioteca PHP:

Para obter mais informações sobre a classe MongoDB\Driver\ReadPreference , consulte a seguinte documentação da API de extensão PHP:

Voltar

Escolha um destino de conexão

Próximo

Stable API

Nesta página