Параметри

uri

А » mongodb:// URI за поврзување:

mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[defaultAuthDb][?options]]

Стандардно е "mongodb://127.0.0.1:27017" ако не е специфицирано. За детали за поддржаните опции на URI, видете » Опции за низа за поврзување во прирачникот на MongoDB. » Опции за пул на врски не се поддржани, бидејќи екстензијата не имплементира пулови за врски. На uri е URL, оттука било какви специјални знаци во неговите компоненти треба да бидат URL кодирани според Кодирањето се врши според. Ова е особено релевантно за корисничкото име и лозинката, кои често можат да вклучуваат специјални знаци како @, :, или %. Кога се поврзувате преку Unix домен сокет, патеката на сокетот може да содржи специјални знаци како коси црти и мора да биде кодирана. rawurlencode() функцијата може да се користи за кодирање на составните делови на URI. На defaultAuthDb компонентата може да се користи за специфицирање на името на базата на податоци поврзано со ингеренциите на корисникот; сепак authSource опцијата URI ќе има приоритет ако е специфицирана. Ако ниту defaultAuthDb nor authSource се специфицирани, на admin базата на податоци ќе се користи по дифолт. На defaultAuthDb компонентата нема ефект во отсуство на кориснички акредитиви.

uriOptions

Дополнително » Опции за низа за поврзување, што ќе пребрише било какви опции со исто име во uri parameter.

uriOptions

