Skip to content
This repository was archived by the owner on May 17, 2024. It is now read-only.

Commit 20f29eb

Browse files
authored
Merge pull request #206 from datafold/chiel-update-readme-psycopg2
Add extra documentation on installing drivers for postgresql
2 parents 38c56cf + afdea60 commit 20f29eb

File tree

1 file changed

+14
-1
lines changed

1 file changed

+14
-1
lines changed

README.md

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -157,7 +157,7 @@ Requires Python 3.7+ with pip.
157157

158158
To connect to a database, we need to have its driver installed, in the form of a Python library.
159159

160-
While you may install them manually, we offer an easy way to install them along with data-diff:
160+
While you may install them manually, we offer an easy way to install them along with data-diff<sup>*</sup>:
161161

162162
- `pip install 'data-diff[mysql]'`
163163

@@ -178,6 +178,19 @@ Users can also install several drivers at once:
178178

179179
```pip install 'data-diff[mysql,postgresql,snowflake]'```
180180

181+
_<sup>*</sup> Some drivers have dependencies that cannot be installed using `pip` and still need to be installed manually._
182+
183+
184+
### Install Psycopg2
185+
186+
In order to run Postgresql, you'll need `psycopg2`. This Python package requires some additional dependencies described in their [documentation](https://www.psycopg.org/docs/install.html#build-prerequisites).
187+
An easy solution is to install [psycopg2-binary](https://www.psycopg.org/docs/install.html#quick-install) by running:
188+
189+
```pip install psycopg2-binary```
190+
191+
Which comes with a pre-compiled binary and does not require additonal prerequisites. However, note that for production use it is adviced to use `psycopg2`.
192+
193+
181194
# How to use
182195

183196
## How to use from the command-line

0 commit comments

Comments
 (0)