Skip to content

Commit 335066f

Browse files
rustagirrustagir
committed
DOCSP-41983: indexes landing pg
1 parent cd4c81f commit 335066f

File tree

152 files changed

+5566
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

152 files changed

+5566
-0
lines changed

‎source/includes/apiargs-MongoDBClient-common-option.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
arg_name: option
2+
name: readConcern
3+
type: :php:`MongoDB\\Driver\\ReadConcern <class.mongodb-driver-readconcern>`
4+
description: |
5+
:manual:`Read concern </reference/read-concern>` to use for the operation.
6+
Defaults to the client's read concern.
7+
interface: phpmethod
8+
operation: ~
9+
optional: true
10+
---
11+
arg_name: option
12+
name: readPreference
13+
type: :php:`MongoDB\\Driver\\ReadPreference <class.mongodb-driver-readpreference>`
14+
description: |
15+
:manual:`Read preference </reference/read-preference>` to use for the
16+
operation. Defaults to the client's read preference.
17+
interface: phpmethod
18+
operation: ~
19+
optional: true
20+
---
21+
source:
22+
file: apiargs-common-option.yaml
23+
ref: typeMap
24+
---
25+
arg_name: option
26+
name: writeConcern
27+
type: :php:`MongoDB\\Driver\\WriteConcern <class.mongodb-driver-writeconcern>`
28+
description: |
29+
:manual:`Write concern </reference/write-concern>` to use for the operation.
30+
Defaults to the client's write concern.
31+
interface: phpmethod
32+
operation: ~
33+
optional: true
34+
...

‎source/includes/apiargs-MongoDBClient-method-construct-driverOptions.yaml

