Skip to content

Commit 5c07bd3

Browse files
author
Christian Hergert
committed
doc: add missing client documentation.
1 parent 4cc3d33 commit 5c07bd3

File tree

3 files changed

+85
-0
lines changed

3 files changed

+85
-0
lines changed
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
mongoc_client_get_max_bson_size(3)
2+
==================================
3+
4+
5+
NAME
6+
----
7+
mongoc_client_get_max_bson_size, mongoc_client_get_max_message_size - get max sizes as related to the server
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
int32_t mongoc_client_get_max_bson_size (mongoc_client_t *client);
15+
int32_t mongoc_client_get_max_message_size (mongoc_client_t *client);
16+
-----------------------
17+
18+
19+
DESCRIPTION
20+
-----------
21+
The _mongoc_client_get_max_bson_size()_ returns the maximum bson document size
22+
allowed by the cluster. Until a connection has been made, this will be the
23+
default of 16Mb.
24+
25+
The _mongoc_client_get_max_document_size()_ returns the maximum wire protocol
26+
message size. Until a connection has been made, this will be the default of
27+
40Mb.
28+
29+
30+
SEE ALSO
31+
--------
32+
linkmongoc:mongoc_client[7]
33+
34+
35+
AUTHORS
36+
-------
37+
38+
This page was written by MongoDB, Inc.
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
mongoc_client_get_max_bson_size.txt
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
mongoc_client_get_server_status(3)
2+
==================================
3+
4+
5+
NAME
6+
----
7+
mongoc_client_get_server_status - helper for the serverStatus command
8+
9+
10+
SYNOPSIS
11+
--------
12+
[source,c]
13+
-----------------------
14+
bool mongoc_client_get_server_status (mongoc_client_t *client,
15+
mongoc_read_prefs_t *read_prefs,
16+
bson_t *reply,
17+
bson_error_t *error);
18+
-----------------------
19+
20+
21+
DESCRIPTION
22+
-----------
23+
The _mongoc_client_get_server_status()_ function will call the serverStatus
24+
command on a MongoDB server. _read_prefs_ can be used to specify the type
25+
of server you wish to connect to.
26+
27+
The result is stored in _reply_. You must always call _bson_destroy()_ to
28+
cleanup the result document stored in _reply_, even upon failure.
29+
30+
false is returned up error, otherwise true.
31+
32+
33+
ERRORS
34+
------
35+
Errors are reported via _error_ and _reply_.
36+
37+
38+
SEE ALSO
39+
--------
40+
linkmongoc:mongoc_client[7]
41+
42+
43+
AUTHORS
44+
-------
45+
46+
This page was written by MongoDB, Inc.

0 commit comments

Comments
 (0)