File: MongoDB_Driver_Manager.xml

package info (click to toggle)
phpdox 0.12.0-6
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, sid
  • size: 7,672 kB
  • sloc: xml: 80,724; php: 9,167; makefile: 13
file content (104 lines) | stat: -rw-r--r-- 6,311 bytes parent folder | download | duplicates (2)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
<?xml version="1.0" encoding="UTF-8" ?>
<class xmlns="http://xml.phpdox.net/src" full="MongoDB\Driver\Manager" namespace="MongoDB\Driver" name="Manager">
  <constructor name="__construct" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Create new MongoDB Manager"/>
      <return type="void"/>
    </docblock>
    <parameter name="uri" optional="true" byreference="false" type="string"/>
    <parameter name="uriOptions" optional="true" byreference="false" type="object" class="array"/>
    <parameter name="driverOptions" optional="true" byreference="false" type="object" class="array"/>
  </constructor>
  <method name="executeBulkWrite" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute one or more write operations">Executes one or more write operations on the primary server.</description>
      <return type="MongoDB\Driver\WriteResult"/>
    </docblock>
    <parameter name="namespace" optional="false" byreference="false" type="string"/>
    <parameter name="bulk" optional="false" byreference="false" type="object" class="MongoDB\Driver\BulkWrite"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command">Selects a server according to the "readPreference" option and executes the command on that server. By default, the read preference from the MongoDB Connection URI will be used.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeQuery" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database query"/>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="namespace" optional="false" byreference="false" type="string"/>
    <parameter name="query" optional="false" byreference="false" type="object" class="MongoDB\Driver\Query"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeReadCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that reads">Selects a server according to the "readPreference" option and executes the command on that server. By default, the read preference from the MongoDB Connection URI will be used.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeReadWriteCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that reads and writes">Executes the command on the primary server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="executeWriteCommand" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Execute a database command that writes">Executes the command on the primary server.</description>
      <return type="MongoDB\Driver\Cursor"/>
    </docblock>
    <parameter name="db" optional="false" byreference="false" type="string"/>
    <parameter name="command" optional="false" byreference="false" type="object" class="MongoDB\Driver\Command"/>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
  <method name="getReadConcern" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Return the ReadConcern for the Manager"/>
      <return type="MongoDB\Driver\ReadConcern"/>
    </docblock>
  </method>
  <method name="getReadPreference" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Return the ReadPreference for the Manager"/>
      <return type="MongoDB\Driver\ReadPreference"/>
    </docblock>
  </method>
  <method name="getServers" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Return the servers to which this manager is connected"/>
      <return type="array"/>
    </docblock>
  </method>
  <method name="getWriteConcern" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Return the WriteConcern for the Manager"/>
      <return type="MongoDB\Driver\WriteConcern"/>
    </docblock>
  </method>
  <method name="selectServer" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Select a server matching a read preference"/>
      <return type="MongoDB\Driver\Server"/>
    </docblock>
    <parameter name="readPreference" optional="false" byreference="false" type="object" class="MongoDB\Driver\ReadPreference"/>
  </method>
  <method name="startSession" abstract="false" static="false" visibility="public" final="true">
    <docblock>
      <description compact="Start a new client session for use with this client"/>
      <return type="MongoDB\Driver\Session"/>
    </docblock>
    <parameter name="options" optional="true" byreference="false" type="object" class="array"/>
  </method>
</class>