Skip to content

Commit d5c501a

Browse files
schmallisojmikola
authored andcommitted
Port docs to RST and split the API reference
1 parent ab7aba1 commit d5c501a

File tree

133 files changed

+7609
-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.

133 files changed

+7609
-0
lines changed

docs/.static/.mongodb

Whitespace-only changes.
File renamed without changes.
Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
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 connect. Refer
6+
to the :manual:`MongoDB connection string reference </reference/connection-string>`
7+
for formatting.
8+
9+
Defaults to ``mongodb://localhost:27017`` if unspecified.
10+
interface: phpmethod
11+
operation: MongoDB\\Client::__construct
12+
optional: true
13+
position: 1
14+
---
15+
arg_name: param
16+
name: $uriOptions
17+
type: array
18+
description: |
19+
Specifies additional URI options, such as authentication credentials
20+
or query string parameters. The options specified in ``$uriOptions``
21+
take precedence over any analogous options present in the
22+
``$uri`` string.
23+
post: |
24+
Refer to the :php:`MongoDB\\Driver\\Manager::__construct()
25+
<mongodb-driver-manager.construct>` extension reference and
26+
:manual:`MongoDB connection string </reference/connection-string>`
27+
documentation for valid options.
28+
interface: phpmethod
29+
operation: MongoDB\\Client::__construct
30+
optional: true
31+
position: 2
32+
---
33+
arg_name: param
34+
name: $driverOptions
35+
type: array
36+
description: |
37+
Specify driver-specific options. In addition to any
38+
options supported by the :php:`extension <mongodb-driver-manager>`,
39+
the |php-library| allows you to specify a default ``typeMap`` to
40+
apply to the cursors it creates. Refer to the driver's
41+
:php:`Persistence documentation <mongodb-persistence>` for more
42+
about type maps.
43+
interface: phpmethod
44+
operation: MongoDB\\Client::__construct
45+
optional: true
46+
position: 3
47+
...
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
arg_name: option
2+
interface: phpmethod
3+
operation: MongoDB\\Client::dropDatabase
4+
source:
5+
file: apiargs-common-option.yaml
6+
ref: typeMap
7+
position: 1
8+
...
Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
source:
2+
ref: $databaseName
3+
file: apiargs-common-param.yaml
4+
arg_name: param
5+
interface: phpmethod
6+
operation: MongoDB\\Client::dropDatabase
7+
---
8+
source:
9+
ref: $options
10+
file: apiargs-common-param.yaml
11+
arg_name: param
12+
interface: phpmethod
13+
operation: MongoDB\\Client::dropDatabase
14+
position: 2
15+
...
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source:
2+
ref: $databaseName
3+
file: apiargs-common-param.yaml
4+
arg_name: param
5+
interface: phpmethod
6+
operation: MongoDB\\Client::__get
7+
...
Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
source:
2+
file: apiargs-common-option.yaml
3+
ref: maxTimeMS
4+
position: 1
5+
...
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
source:
2+
ref: $options
3+
file: apiargs-common-param.yaml
4+
arg_name: param
5+
interface: phpmethod
6+
operation: MongoDB\\Client::listDatabases
7+
position: 1
8+
...
Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
source:
2+
ref: readConcern
3+
file: apiargs-common-option.yaml
4+
operation: MongoDB\\Client::selectDatabase
5+
replacement:
6+
resource: "database"
7+
---
8+
source:
9+
ref: readPreference
10+
file: apiargs-common-option.yaml
11+
operation: MongoDB\\Client::selectDatabase
12+
replacement:
13+
resource: "database"
14+
---
15+
source:
16+
ref: typeMap
17+
file: apiargs-common-option.yaml
18+
operation: MongoDB\\Client::selectDatabase
19+
---
20+
source:
21+
ref: writeConcern
22+
file: apiargs-common-option.yaml
23+
operation: MongoDB\\Client::selectDatabase
24+
replacement:
25+
resource: "database"
26+
...
Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
source:
2+
ref: $databaseName
3+
file: apiargs-common-param.yaml
4+
operation: MongoDB\\Client::selectDatabase
5+
position: 1
6+
---
7+
source:
8+
ref: $options
9+
file: apiargs-common-param.yaml
10+
operation: MongoDB\\Client::selectDatabase
11+
position: 2
12+
...

0 commit comments

Comments
 (0)