Опција	Тип	= NULL
appname	string	MongoDB 3.4+ има можност да ги анотира врските со метаподатоци обезбедени од клиентот што се поврзува. Овие метаподатоци се вклучени во логовите на серверот при воспоставување врска и исто така се запишуваат во логовите за бавни прашања кога е овозможено профилирање на базата на податоци. Оваа опција може да се користи за да се специфицира име на апликација, кое ќе биде вклучено во метаподатоците. Вредноста не може да надмине 128 знаци.
authMechanism	string	Механизмот за автентикација што MongoDB ќе го користи за автентикација на врската. За дополнителни детали и список на поддржани вредности, видете » Опции за автентикација во прирачникот на MongoDB.
authMechanismProperties	array	Својства за избраниот механизам за автентикација. За дополнителни детали и список на поддржани својства, видете го » Спецификација за автентикација на драјверот. Забелешка: Кога не е специфицирано во URI низата, оваа опција е изразена како низа од парови клуч/вредност. Клучевите и вредностите во оваа низа треба да бидат низи.
authSource	string	Името на базата на податоци поврзано со акредитивите на корисникот. Стандардно е компонентата за базата на податоци на URI за поврзување, или admin базата на податоци ако и двете се неопределени. За механизми за автентикација кои делегираат складирање на акредитиви на други услуги (на пр. GSSAPI), ова треба да биде "$external".
compressors	string	Приоритетна, разделена со запирки листа на компресори што клиентот сака да ги користи. Пораките се компресираат само ако клиентот и серверот споделуваат заеднички компресори, а компресорот што се користи во секоја насока ќе зависи од индивидуалната конфигурација на серверот или драјверот. Видете го » Спецификација за компресија на драјверот Користење на PHP од командната линија
connectTimeoutMS	int	Времето во милисекунди за обид за поврзување пред истекување на времето. Стандардно е 10.000 милисекунди.
directConnection	bool	Оваа опција може да се користи за контрола на однесувањето при откривање на реплика сет кога е обезбеден само еден хост во низата за поврзување. Стандардно, обезбедувањето на еден член во низата за поврзување ќе воспостави директна врска или ќе открие дополнителни членови во зависност од тоа дали "replicaSet" опцијата URI е изоставена или присутна, соодветно. Наведете false за да се присили откривањето да се случи (ако "replicaSet" се изоставува) или наведете true за да се присили директна врска (ако "replicaSet" е присутен).
enableOverloadRetargeting	bool	Кога е поставено на true тоа присилува избор на сервер по SystemOverloadedError. Стандардно е false.
heartbeatFrequencyMS	int	Го специфицира интервалот во милисекунди помеѓу проверките на драјверот за MongoDB топологијата, броено од крајот на претходната проверка до почетокот на следната. Стандардно е 60.000 милисекунди. Според » Спецификација за откривање и следење на сервери, оваа вредност не може да биде помала од 500 милисекунди.
journal	bool	Соодветствува на стандардната загриженост за запишување journal параметар. Ако true, запишувањата ќе бараат потврда од MongoDB дека операцијата е запишана во дневникот. За детали, видете MongoDB\Driver\WriteConcern.
loadBalanced	bool	Го специфицира дали драјверот се поврзува со MongoDB кластер преку балансер на оптоварување. Ако true, драјверот може да се поврзе само со еден хост (специфициран или преку низата за поврзување или SRV пребарување), "directConnection" URI опцијата не може да биде trueФункциите "replicaSet" URI опцијата мора да се изостави. Стандардно е false.
localThresholdMS	int	Големината во милисекунди на прозорецот за латентност за избирање помеѓу повеќе соодветни MongoDB инстанци при решавање на преференца за читање. Стандардно е 15 милисекунди.
maxAdaptiveRetries	int	Оваа опција може да се користи за промена на максималниот број обиди кога се случува SystemOverloadedError се случува. Мора да биде позитивен цел број; стандардно е 2.
maxStalenessSeconds	int	Соодветствува на преференцата за читање "maxStalenessSeconds". Го специфицира, во секунди, колку застарен може да биде секундарниот пред клиентот да престане да го користи за операции за читање. Стандардно, нема максимална застареност и клиентите нема да ја земат предвид заостанатоста на секундарниот при изборот каде да насочат операција за читање. За детали, видете MongoDB\Driver\ReadPreference. Ако е специфицирано, максималната застареност мора да биде потпишан 32-битен цел број поголем или еднаков на MongoDB\Driver\ReadPreference::SMALLEST_MAX_STALENESS_SECONDS (т.е. 90 секунди).
password	string	Лозинката за корисникот што се автентицира. Оваа опција е корисна ако лозинката содржи специјални знаци, кои инаку би требало да бидат URL кодирани за URI-то за поврзување.
readConcernLevel	string	Соодветствува на загриженоста за читање level параметар. Го специфицира нивото на изолација при читање. За детали, видете MongoDB\Driver\ReadConcern.
readPreference	string	Соодветствува на преференцата за читање mode параметар. Стандардно е "primary". За детали, видете MongoDB\Driver\ReadPreference.
readPreferenceTags	array	Соодветствува на преференцата за читање tagSets параметар. Сетовите на ознаки ви овозможуваат да насочувате операции за читање кон специфични членови на комплетот реплики. За детали, видете MongoDB\Driver\ReadPreference. Забелешка: Кога не е наведено во URI низата, оваа опција е изразена како низа конзистентна со форматот очекуван од MongoDB\Driver\ReadPreference::__construct().
replicaSet	string	Го специфицира името на комплетот реплики.
retryReads	bool	Го специфицира дали драјверот треба автоматски да повторува одредени операции за читање што пропаѓаат поради привремени мрежни грешки или избори на комплетот реплики. Оваа функционалност бара MongoDB 3.6+. Стандардно е true. Постојат голем број корисни функции за » Спецификација за повторливи читања Користење на PHP од командната линија
retryWrites	bool	Го специфицира дали драјверот треба автоматски да повторува одредени операции за запишување што пропаѓаат поради привремени мрежни грешки или избори на комплетот реплики. Оваа функционалност бара MongoDB 3.6+. Стандардно е true. Константи за известување за грешки » Повторливи записи во прирачникот на MongoDB за повеќе информации.
serverSelectionTimeoutMS	int	Го специфицира времето во милисекунди за блокирање за избор на сервер пред да се фрли исклучок. Стандардно е 30.000 милисекунди.
serverSelectionTryOnce	bool	Кога true, го инструира драјверот да го скенира распоредот на MongoDB точно еднаш по неуспехот на изборот на сервер и потоа или да избере сервер или да подигне грешка. Кога false, драјверот блокира и бара сервер до "serverSelectionTimeoutMS" вредност. Стандардно е true.
socketCheckIntervalMS	int	Ако сокетот не бил неодамна користен, драјверот мора да го провери преку hello команда пред да ја користи за каква било операција. Стандардно е 5.000 милисекунди.
socketTimeoutMS	int	Времето во милисекунди за обид за испраќање или примање на сокет пред да истече времето. Стандардно е 300.000 милисекунди (т.е. пет минути).
srvMaxHosts	int	Максималниот број на SRV резултати што случајно ќе се изберат при првичното пополнување на списокот на семиња или, за време на SRV анкетирање, додавање нови домаќини во топологијата. Стандардно е 0 (т.е. без максимум).
srvServiceName	string	Името на услугата што треба да се користи за SRV пребарување во почетното откривање на списокот на семиња и SRV анкетирање. Стандардно е "mongodb".
tls	bool	Ја иницира врската со TLS/SSL ако true. Стандардно е false.
tlsAllowInvalidCertificates	bool	Го иницира поврзувањето со TLS/SSL ако false. Ги ескејпува специјалните знаци во стринг за употреба во SQL изјава Определува дали драјверот треба да пријави грешка кога сертификатот TLS на серверот е невалиден. Стандардно е
tlsAllowInvalidHostnames	bool	Оневозможувањето на валидацијата на сертификатот создава ранливост. false. Ги ескејпува специјалните знаци во стринг за употреба во SQL изјава Определува дали драјверот треба да пријави грешка кога има несогласување помеѓу името на хостот на серверот и името на хостот наведено од TLS сертификатот. Стандардно е Оневозможувањето на валидацијата на сертификатот создава ранливост. Дозволувањето невалидни имиња на хостови може да го изложи драјверот на.
tlsCAFile	string	» напад од човек посредник
tlsCertificateKeyFile	string	Патека до датотека со еден или пакет сертификациски авторитети на кои треба да им се верува при воспоставување TLS врска. Системот за сертификати ќе се користи стандардно.
tlsCertificateKeyFilePassword	string	Патека до датотеката со клиентски сертификат или датотеката со приватниот клуч на клиентот; во случај кога и двете се потребни, датотеките треба да се спојат. "tlsCertificateKeyFile" Лозинка за дешифрирање на приватниот клуч на клиентот (т.е.
tlsDisableCertificateRevocationCheck	bool	Враќа trueURI опција) што ќе се користи за TLS врски. false.
tlsDisableOCSPEndpointCheck	bool	Враќа true, драјверот нема да се обиде да ја провери состојбата на ревокација на сертификатот (на пр. OCSP, CRL). Стандардно е false.
tlsInsecure	bool	, драјверот нема да се обиде да контактира со крајна точка на OCSP одговор ако е потребно (т.е. ако OCSP одговорот не е прикачен). Стандардно е true Олабавете ги TLS ограничувањата колку што е можно повеќе. Специфицирањето true за оваа опција има исто дејство како специфицирање "tlsAllowInvalidCertificates" and "tlsAllowInvalidHostnames" за двете false. Ги ескејпува специјалните знаци во стринг за употреба во SQL изјава Определува дали драјверот треба да пријави грешка кога има несогласување помеѓу името на хостот на серверот и името на хостот наведено од TLS сертификатот. Стандардно е Оневозможувањето на валидацијата на сертификатот создава ранливост. Дозволувањето невалидни имиња на хостови може да го изложи драјверот на.
username	string	URI опции. Стандардно е
w	int|string	Соодветствува на стандардната загриженост за запишување w Корисничкото име за корисникот што се автентицира. Оваа опција е корисна ако корисничкото име содржи специјални знаци, кои инаку би требало да бидат URL кодирани за URI на врската. MongoDB\Driver\WriteConcern.
wTimeoutMS	int|string	Соодветствува на стандардната загриженост за запишување wtimeout параметар. За детали, видете MongoDB\Driver\WriteConcern. параметар. Определува временско ограничување, во милисекунди, за грижата за запишување. За детали, видете wTimeoutMS мора да биде потпишан 32-битен цел број поголем или еднаков на нула.
zlibCompressionLevel	int	Ја специфицира нивото на компресија што треба да се користи за zlib компресорот. Оваа опција нема ефект ако zlib не е вклучено во "compressors" URI опцијата. Видете го » Спецификација за компресија на драјверот Користење на PHP од командната линија