Lines changed: 189 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,189 @@
1+
arg_name: option
2+
name: autoEncryption
3+
type: array
4+
description: |
5+
Options to configure client-side field-level encryption in the driver. The
6+
encryption options are documented in the :php:`extension documentation
7+
<manual/en/mongodb-driver-manager.construct.php#mongodb-driver-manager.construct-driveroptions>`.
8+
For the ``keyVaultClient`` option, you may pass a :phpclass:`MongoDB\\Client`
9+
instance, which will be unwrapped to provide a :php:`MongoDB\\Driver\\Manager <class.mongodb-driver-manager>`
10+
to the extension.
11+
12+
.. versionadded:: 1.6
13+
interface: phpmethod
14+
operation: ~
15+
optional: true
16+
---
17+
arg_name: option
18+
name: driver
19+
type: array
20+
description: |
21+
Additional driver metadata to be passed on to the server handshake. This is an
22+
array containing ``name``, ``version``, and ``platform`` fields:
23+
24+
.. code-block:: php
25+
26+
[
27+
'name' => 'my-driver',
28+
'version' => '1.2.3-dev',
29+
'platform' => 'some-platform',
30+
]
31+
32+
.. note::
33+
34+
This feature is primarily designed for custom drivers and ODMs, which may
35+
want to identify themselves to the server for diagnostic purposes.
36+
Applications should use the ``appName`` URI option instead of driver
37+
metadata.
38+
39+
.. versionadded:: 1.7
40+
interface: phpmethod
41+
operation: ~
42+
optional: true
43+
---
44+
arg_name: option
45+
name: serverApi
46+
type: :php:`MongoDB\\Driver\\ServerApi <class.mongodb-driver-serverapi>`
47+
description: |
48+
Used to declare an API version on the client. See the
49+
:manual:`Stable API tutorial </tutorial/stable-api>` for usage.
50+
51+
.. versionadded:: 1.9
52+
interface: phpmethod
53+
operation: ~
54+
optional: true
55+
---
56+
arg_name: option
57+
name: typeMap
58+
type: array
59+
description: |
60+
Default :php:`type map
61+
<manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps>`
62+
to apply to cursors, which determines how BSON documents are converted to PHP
63+
values. The |php-library| uses the following type map by default:
64+
65+
.. code-block:: php
66+
67+
[
68+
'array' => 'MongoDB\Model\BSONArray',
69+
'document' => 'MongoDB\Model\BSONDocument',
70+
'root' => 'MongoDB\Model\BSONDocument',
71+
]
72+
interface: phpmethod
73+
operation: ~
74+
optional: true
75+
---
76+
arg_name: option
77+
name: allow_invalid_hostname
78+
type: boolean
79+
description: |
80+
Disables hostname validation if ``true``. Defaults to ``false``.
81+
82+
Allowing invalid hostnames may expose the driver to a `man-in-the-middle
83+
attack <https://en.wikipedia.org/wiki/Man-in-the-middle_attack>`_.
84+
85+
.. deprecated:: 1.6
86+
This option has been deprecated. Use the ``tlsAllowInvalidHostnames`` URI
87+
option instead.
88+
interface: phpmethod
89+
operation: ~
90+
optional: true
91+
---
92+
arg_name: option
93+
name: ca_dir
94+
type: string
95+
description: |
96+
Path to a correctly hashed certificate directory. The system certificate store
97+
will be used by default.
98+
99+
Falls back to the deprecated ``capath`` SSL context option if not specified.
100+
interface: phpmethod
101+
operation: ~
102+
optional: true
103+
---
104+
arg_name: option
105+
name: ca_file
106+
type: string
107+
description: |
108+
Path to a certificate authority file. The system certificate store will be
109+
used by default.
110+
111+
Falls back to the deprecated ``cafile`` SSL context option if not specified.
112+
113+
.. deprecated:: 1.6
114+
This option has been deprecated. Use the ``tlsCAFile`` URI option instead.
115+
interface: phpmethod
116+
operation: ~
117+
optional: true
118+
---
119+
arg_name: option
120+
name: crl_file
121+
type: string
122+
description: |
123+
Path to a certificate revocation list file.
124+
interface: phpmethod
125+
operation: ~
126+
optional: true
127+
---
128+
arg_name: option
129+
name: pem_file
130+
type: string
131+
description: |
132+
Path to a PEM encoded certificate to use for client authentication.
133+
134+
Falls back to the deprecated ``local_cert`` SSL context option if not
135+
specified.
136+
137+
.. deprecated:: 1.6
138+
This option has been deprecated. Use the ``tlsCertificateKeyFile`` URI
139+
option instead.
140+
interface: phpmethod
141+
operation: ~
142+
optional: true
143+
---
144+
arg_name: option
145+
name: pem_pwd
146+
type: string
147+
description: |
148+
Passphrase for the PEM encoded certificate (if applicable).
149+
150+
Falls back to the deprecated ``passphrase`` SSL context option if not
151+
specified.
152+
153+
.. deprecated:: 1.6
154+
This option has been deprecated. Use the ``tlsCertificateKeyFilePassword``
155+
URI option instead.
156+
interface: phpmethod
157+
operation: ~
158+
optional: true
159+
---
160+
arg_name: option
161+
name: weak_cert_validation
162+
type: boolean
163+
description: |
164+
Disables certificate validation ``true``. Defaults to ``false``.
165+
166+
Falls back to the deprecated ``allow_self_signed`` SSL context option if not
167+
specified.
168+
169+
.. deprecated:: 1.6
170+
This option has been deprecated. Use the ``tlsAllowInvalidCertificates``
171+
URI option instead.
172+
interface: phpmethod
173+
operation: ~
174+
optional: true
175+
---
176+
arg_name: option
177+
name: context
178+
type: resource
179+
description: |
180+
:php:`SSL context options <manual/en/context.ssl.php>` to be used as fallbacks
181+
for other driver options (as specified). Note that the driver does not consult
182+
the default stream context.
183+
184+
This option is supported for backwards compatibility, but should be considered
185+
deprecated.
186+
interface: phpmethod
187+
operation: ~
188+
optional: true
189+
...

