Skip to content

Commit e2592da

Browse files
authored
DOCSP-39286 document requirement for gcc 12+ (#17)
* DOCSP-39286 fixed some style issues and documented requirement for gcc 12
1 parent a634297 commit e2592da

File tree

2 files changed

+28
-9
lines changed

2 files changed

+28
-9
lines changed

source/faq.txt

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Frequently Asked Questions
2020
This page contains frequently asked questions and their answers.
2121

2222
Why Do I Get ``ModuleNotFoundError: No module named 'polars'`` When Using {+driver-short+}?
23-
---------------------------------------------------------------------------------------
23+
--------------------------------------------------------------------------------------------
2424

2525
{+driver-short+} raises this error when an application attempts to use a {+driver-short+} API
2626
that returns query result-sets as a ``polars.DataFrame`` instance without
@@ -32,3 +32,14 @@ following shell command:
3232
.. code-block:: sh
3333

3434
$ python -m pip install polars
35+
36+
Why Do I Get an ``undefined symbol`` Error When Installing {+driver-short+} from Source?
37+
----------------------------------------------------------------------------------------------------
38+
39+
{+driver-short+} raises this error when GCC version 12 or later is
40+
not installed in your Linux environment. If you experience this error,
41+
ensure that you have GCC version 12 or later installed.
42+
43+
To learn more about the requirements for
44+
installing {+driver-short+} from source, see :doc:`Installing and Upgrading
45+
<installation>`.

source/installation.txt

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -90,25 +90,33 @@ command:
9090
Install from Source
9191
~~~~~~~~~~~~~~~~~~~
9292

93-
If the above options still do not allow you to install ``pymongoarrow`` on your
93+
If you can't use the above options to install ``pymongoarrow`` on your
9494
system, you can install from source. To learn how, see the `Contributing Guide
9595
<https://github.com/mongodb-labs/mongo-arrow/blob/main/bindings/python/CONTRIBUTING.md#installing-from-source>`__.
9696

9797
Dependencies
9898
^^^^^^^^^^^^
9999

100-
{+driver-short+} requires the following:
100+
{+driver-short+} requires the following dependencies:
101101

102-
- PyMongo>=4.4
103-
- PyArrow>=16,<16.1
102+
- PyMongo version 4.4 or later
103+
- PyArrow version 16.0
104+
105+
Installing from source on Linux requires the following additional dependencies:
106+
107+
- GCC version 12 or later
108+
- CMake
109+
- pkg-config
104110

105111
To use {+driver-short+} with a PyMongo feature that requires an optional
106-
dependency, users must install PyMongo with the dependency manually.
112+
dependency, you must set the dependency as an option when you install PyMongo.
107113

108114
.. note::
109115

110-
PyMongo's optional dependencies are detailed
111-
`here <https://pymongo.readthedocs.io/en/stable/installation.html#dependencies>`__.
116+
To learn more about PyMongo's optional dependencies, see
117+
`Dependencies
118+
<https://pymongo.readthedocs.io/en/stable/installation.html#dependencies>`__
119+
in the PyMongo documentation.
112120

113121
For example, to use {+driver-short+} with Client-Side Field Level Encryption,
114122
you must install PyMongo with the ``encryption`` option in addition to installing
@@ -118,7 +126,7 @@ you must install PyMongo with the ``encryption`` option in addition to installin
118126

119127
$ python -m pip install 'pymongo[encryption]' pymongoarrow
120128

121-
Applications intending to use {+driver-short+} APIs that return query result-sets
129+
Applications using {+driver-short+} APIs that return query result-sets
122130
as ``pandas.DataFrame`` instances, such as ``~pymongoarrow.api.find_pandas_all()``,
123131
must also have ``pandas`` installed:
124132

0 commit comments

Comments
 (0)