Skip to content

Commit 0b6f3ba

Browse files
authored
DOCSP-29036: API files (#5)
* DOCSP-29036: API files * more files * more files * client_t files * mongoc_collection files * mongoc_cursor files * mongoc_database * small changes to all * more edits * more api files * delete files * more edits
1 parent 20b1d47 commit 0b6f3ba

File tree

1,152 files changed

+22587
-21006
lines changed

Some content is hidden

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

1,152 files changed

+22587
-21006
lines changed

.DS_Store

-6 KB
Binary file not shown.

source/.DS_Store

-6 KB
Binary file not shown.

source/docs-libmongoc/.DS_Store

-10 KB
Binary file not shown.

source/docs-libmongoc/CMakeLists.txt

Lines changed: 0 additions & 9 deletions
This file was deleted.

source/docs-libmongoc/api/.DS_Store

-18 KB
Binary file not shown.

source/docs-libmongoc/api/errors.txt

Lines changed: 277 additions & 142 deletions
Large diffs are not rendered by default.

source/docs-libmongoc/api/errors/mongoc_error_has_label.rst

Lines changed: 0 additions & 25 deletions
This file was deleted.
Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
.. _mongoc_error_has_label:
2+
3+
========================
4+
mongoc_error_has_label()
5+
========================
6+
7+
Synopsis
8+
--------
9+
10+
.. code-block:: c
11+
12+
bool
13+
mongoc_error_has_label (const bson_t *reply, const char *label);
14+
15+
Test whether a reply from a failed operation includes a specific error label. See
16+
:ref:`Error Labels <error_labels>` for details, and see :ref:`mongoc_client_session_start_transaction`
17+
for example code that demonstrates their use.
18+
19+
Parameters
20+
----------
21+
22+
- ``reply``: A ``bson_t-storage-ptr`` to contain the results.
23+
- ``label``: The label to test for, such as "TransientTransactionError" or "UnknownTransactionCommitResult".
24+
25+
Returns
26+
-------
27+
28+
Returns true if ``reply`` contains the error label.

source/docs-libmongoc/api/gridfs.rst

Lines changed: 0 additions & 11 deletions
This file was deleted.

source/docs-libmongoc/api/gridfs.txt

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
.. _gridfs:
2+
3+
======
4+
GridFS
5+
======
6+
7+
The C driver includes two APIs for GridFS.
8+
9+
The older API consists of :ref:`mongoc_gridfs_t` and its derivatives. It contains deprecated API, does not support read preferences, and is not recommended in new applications. It does not conform to the `MongoDB GridFS specification <https://github.com/mongodb/specifications/blob/master/source/gridfs/gridfs-spec.rst>`_.
10+
11+
The newer API consists of :ref:`mongoc_gridfs_bucket_t` and allows uploading/downloading through derived :ref:`mongoc_stream_t` objects. It conforms to the `MongoDB GridFS specification <https://github.com/mongodb/specifications/blob/master/source/gridfs/gridfs-spec.rst>`_.
12+
13+
There is not always a straightforward upgrade path from an application built with :ref:`mongoc_gridfs_t` to :ref:`mongoc_gridfs_bucket_t` (e.g. a :ref:`mongoc_gridfs_file_t` provides functions to seek but :ref:`mongoc_stream_t` does not). But users are encouraged to upgrade when possible.

0 commit comments

Comments
 (0)