appname |
string |
O MongoDB 3.4+ tem a capacidade de anotar conexões com metadados
fornecidos pelo cliente conectado. Esses metadados são incluídos nos
registros do servidor ao estabelecer uma conexão e também incluídos nos
registros de consultas lentas quando a perfilagem do banco de dados está habilitada.
Esta opção pode ser usada para especificar um nome de aplicação, que será
incluído nos metadados. O valor não pode exceder 128
caracteres.
|
authMechanism |
string |
O mecanismo de autenticação que o MongoDB usará para autenticar
a conexão. Para obter detalhes adicionais e uma lista de valores
suportados, consulte
» Opções de autenticação
no manual do MongoDB.
|
authMechanismProperties |
array |
Propriedades do mecanismo de autenticação selecionado. Para obter
detalhes adicionais e uma lista de propriedades suportadas, consulte a
» Especificação de autenticação do driver.
Nota:
Quando não especificada na string URI, esta opção é expressa como
um array de pares chave/valor. As chaves e valores neste array
devem ser strings.
|
authSource |
string |
O nome do banco de dados associado às credenciais do usuário. O padrão
é o componente de banco de dados do URI de conexão ou o banco de dados
admin se ambos não forem especificados.
Para mecanismos de autenticação que delegam o armazenamento de credenciais a
outros serviços (por exemplo, GSSAPI), deve ser
"$external" .
|
canonicalizeHostname |
bool |
Se true , o driver resolverá o nome real do servidor para o
endereço IP antes de autenticar via SASL. Algumas camadas GSSAPI
subjacentes já fazem isso, mas a funcionalidade pode estar desativada em
suas configurações (por exemplo, krb.conf ). O padrão é
false .
Esta opção é um sinônimo defasado para a propriedade
"CANONICALIZE_HOST_NAME" da opção
"authMechanismProperties" da URI.
|
compressors |
string |
Uma lista priorizada e delimitada por vírgulas de compressores que o cliente
deseja usar. As mensagens só serão compactadas se o cliente e o servidor
compartilharem algum compressor em comum, e o compressor usado em cada
direção dependerá da configuração individual do servidor
ou driver. Consulte a
» Especificação de compactação do driver
para obter mais informações.
|
connectTimeoutMS |
int |
O tempo em milissegundos para tentar uma conexão antes de atingir o tempo limite.
O padrão é 10000 milissegundos.
|
directConnection |
bool |
Esta opção pode ser usada para controlar o comportamento de descoberta
do conjunto de réplicas quando apenas um único servidor é fornecido na string de conexão. Por
padrão, fornecer um único membro na string de conexão
estabelecerá uma conexão direta ou descobrirá membros adicionais
dependendo se a opção de URI "replicaSet"
estiver omitida ou presente, respectivamente. Especifique false para forçar
a ocorrência da descoberta (se "replicaSet" for omitido)
ou especifique true para forçar uma conexão direta (se
"replicaSet" estiver presente).
|
gssapiServiceName |
string |
Define o nome do serviço Kerberos ao conectar-se a instâncias MongoDB
Kerberizadas. Este valor deve corresponder ao nome do serviço definido nas instâncias
do MongoDB (ou seja,
parâmetro do servidor » saslServiceName).
O padrão é "mongodb" .
Esta opção é um sinônimo defasado para a propriedade
"SERVICE_NAME" da opção
"authMechanismProperties" do URI.
|
heartbeatFrequencyMS |
int |
Especifica o intervalo em milissegundos entre as verificações do driver
da topologia MongoDB, contado do final da verificação anterior
até o início da próxima. O padrão é 60000
milissegundos.
Pela
» Especificação de descoberta e monitoramento de servidor,
esse valor não pode ser inferior a 500 milissegundos.
|
journal |
bool |
Corresponde ao parâmetro journal da preocupação
de gravação padrão. Se for igual a true , as gravações
exigirão o reconhecimento do MongoDB de que a operação foi
gravada no diário. Para obter detalhes, consulte
MongoDB\Driver\WriteConcern.
|
loadBalanced |
bool |
Especifica se o driver está se conectando a um cluster MongoDB
por meio de um balanceador de carga. Se for igual a true , o driver só pode se conectar a um
único servidor (especificado pela string de conexão ou pela pesquisa
SRV), a opção de URI "directConnection"
não pode ser true , e a opção "replicaSet" do URI
deve ser omitida. O padrão é false .
|
localThresholdMS |
int |
O tamanho em milissegundos da janela de latência para selecionar entre
várias instâncias adequadas do MongoDB ao resolver uma preferência
de leitura. O padrão é 15 milissegundos.
|
maxStalenessSeconds |
int |
Corresponde ao "maxStalenessSeconds"
da preferência de leitura. Especifica, em segundos, o quão
inativo um secundário pode ficar antes que o cliente pare de usá-lo para operações
de leitura. Por padrão, não há inatividade máxima e os clientes
não considerarão o atraso do secundário ao escolher para onde direcionar uma
operação de leitura. Para obter detalhes,
consulte MongoDB\Driver\ReadPreference.
Se especificada, a inatividade máxima deve ser um número inteiro com sinal de 32 bits
maior ou igual a
MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS
(ou seja, 90 segundos).
|
password |
string |
A senha do usuário que está sendo autenticado. Esta opção é útil
se a senha contiver caracteres especiais, que de outra forma
precisariam ser codificados em URL para o URI de conexão.
|
readConcernLevel |
string |
Corresponde ao parâmetro level da preocupação
de leitura. Especifica o nível de isolamento de leitura. Para obter detalhes, consulte
MongoDB\Driver\ReadConcern.
|
readPreference |
string |
Corresponde ao parâmetro mode da preferência
de leitura. O padrão é "primary" . Para obter detalhes,
consulte MongoDB\Driver\ReadPreference.
|
readPreferenceTags |
array |
Corresponde ao parâmetro tagSets da preferência
de leitura. Os conjuntos de etiquetas permitem direcionar operações de leitura para membros
específicos de um conjunto de réplicas. Para obter detalhes,
consulte MongoDB\Driver\ReadPreference.
Nota:
Quando não especificada na string URI, esta opção é expressa como
um array consistente com o formato esperado por
MongoDB\Driver\ReadPreference::__construct().
|
replicaSet |
string |
Especifica o nome do conjunto de réplicas.
|
retryReads |
bool |
Especifica se o driver deve ou não repetir automaticamente
determinadas operações de leitura que falham devido a erros transitórios de rede
ou eleições de conjunto de réplicas. Esta funcionalidade requer o MongoDB 3.6+.
O padrão é true .
Consulte a
» Especificação de leituras repetíveis
para mais informações.
|
retryWrites |
bool |
Especifica se o driver deve ou não repetir automaticamente
determinadas operações de gravação que falham devido a erros transitórios de rede
ou eleições de conjunto de réplicas. Esta funcionalidade requer o MongoDB 3.6+.
O padrão é true .
Consutle
» Gravações Repetíveis
no manual do MongoDB para obter mais informações.
|
safe |
bool |
Se true , especifica 1 para o parâmetro
w da preocupação de gravação padrão. Se false ,
0 será especificado. Para obter detalhes,
consulte MongoDB\Driver\WriteConcern.
Esta opção está defasada e não deve ser usada.
|
serverSelectionTimeoutMS |
int |
Especifica quanto tempo, em milissegundos, deve-se bloquear para seleção de servidor
antes de lançar uma exceção. O padrão é 30000 milissegundos.
|
serverSelectionTryOnce |
bool |
Quando true , instrui o driver a verificar a implantação do MongoDB
exatamente uma vez após a falha na seleção do servidor e, em seguida, selecionar um
servidor ou gerar um erro. Quando false , o driver bloqueia e
procura um servidor até o valor
"serverSelectionTimeoutMS" . O padrão é
true .
|
socketCheckIntervalMS |
int |
Se um soquete não tiver sido usado recentemente, o driver precisará verificá-lo através
do comando hello antes de usá-lo para qualquer
operação. O padrão é 5000 milissegundos.
|
socketTimeoutMS |
int |
O tempo em milissegundos para tentar enviar ou receber em um soquete
antes de atingir o tempo limite. O padrão é 300000 milissegundos (ou seja,
cinco minutos).
|
srvMaxHosts |
int |
O número máximo de resultados de SRV a serem selecionados aleatoriamente ao preencher
inicialmente a lista de valores iniciais ou, durante a sondagem de SRV, ao incluir novos servidores na
topologia. O padrão é 0 (ou seja, sem máximo).
|
srvServiceName |
string |
O nome do serviço a ser usado para consulta de SRV na descoberta inicial da
lista de valores iniciais de DNS e na sondagem de SRV. O padrão é "mongodb" .
|
ssl |
bool |
Inicia a conexão com TLS/SSL se for igual a true . O padrão é
false .
Esta opção é um apelido defasado para a opção de URI
"tls" .
|
tls |
bool |
Inicia a conexão com TLS/SSL se for igual a true . O padrão é
false .
|
tlsAllowInvalidCertificates |
bool |
Especifica se o driver deve ou não apresentar erro quando o certificado
TLS do servidor for inválido. O padrão é false .
Aviso
Desabilitar a validação de certificado cria uma vulnerabilidade.
|
tlsAllowInvalidHostnames |
bool |
Especifica se o driver deve ou não apresentar erro quando há uma
incompatibilidade entre o nome do host do servidor e o nome do host especificado pelo
certificado TLS. O padrão é false .
Aviso
Desabilitar a validação de certificado cria uma vulnerabilidade. Permitir
nomes de servidores inválidos pode expor o driver a um
» ataque MITM.
|
tlsCAFile |
string |
Caminho para arquivo com uma única autoridade de certificação ou um pacote de autoridades
de certificação a ser considerado confiável ao fazer uma conexão TLS.
O armazenamento de certificados do sistema será usado por padrão.
|
tlsCertificateKeyFile |
string |
Caminho para o arquivo de certificado do cliente ou arquivo de chave privada do cliente;
caso ambos sejam necessários, os arquivos deverão ser
concatenados.
|
tlsCertificateKeyFilePassword |
string |
Senha para descriptografar a chave privada do cliente (ou seja,
opção de URI "tlsCertificateKeyFile" ) a ser usada
para conexões TLS.
|
tlsDisableCertificateRevocationCheck |
bool |
Se true , o driver não tentará verificar o status de revogação
do certificado (por exemplo, OCSP, CRL). O padrão é false .
|
tlsDisableOCSPEndpointCheck |
bool |
Se true , o driver não tentará contactar um ponto de extremidade de um
respondedor OCSP, se necessário (ou seja, uma resposta OCSP não é grampeada). O padrão
é false .
|
tlsInsecure |
bool |
Relaxa as restrições de TLS tanto quanto possível. Especificar true para
esta opção tem o mesmo efeito que especificar true para as opções de URI
"tlsAllowInvalidCertificates" e
"tlsAllowInvalidHostnames" . O padrão
é false .
Aviso
Desabilitar a validação de certificado cria uma vulnerabilidade. Permitir
nomes de servidores inválidos pode expor o driver a um
» ataque MITM.
|
username |
string |
O nome do usuário que está sendo autenticado. Esta opção é útil
se o nome de usuário contiver caracteres especiais, que de outra forma
precisariam ser codificados em URL para o URI de conexão.
|
w |
int|string |
Corresponde ao parâmetro w da preocupação de gravação
padrão. Para obter detalhes, consulte
MongoDB\Driver\WriteConcern.
|
wTimeoutMS |
int|string |
Corresponde ao parâmetro wtimeout da
preocupação de gravação padrão. Especifica um limite de tempo,
em milissegundos, para a preocupação de gravação. Para obter detalhes, consulte
MongoDB\Driver\WriteConcern.
Se especificado, wTimeoutMS deve ser um número inteiro de
32 bits sem sinal maior ou igual a zero.
|
zlibCompressionLevel |
int |
Especifica o nível de compactação a ser usado para o compressor zlib. Esta
opção não tem efeito se zlib não estiver incluído na
opção URI "compressors" . Consulte a
» Especificação de Compactação de Driver
para obter mais informações.
|