Skip to content

Commit 80fcbe7

Browse files
committed
update URI option documentation
1 parent 61066ca commit 80fcbe7

File tree

1 file changed

+8
-3
lines changed

1 file changed

+8
-3
lines changed

docs/tutorials/ruby-driver-create-client.txt

Lines changed: 8 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,11 +106,14 @@ URI Options Conversions
106106
* - authMechanismProperties=Strings
107107
- ``{ :auth_mech_properties => { :service_realm => String, :canonicalize_host_name => true|false, :service_name => String } }``
108108

109+
Specified as comma-separated key:value pairs, e.g. ``"SERVICE_REALM:foo,CANONICALIZE_HOSTNAME:TRUE"``
110+
109111
* - authSource=String
110112
- ``:auth_source => String``
111113

112114
* - compressors=Strings
113115
- ``:compressors => Array<String>``
116+
Specified as a comma-separated list, e.g. "zlib,snappy"
114117

115118
* - connect=String
116119
- ``:connect => Symbol``
@@ -146,7 +149,9 @@ URI Options Conversions
146149
- ``{ :read => { :mode => Symbol }}``
147150

148151
* - readPreferenceTags=Strings
149-
- ``{ :read => { :tag_sets => Array<String> }}``
152+
- ``{ :read => { :tag_sets => Array<Hash> }}``
153+
154+
Each instance of the readPreferenceTags field is a comma-separated key:value pair which will appear in the :tag_sets array in the order they are specified. For instance, ``"readPreferenceTags=dc:ny,rack:1&readPreferenceTags=dc:ny"`` will be converted to ``[ { 'dc' => 'ny', 'rack' => '1' }, { 'dc' => 'ny' }]``.
150155

151156
* - replicaSet=String
152157
- ``:replica_set => String``
@@ -163,7 +168,7 @@ URI Options Conversions
163168
* - tlsAllowInvalidCertificates=Boolean
164169
- ``:ssl_verify => boolean``
165170

166-
NOTE: Because ``tlsAllowInvalidCertificates`` uses ``true`` to sigify that verification
171+
Because ``tlsAllowInvalidCertificates`` uses ``true`` to signify that verification
167172
should be disabled and ``ssl_verify`` uses ``false`` to signify that verification should be
168173
disabled, the boolean is inverted before being used to set ``ssl_verify``
169174

@@ -182,7 +187,7 @@ URI Options Conversions
182187
* - tlsInsecure=Boolean
183188
- ``:ssl_verify => boolean``
184189

185-
NOTE: Because tlsInsecure uses ``true`` to sigify that verification should be disabled and
190+
Because tlsInsecure uses ``true`` to signify that verification should be disabled and
186191
``ssl_verify`` uses ``false`` to signify that verification should be disabled, the boolean
187192
is inverted before being used to set ``ssl_verify``
188193

0 commit comments

Comments
 (0)