Skip to content

Commit 26ee003

Browse files
committed
PLAT-928 -- Amend docs.
1 parent 0a3d65d commit 26ee003

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

docs/source/index.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -77,6 +77,20 @@ them by looking at the ``errors`` dict on the ``result``:
7777
}
7878
7979
80+
You can also tell the comparer to ignore parts of the database.
81+
82+
For example, to ignore the ``users`` table completely, and the ``line3`` column
83+
of the table ``addresses`` you would call ``compare`` like this:
84+
85+
.. code-block:: Python
86+
87+
>>> result = compare(
88+
uri_left,
89+
uri_right,
90+
ignores=['users', 'addresses.col.line3']
91+
)
92+
93+
8094
If you wish to persist that dict to a JSON file, you can quickly do so
8195
by calling ``result.dump_errors()``.
8296

@@ -91,6 +105,8 @@ Currently the library can detect the following differences:
91105
- Differences in **Foreign Keys** for a common table
92106
- Differences in **Indexes** for a common table
93107
- Differences in **Columns** for a common table
108+
- Ability to ignore a **whole table**
109+
- Ability to ignore **primary/foreign keys**, **indexes** and **columns**
94110

95111

96112
Installation

0 commit comments

Comments
 (0)