driverOptions

driverOptions

Опција	Тип	= NULL
autoEncryption	array	Обезбедува опции за овозможување на автоматско шифрирање на ниво на поле од страна на клиентот. Листата на опции е опишана во табелата подолу. Забелешка: Автоматското шифрирање е функција само за претпријатија што се применува само на операции на колекција. Автоматското шифрирање не е поддржано за операции на база на податоци или приказ, а операциите што не се заобиколени ќе резултираат со грешка (види » libmongocrypt: Список за дозволување на автоматско шифрирање). За да го заобиколите автоматското шифрирање за сите операции, поставете bypassAutoEncryption to true. Автоматското шифрирање бара автентицираниот корисник да ја има » listCollections привилегирана акција. Експлицитното шифрирање/дешифрирање и автоматското дешифрирање е функција на заедницата. Возачот сè уште може автоматски да дешифрира кога bypassAutoEncryption is true.
ca_dir	string	Патека до правилно хеширана директориум со сертификати. Системот за складирање сертификати ќе се користи по дифолт.
crl_file	string	Патека до датотека со список за одземање на сертификати.
disableClientPersistence	bool	Враќа true, овој Менаџер ќе користи нов libmongoc клиент, кој нема да биде зачуван или споделен со други Менаџер објекти. Кога овој Менаџер објект ќе биде ослободен, неговиот клиент ќе биде уништен и сите врски ќе бидат затворени. Стандардно е false. Забелешка: Оневозможувањето на перзистентноста на клиентот генерално не се препорачува.
driver	array	Овозможува повисоко ниво на библиотека да додаде свои метаподатоци на ракувањето со серверот. Стандардно, екстензијата го поднесува своето име, верзија и платформа (т.е. PHP верзија) во ракувањето. Низите можат да бидат специфицирани за "name", "version"Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во "platform" клучовите на овој array, и ќе бидат додадени на соодветното поле(а) во документот за ракување. Забелешка: Информациите за ракување се ограничени на 512 бајти. Екстензијата ќе ги скрати податоците за ракување за да се вклопат во овој стринг од 512 бајти. Се охрабруваат повисоките библиотеки да ги чуваат своите метаподатоци концизни.
serverApi	MongoDB\Driver\ServerApi	Оваа опција се користи за декларирање верзија на API на серверот за менаџерот. Ако се изостави, не се декларира API верзија.

