Skip to content

Commit

Permalink
more build errors
Browse files Browse the repository at this point in the history
  • Loading branch information
norareidy committed Apr 2, 2024
1 parent d7a3dae commit 10d974d
Show file tree
Hide file tree
Showing 31 changed files with 71 additions and 105 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The BSON document for TLS options may contain the following keys:
:end-before: END:mongoc_client_encryption_opts_set_tls_opts
:dedent: 6

See :ref:`configuring_tls` for a description of the behavior of these options.
See :ref:`mongoc_configuring_tls` for a description of the behavior of these options.

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ MONGOC_ERROR_QUERY_FAILURE; in this case check whether the error message is equa
the string "ns not found".

The ``encryptedFields`` document in ``opts`` may be used to drop a collection for
:ref:`Queryable Encryption </queryable-encryption>`. If ``encryptedFields`` is specified,
:ref:`Queryable Encryption <queryable-encryption>`. If ``encryptedFields`` is specified,
the "ns not found" error is not returned.

Errors
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ Do not use this function to call the basic write commands "insert", "update", an
Those commands require special logic not implemented in ``mongoc_collection_write_command_with_opts``.
For basic write operations use CRUD functions such as :ref:`mongoc_collection_insert_one`
and the others described in :ref:`the CRUD tutorial <tutorial_crud_operations>`, or use the
:ref:`Bulk API <bulk>`.
:ref:`Bulk API <mongoc_bulk>`.

Example
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This function creates a :ref:`mongoc_collection_t` from the given :ref:`mongoc_d
If no write concern is provided in ``opts``, the database's write concern is used.

The ``encryptedFields`` document in ``opts`` may be used to create a collection used for
:ref:`Queryable Encryption </queryable-encryption>`.
:ref:`Queryable Encryption <queryable-encryption>`.

For a list of all options, see `the MongoDB Manual entry on the create command
<https://www.mongodb.com/docs/manual/reference/command/create/>`__.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ This function attempts to drop a database on the MongoDB server.
If no write concern is provided in ``opts``, the database's write concern is used.

The ``encryptedFields`` document in ``opts`` may be used to drop a collection used for
:ref:`Queryable Encryption </queryable-encryption>`.
:ref:`Queryable Encryption <queryable-encryption>`.

Errors
------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,6 @@ Execute a command on the server, applying logic that is specific to commands tha
read, and taking the MongoDB server version into account. To send a raw command to
the server without any of this logic, use :ref:`mongoc_database_command_simple`.

.. ``opts-source`` replace:: ``database``

.. include:: /libmongoc/includes/read-cmd-opts-sources.txt

``reply`` is always initialized, and must be freed with :ref:`bson_destroy`.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Parameters
- ``file_id``: A :ref:`bson_value_t` to receive the generated id of the file or ``NULL``.
- ``error``: A :ref:`bson_error_t` to receive any error or ``NULL``.

.. include:: includes/gridfs-bucket-upload-opts.txt
.. include:: /libmongoc/includes/gridfs-bucket-upload-opts.txt

Description
-----------
Expand Down
24 changes: 12 additions & 12 deletions source/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -46,18 +46,18 @@ Functions
:titlesonly:
:maxdepth: 1

/mongoc_gridfs_bucket_tongoc_gridfs_bucket_abort_upload
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_delete_by_id
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_destroy
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_download_to_stream
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_find
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_new
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_open_download_stream
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_open_upload_stream
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_open_upload_stream_with_id
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_stream_error
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_upload_from_stream
/mongoc_gridfs_bucket_tongoc_gridfs_bucket_upload_from_stream_with_id
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_abort_upload
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_delete_by_id
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_destroy
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_download_to_stream
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_find
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_new
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_open_download_stream
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_open_upload_stream
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_open_upload_stream_with_id
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_stream_error
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_upload_from_stream
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_bucket_upload_from_stream_with_id

.. seealso::

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_gridfs_file_list_destroy
mongoc_gridfs_file_list_error
mongoc_gridfs_file_list_next
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_list_destroy
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_list_error
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_list_next

48 changes: 24 additions & 24 deletions source/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_t.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,30 +32,30 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_gridfs_file_destroy
mongoc_gridfs_file_error
mongoc_gridfs_file_get_aliases
mongoc_gridfs_file_get_chunk_size
mongoc_gridfs_file_get_content_type
mongoc_gridfs_file_get_filename
mongoc_gridfs_file_get_id
mongoc_gridfs_file_get_length
mongoc_gridfs_file_get_md5
mongoc_gridfs_file_get_metadata
mongoc_gridfs_file_get_upload_date
mongoc_gridfs_file_readv
mongoc_gridfs_file_remove
mongoc_gridfs_file_save
mongoc_gridfs_file_seek
mongoc_gridfs_file_set_aliases
mongoc_gridfs_file_set_content_type
mongoc_gridfs_file_set_filename
mongoc_gridfs_file_set_id
mongoc_gridfs_file_set_md5
mongoc_gridfs_file_set_metadata
mongoc_gridfs_file_tell
mongoc_gridfs_file_writev
mongoc_stream_gridfs_new
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_destroy
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_error
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_aliases
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_chunk_size
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_content_type
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_filename
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_id
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_length
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_md5
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_metadata
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_get_upload_date
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_readv
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_remove
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_save
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_seek
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_aliases
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_content_type
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_filename
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_id
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_md5
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_set_metadata
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_tell
/libmongoc/api/mongoc_gridfs_t/mongoc_gridfs_file_writev
/libmongoc/api/mongoc_gridfs_t/mongoc_stream_gridfs_new