‎source/includes/apiargs-MongoDBClient-method-construct-param.yaml

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
arg_name: param
2+
name: $uri
3+
type: string
4+
description: |
5+
The URI of the standalone, replica set, or sharded cluster to which to
6+
connect. Refer to :manual:`Connection String URI Format
7+
</reference/connection-string>` in the MongoDB manual for more information.
8+
9+
Defaults to ``"mongodb://127.0.0.1:27017"`` if unspecified.
10+
11+
Any special characters in the URI components need to be encoded according to
12+
`RFC 3986 <https://www.rfc-editor.org/info/rfc3986>`_. This is particularly
13+
relevant to the username and password, which can often include special
14+
characters such as ``@``, ``:``, or ``%``. When connecting via a Unix domain
15+
socket, the socket path may contain special characters such as slashes and
16+
must be encoded. The :php:`rawurlencode() <rawurlencode>` function may be used
17+
to encode constituent parts of the URI.
18+
interface: phpmethod
19+
operation: ~
20+
optional: true
21+
---
22+
arg_name: param
23+
name: $uriOptions
24+
type: array
25+
description: |
26+
Specifies additional URI options, such as authentication credentials or query
27+
string parameters. The options specified in ``$uriOptions`` take precedence
28+
over any analogous options present in the ``$uri`` string and do not need to
29+
be encoded according to `RFC 3986 <https://www.rfc-editor.org/info/rfc3986>`_.
30+
31+
Refer to the :php:`MongoDB\\Driver\\Manager::__construct()
32+
<mongodb-driver-manager.construct>` extension reference and :manual:`MongoDB
33+
connection string </reference/connection-string>` documentation for accepted
34+
options.
35+
interface: phpmethod
36+
operation: ~
37+
optional: true
38+
---
39+
arg_name: param
40+
name: $driverOptions
41+
type: array
42+
description: |
43+
Specify driver-specific options, such as SSL options. In addition to any
44+
options supported by the :php:`extension <mongodb-driver-manager>`, the
45+
|php-library| allows you to specify a default :php:`type map
46+
<manual/en/mongodb.persistence.deserialization.php#mongodb.persistence.typemaps>`
47+
to apply to the cursors it creates.
48+
interface: phpmethod
49+
operation: ~
50+
optional: true
51+
...

‎source/includes/apiargs-MongoDBClient-method-createClientEncryption-param.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source:
2+
file: apiargs-common-param.yaml
3+
ref: $options
4+
...

‎source/includes/apiargs-MongoDBClient-method-dropDatabase-option.yaml

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
source:
2+
file: apiargs-common-option.yaml
3+
ref: comment
4+
post: |
5+
This is not supported for server versions prior to 4.4 and will result in an
6+
exception at execution time if used.
7+
8+
.. versionadded:: 1.13
9+
---
10+
source:
11+
file: apiargs-common-option.yaml
12+
ref: session
13+
post: |
14+
.. versionadded:: 1.3
15+
---
16+
source:
17+
file: apiargs-common-option.yaml
18+
ref: typeMap
19+
post: |
20+
This will be used for the returned command result document.
21+
---
22+
source:
23+
file: apiargs-MongoDBClient-common-option.yaml
24+
ref: writeConcern
25+
...

‎source/includes/apiargs-MongoDBClient-method-dropDatabase-param.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
source:
2+
file: apiargs-common-param.yaml
3+
ref: $databaseName
4+
replacement:
5+
action: " to drop"
6+
---
7+
source:
8+
file: apiargs-common-param.yaml
9+
ref: $options
10+
...

‎source/includes/apiargs-MongoDBClient-method-get-param.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
source:
2+
file: apiargs-common-param.yaml
3+
ref: $databaseName
4+
replacement:
5+
action: " to select"
6+
...

‎source/includes/apiargs-MongoDBClient-method-listDatabases-option.yaml

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
arg_name: option
2+
name: authorizedDatabases
3+
type: boolean
4+
description: |
5+
A flag that determines which databases are returned based on the user
6+
privileges when access control is enabled. For more information, see the
7+
`listDatabases command documentation <https://mongodb.com/docs/manual/reference/command/listDatabases/>`_.
8+
9+
For servers < 4.0.5, this option is ignored.
10+
11+
.. versionadded:: 1.7
12+
interface: phpmethod
13+
operation: ~
14+
optional: true
15+
---
16+
source:
17+
file: apiargs-common-option.yaml
18+
ref: comment
19+
post: |
20+
This is not supported for server versions prior to 4.4 and will result in an
21+
exception at execution time if used.
22+
23+
.. versionadded:: 1.13
24+
---
25+
arg_name: option
26+
name: filter
27+
type: array|object
28+
description: |
29+
A query expression to filter the list of databases.
30+
31+
You can specify a query expression for database fields (e.g. ``name``,
32+
``sizeOnDisk``, ``empty``).
33+
34+
.. versionadded:: 1.3
35+
interface: phpmethod
36+
operation: ~
37+
optional: true
38+
---
39+
source:
40+
file: apiargs-common-option.yaml
41+
ref: maxTimeMS
42+
---
43+
source:
44+
file: apiargs-common-option.yaml
45+
ref: session
46+
post: |
47+
.. versionadded:: 1.3

‎source/includes/apiargs-MongoDBClient-method-listDatabases-param.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
source:
2+
file: apiargs-common-param.yaml
3+
ref: $options
4+
...

0 commit comments

Comments
 (0)