Опции поддржани од автоматско шифрирање преку опцијата autoEncryption возач:

autoEncryption

Опција	Тип	= NULL
keyVaultClient	MongoDB\Driver\Manager	објект со наведените опции.
keyVaultNamespace	string	Целосно квалификувано име на простор (на пр. "databaseName.collectionName"Менаџерот што се користи за насочување на барањата за клучеви за податоци до посебен MongoDB кластер. Стандардно, се користи тековниот Менаџер и кластер.
kmsProviders	array	) што го означува збирката што ги содржи сите клучеви за податоци што се користат за шифрирање и дешифрирање. Оваа опција е задолжителна. "aws", "azure", "gcp", "kmip"Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во "local" Документ што ги содржи конфигурациите за еден или повеќе KMS провајдери, кои се користат за шифрирање на клучеви за податоци. Поддржаните провајдери вклучуваат и мора да биде наведен барем еден. "aws", "azure", или "gcp"Ако е наведен празен документ за , драјверот ќе се обиде да го конфигурира провајдерот користејќи. » Автоматски акредитиви "aws" Сигнатурата на aws: { accessKeyId: <string>, secretAccessKey: <string>, sessionToken: <optional string> } » Автоматски акредитиви "azure" Сигнатурата на azure: { tenantId: <string>, clientId: <string>, clientSecret: <string>, identityPlatformEndpoint: <optional string> // Defaults to "login.microsoftonline.com" } » Автоматски акредитиви "gcp" Сигнатурата на gcp: { email: <string>, privateKey: <base64 string>|<MongoDB\BSON\Binary>, endpoint: <optional string> // Defaults to "oauth2.googleapis.com" } » Автоматски акредитиви "kmip" Сигнатурата на kmip: { endpoint: <string> } » Автоматски акредитиви "local" Сигнатурата на local: { // 96-byte master key used to encrypt/decrypt data keys key: <base64 string>|<MongoDB\BSON\Binary> }
tlsOptions	array	Форматот за "aws", "azure", "gcp"Препорачаниот начин за избегнување на SQL инјекција е со врзување на сите податоци преку подготвени изрази. Користењето на параметризирани прашања не е доволно за целосно избегнување на SQL инјекција, но тоа е најлесниот и најбезбедниот начин за обезбедување влез во SQL изразите. Сите динамични литерали на податоци во "kmip"Документ што ги содржи TLS конфигурациите за еден или повеќе KMS провајдери. Поддржаните провајдери вклучуваат <provider>: { tlsCaFile: <optional string>, tlsCertificateKeyFile: <optional string>, tlsCertificateKeyFilePassword: <optional string>, tlsDisableOCSPEndpointCheck: <optional bool> }
schemaMap	array|object	Мапа на простори на имиња на колекции до локална JSON шема. Ова се користи за конфигурирање на автоматско шифрирање. Погледнете » Правила за автоматско шифрирање во прирачникот на MongoDB за повеќе информации. Грешка е да се специфицира колекција и во schemaMap and encryptedFieldsMap. Забелешка: Обезбедувањето на schemaMap обезбедува поголема безбедност отколку потпирањето на JSON шеми добиени од серверот. Штити од злонамерен сервер што рекламира лажна JSON шема, што може да го измами клиентот да испрати нешифрирани податоци што треба да бидат шифрирани. Забелешка: Шемите обезбедени во schemaMap се применуваат само за конфигурирање на автоматско шифрирање за шифрирање од страна на клиентот. Други правила за валидација во JSON шемата нема да бидат спроведени од драјверот и ќе резултираат со грешка.
bypassAutoEncryption	bool	Враќа true, mongocryptd нема да се стартува автоматски. Ова се користи за оневозможување на автоматско шифрирање. Стандардно е false.
bypassQueryAnalysis	bool	Враќа true, автоматската анализа на излезните команди ќе биде оневозможена и mongocryptd нема да се стартува автоматски. Ова го овозможува случајот на употреба на експлицитно шифрирање за барање индексирани полиња без потреба од лиценцирана верзија на crypt_shared библиотека или mongocryptd процес. Стандардно е false.
encryptedFieldsMap	array|object	Мапа на простори на имиња на колекции до encryptedFields документ. Ова се користи за конфигурирање на можност за барање шифрирање. Погледнете » Шифрирање на полиња и можност за барање во прирачникот на MongoDB за повеќе информации. Грешка е да се специфицира колекција и во encryptedFieldsMap and schemaMap. Забелешка: Обезбедувањето на encryptedFieldsMap обезбедува поголема безбедност отколку потпирањето на encryptedFields добиен од серверот. Штити од злонамерен сервер што рекламира лажен encryptedFields.
extraOptions	array	На extraOptions се однесуваат на mongocryptd процес. Поддржани се следниве опции: mongocryptdURI (string): URI за поврзување со постоечки mongocryptd процес. Стандардно е "mongodb://localhost:27020". mongocryptdBypassSpawn (bool): Ако true, спречи драјверот да се стартува mongocryptd. Стандардно е false. mongocryptdSpawnPath (string): Апсолутна патека за пребарување на mongocryptd бинарна. Стандардно е празен стринг и ги консултира системските патеки. mongocryptdSpawnArgs (array): Низа од стринг аргументи што треба да се предадат на mongocryptd при стартување. Стандардно е ["--idleShutdownTimeoutSecs=60"]. cryptSharedLibPath (string): Апсолутна патека до crypt_shared споделена библиотека. Стандардно е празен стринг и ги консултира системските патеки. cryptSharedLibRequired (bool): Ако true, бара драјверот да вчита crypt_shared. Стандардно е false. Постојат голем број корисни функции за » Спецификација за шифрирање од страна на клиентот Користење на PHP од командната линија

Забелешка: Автоматското шифрирање е функција само за претпријатија што се применува само на операции на колекција. Автоматското шифрирање не е поддржано за операции на база на податоци или приказ, а операциите што не се заобиколени ќе резултираат со грешка. За да го заобиколите автоматското шифрирање за сите операции, поставете bypassAutoEncryption=true in autoEncryption. За повеќе информации за дозволените операции, видете го » Спецификација за шифрирање од страна на клиентот.