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

Commit 545db75

Browse files
authored
Add structure/outline for various db examples
1 parent 63fe65e commit 545db75

File tree

1 file changed

+19
-13
lines changed

1 file changed

+19
-13
lines changed

README.md

Lines changed: 19 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -97,18 +97,13 @@ You can also install several drivers at once:
9797

9898
```pip install 'data-diff[mysql,postgresql,snowflake]'```
9999

100-
_<sup>*</sup> Some drivers have dependencies that cannot be installed using `pip` and still need to be installed manually._
101-
102-
103-
### Using PostgreSQL? Install Psycopg2
104-
105-
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).
106-
An easy solution is to install [psycopg2-binary](https://www.psycopg.org/docs/install.html#quick-install) by running:
100+
If you're using PostgreSQL, you'll need to install `psycopg2`. If you run into issues with `psycopg2` [dependencies](https://www.psycopg.org/docs/install.html#build-prerequisites), an easy solution is to install [psycopg2-binary](https://www.psycopg.org/docs/install.html#quick-install) by running:
107101

108102
```pip install psycopg2-binary```
109103

110-
`psycopg2-binary` comes with a pre-compiled binary and does not require additonal prerequisites. However, note that for production use, it is advised to use `psycopg2`.
104+
Note that for production use, it is advised to use `psycopg2`.
111105

106+
_<sup>*</sup> Some drivers have dependencies that cannot be installed using `pip` and still need to be installed manually._
112107

113108
# How to use
114109

@@ -264,9 +259,15 @@ Run `help(diff_tables)` or [read the docs](https://data-diff.readthedocs.io/en/l
264259

265260
## Example Commands and Outputs
266261

267-
### PostgreSQL
262+
For each of the 💚 implemented and thoroughly tested 💚 databases, we'll provide examples of `data-diff` input code and outputs on various data structures and sizes.
268263

269-
Two examples are provided below: one on a massive data set with missing row, and another on a smaller data set with several conflicting values.
264+
### Snowflake
265+
266+
#### Massive Data Set with Missing Row
267+
268+
#### Smaller Data Set with Several Conflicting Values
269+
270+
### PostgreSQL
270271

271272
#### Massive Data Set with Missing Row
272273

@@ -317,9 +318,9 @@ $ data-diff \
317318
#### Smaller Data Set with Conflicting Values
318319

319320
In this example, we use the CLI to compare a smaller data set with one missing row (`where actor_id = 4`) as well as several conflicting values:
320-
- `Ed` misspelled as `Edd` `where actor_id = 3` (or is `Edd` misspelled as `Ed`? Hard to say!)
321-
- Conflicting `last_update` values `where actor_id = 3` and `where actor_id = 2'
322-
- Conflicting spellings of the `first_name` `Penelope`/`Penelop` `where actor_id = 1`
321+
- `Ed` is misspelled as `Edd`. (Or is `Edd` misspelled as `Ed`? Hard to say!)
322+
- `Ed`/`Edd` and `Nick` have conflicting `last_update` values.
323+
- There's one more conlicting `first_name` spelling: `Penelope` vs `Penelop`.
323324

324325
```
325326
$ data-diff \
@@ -336,6 +337,11 @@ In this example, we use the CLI to compare a smaller data set with one missing r
336337
- 4, 2013-05-26 14:47:57.620000, Jennifer, Davis
337338
```
338339

340+
### MySQL
341+
342+
#### Massive Data Set with Missing Row
343+
344+
#### Smaller Data Set with Conflicting Values
339345

340346
# Technical Explanation
341347

0 commit comments

Comments
 (0)