diff --git a/config/redirects b/config/redirects index eb8568d37..98b59dcc2 100644 --- a/config/redirects +++ b/config/redirects @@ -28,6 +28,10 @@ raw: docs/drivers/use-cases/client-side-field-level-encryption-guide -> ${manual raw: docs/drivers/use-cases/client-side-field-level-encryption-local-key-to-kms -> ${manual}/core/csfle/tutorials/ raw: docs/drivers/use-cases/sensitive-data-encryption -> ${manual}/core/csfle/ +# C + +raw: docs/drivers/c -> https://www.mongodb.com/docs/languages/c/c-driver/current/ + ### ### Redirects for Legacy Drivers Content diff --git a/source/c.txt b/source/c.txt deleted file mode 100644 index 836d49c22..000000000 --- a/source/c.txt +++ /dev/null @@ -1,130 +0,0 @@ -.. _c-language-center: - -================ -MongoDB C Driver -================ - -.. facet:: - :name: programming_language - :values: c - -.. facet:: - :name: genre - :values: reference - -.. meta:: - :keywords: code example, get started, sample app - -.. contents:: On this page - :local: - :backlinks: none - :depth: 1 - :class: twocols - -Introduction ------------- - -Welcome to the documentation site for the official MongoDB C driver. -You can add the driver to your application to work with MongoDB in C. -Download the required libraries, ``libmongoc`` and ``libbson``, from -`mongoc.org `__ -or set up a runnable project by following our tutorial. - -- `Tutorial `__ - -- `Usage Guide `__ - -- `MongoDB Developer Center `__ - -- `API Reference `_ - -- `Changelog `__ - -- `Source Code `__ - -- `Examples `__ - -- `Additional BSON Examples `__ - -Installation ------------- - -See `Installing the MongoDB C Driver (libmongoc) and BSON library (libbson) -`__. - -.. _connect-atlas-c-driver: - -Connect to MongoDB Atlas ------------------------- - -You can use the following connection snippet to test your connection to your -MongoDB deployment on Atlas: - -.. literalinclude:: /includes/connection-snippets/scram/c-connection.c - :language: c - -This connection snippet uses the {+stable-api+} feature which you can use when -connecting to MongoDB Server v5.0 and later and the C driver v1.18 and later. - -When you use this feature, you can update your driver or server without -worrying about backward compatibility issues with any commands covered by the -{+stable-api+}. - -.. include:: /includes/stable-api-notice.rst - -.. _connect-atlas-no-stable-api-c-driver: - -Connect to MongoDB Atlas Without the Stable API ------------------------------------------------ - -If you are using a version of MongoDB or the driver that lacks support for the -{+stable-api+}, you can use the following code snippet to test your connection -to your MongoDB deployment on Atlas: - -.. literalinclude:: /includes/connection-snippets/scram/c-connection-no-stable-api.c - :language: c - -Connect to a MongoDB Server on Your Local Machine -------------------------------------------------- - -.. include:: /includes/localhost-connection.rst - -To test whether you can connect to your server, replace the connection -string in the :ref:`Connect to MongoDB Atlas ` code -example and run it. - -See `Advanced Connections `__ -for more ways to connect. - -.. include:: /includes/serverless-compatibility.rst - -Compatibility -------------- - -MongoDB Compatibility -~~~~~~~~~~~~~~~~~~~~~ - -The compatibility table in this section specifies the recommended version or -versions of the MongoDB C driver for use with a specific version of MongoDB. - -The first column lists the driver version. - -.. sharedinclude:: dbx/lifecycle-schedule-callout.rst - -.. include:: /includes/mongodb-compatibility-table-c.rst - -.. include:: /includes/older-server-versions-unsupported.rst - -Language Compatibility -~~~~~~~~~~~~~~~~~~~~~~ - -The following compatibility table specifies the recommended version(s) of the -MongoDB C driver for use with a specific version of C. - -The first column lists the driver version(s). - -.. include:: /includes/language-compatibility-table-c.rst - -.. include:: /includes/about-driver-compatibility.rst - -.. include:: /includes/help-links-c.rst diff --git a/source/includes/help-links-c.rst b/source/includes/help-links-c.rst deleted file mode 100644 index 53694b1fd..000000000 --- a/source/includes/help-links-c.rst +++ /dev/null @@ -1,6 +0,0 @@ -How to get help ---------------- - -- Ask questions on our :community-forum:`MongoDB Community Forums <>`. -- Visit our :technical-support:`Support Channels `. -- File a bug or feature request on :issue:`JIRA `. diff --git a/source/includes/language-compatibility-table-c.rst b/source/includes/language-compatibility-table-c.rst deleted file mode 100644 index fbebee16e..000000000 --- a/source/includes/language-compatibility-table-c.rst +++ /dev/null @@ -1,31 +0,0 @@ -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility - :widths: 40 15 15 15 15 - - * - C Driver Version - - C17/C18 - - C11 - - C99 - - C89 - * - 1.26 - - ✓ - - ✓ - - ✓ - - - * - 1.25 - - ✓ - - ✓ - - ✓ - - - * - 1.24 - - ✓ - - ✓ - - ✓ - - - * - <= 1.23 - - - - ✓ - - ✓ - - ✓ diff --git a/source/includes/mongodb-compatibility-table-c.rst b/source/includes/mongodb-compatibility-table-c.rst deleted file mode 100644 index 48cac5922..000000000 --- a/source/includes/mongodb-compatibility-table-c.rst +++ /dev/null @@ -1,347 +0,0 @@ -.. sharedinclude:: dbx/compatibility-table-legend.rst - -.. list-table:: - :header-rows: 1 - :stub-columns: 1 - :class: compatibility-large - - * - C Driver Version - - MongoDB 7.0 - - MongoDB 6.0 - - MongoDB 5.0 - - MongoDB 4.4 - - MongoDB 4.2 - - MongoDB 4.0 - - MongoDB 3.6 - - MongoDB 3.4 - - MongoDB 3.2 - - MongoDB 3.0 - - MongoDB 2.6 - * - 1.26 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.25 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.24 - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.23 - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.22 - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.21 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - - - - - - - * - 1.20 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.19 - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.18 - - ⊛ - - ⊛ - - ✓ [#c-1.18-driver-support]_ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.17 - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.16 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.15 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.14 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.13 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.12 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.11 - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ⊛ - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.10 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - - * - 1.9 - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - - ✓ - * - 1.8 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - * - 1.7 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - * - 1.6 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - * - 1.5 - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - - ✓ - * - 1.4 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - * - 1.3 - - - - - - - - - - - - - - - - - - ✓ - - ✓ - - ✓ - * - 1.2 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - * - 1.1 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - * - 1.0 - - - - - - - - - - - - - - - - - - - - ✓ - - ✓ - -.. [#c-1.18-driver-support] The 1.18 driver does not support snapshot reads - on secondaries. For more information, see the - `MongoDB Server version 5.0 release notes `__. diff --git a/source/index.txt b/source/index.txt index ec1256ba8..682a7852c 100644 --- a/source/index.txt +++ b/source/index.txt @@ -26,7 +26,7 @@ security patches to them. .. card:: :headline: C - :url: /c/ + :url: https://www.mongodb.com/docs/languages/c/c-driver/current/ :icon: /icons/c.svg :icon-alt: C Driver icon @@ -154,7 +154,7 @@ with MongoDB: .. toctree:: - C Driver + C Driver C++ Driver .NET/C# Driver Go Driver diff --git a/source/php-drivers.txt b/source/php-drivers.txt index 01feb0741..5a645c9dd 100644 --- a/source/php-drivers.txt +++ b/source/php-drivers.txt @@ -37,7 +37,7 @@ The MongoDB PHP Driver consists of the following components: - The `extension `__, which provides a low-level API and mainly serves to integrate - :ref:`libmongoc and libbson ` with + `libmongoc and libbson `__ with PHP. - The `library `__, which @@ -109,8 +109,8 @@ provides the following functionality: - Command execution - Cursor management -To learn more about the system libraries, see the :ref:`C Driver -` documentation. +To learn more about the system libraries, see the `C Driver +`__ documentation. Connect to a Compatible MongoDB Deployment ------------------------------------------