Related
-------
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,8 +32,8 @@ Functions
:titlesonly:
:maxdepth: 1

mongoc_index_opt_geo_get_default
mongoc_index_opt_geo_init
/libmongoc/api/mongoc_index_opt_t/mongoc_index_opt_geo_get_default
/libmongoc/api/mongoc_index_opt_t/mongoc_index_opt_geo_init

.. seealso::

Expand Down
35 changes: 0 additions & 35 deletions source/libmongoc/api/mongoc_stream_t/mongoc_stream_gridfs_new.txt

This file was deleted.

2 changes: 1 addition & 1 deletion source/libmongoc/includes/bulk-opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,6 @@

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``ordered``: set to ``false`` to attempt to insert all documents, continuing after errors.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``let``: A BSON document consisting of any number of parameter names, each followed by definitions of constants in the MQL Aggregate Expression language.
* ``comment``: A :ref:`bson_value_t` specifying the comment to attach to this command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
2 changes: 1 addition & 1 deletion source/libmongoc/includes/create-index-opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,4 @@
``command_opts`` may be NULL or a BSON document with additional command options:

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
2 changes: 1 addition & 1 deletion source/libmongoc/includes/delete-many-opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
``opts`` may be NULL or a BSON document with additional command options:

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``validate``: Construct a bitwise-or of all desired :ref:`bson_validate_flags_t <bson_validate_with_error>`. Set to ``false`` to skip client-side validation of the provided BSON documents.
* ``comment``: A :ref:`bson_value_t` specifying the comment to attach to this command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
* ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
Expand Down
3 changes: 2 additions & 1 deletion source/libmongoc/includes/delete-one-opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@
``opts`` may be NULL or a BSON document with additional command options:

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t`
that overrides the options inherited from ``collection``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``validate``: Construct a bitwise-or of all desired :ref:`bson_validate_flags_t <bson_validate_with_error>`. Set to ``false`` to skip client-side validation of the provided BSON documents.
* ``comment``: A :ref:`bson_value_t` specifying the comment to attach to this command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
* ``collation``: Configure textual comparisons. See :ref:`Setting Collation Order <setting_collation_order>`, and `the MongoDB Manual entry on Collation <https://www.mongodb.com/docs/manual/reference/collation/>`_. Collation requires MongoDB 3.2 or later, otherwise an error is returned.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
``extra`` may be NULL or a BSON document with additional command options:

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``hint``: A document or string that specifies the index to use to support the query predicate.
* ``let``: A BSON document consisting of any number of parameter names, each followed by definitions of constants in the MQL Aggregate Expression language.
* ``comment``: A :ref:`bson_value_t` specifying the comment to attach to this command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
2 changes: 1 addition & 1 deletion source/libmongoc/includes/generic-opts.txt
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
``opts`` may be NULL or a BSON document with additional command options:

* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``serverId``: To target a specific server, include an int32 "serverId" field. Obtain the id by calling :ref:`mongoc_client_select_server`, then :ref:`mongoc_server_description_id` on its return value.
2 changes: 1 addition & 1 deletion source/libmongoc/includes/insert-many-opts.txt
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
``opts`` may be NULL or a BSON document with additional command options:

* ``writeConcern``: Construct a :ref:`mongoc_write_concern_t` and use :ref:`mongoc_write_concern_append` to add the write concern to ``opts``. See the example code for :ref:`mongoc_client_write_command_with_opts`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from |opts-source|, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``sessionId``: First, construct a :ref:`mongoc_client_session_t` with :ref:`mongoc_client_start_session`. You can begin a transaction with :ref:`mongoc_client_session_start_transaction`, optionally with a :ref:`mongoc_transaction_opt_t` that overrides the options inherited from ``database,`` ``collection``, or ``client``, and use :ref:`mongoc_client_session_append` to add the session to ``opts``. See the example code for :ref:`mongoc_client_session_t`.
* ``validate``: Construct a bitwise-or of all desired :ref:`bson_validate_flags_t <bson_validate_with_error>`. Set to ``false`` to skip client-side validation of the provided BSON documents.
* ``comment``: A :ref:`bson_value_t` specifying the comment to attach to this command. The comment will appear in log messages, profiler output, and currentOp output. Requires MongoDB 4.4 or later.
* ``ordered``: set to ``false`` to attempt to insert all documents, continuing after errors.
Expand Down
Loading

0 comments on commit 10d974d

Please sign in to comment.