deepdiff-rs 0.8.2__tar.gz → 0.9.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/Cargo.lock +4 -4
  2. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/Cargo.toml +1 -1
  3. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/PKG-INFO +13 -14
  4. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/README.md +12 -13
  5. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/error.rs +49 -0
  6. deepdiff_rs-0.9.0/crates/onix-arrow/src/json_rows.rs +141 -0
  7. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/lib.rs +2 -0
  8. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/row_diff.rs +20 -12
  9. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/table_diff.rs +97 -5
  10. deepdiff_rs-0.9.0/crates/onix-py/deepdiff_rs.pyi +204 -0
  11. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/arrow.rs +43 -41
  12. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/deepdiff.rs +6 -4
  13. deepdiff_rs-0.9.0/crates/onix-py/tests/test_stub_mypy.py +67 -0
  14. deepdiff_rs-0.9.0/crates/onix-py/tests/test_stub_signatures.py +144 -0
  15. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_table_diff.py +186 -40
  16. deepdiff_rs-0.9.0/crates/onix-py/tests/test_wheel_contents.py +50 -0
  17. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/pyproject.toml +12 -6
  18. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/Cargo.toml +0 -0
  19. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/examples/row_diff_rss.rs +0 -0
  20. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/examples/type_stack_cost.rs +0 -0
  21. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/options.rs +0 -0
  22. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-arrow/src/schema.rs +0 -0
  23. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/Cargo.toml +0 -0
  24. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/examples/stack_frame_cost.rs +0 -0
  25. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/datetime.rs +0 -0
  26. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/datetime_tests.rs +0 -0
  27. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/array.rs +0 -0
  28. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/dispatch.rs +0 -0
  29. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/mod.rs +0 -0
  30. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/object.rs +0 -0
  31. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/options.rs +0 -0
  32. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/scalar.rs +0 -0
  33. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/set.rs +0 -0
  34. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/diff/tests.rs +0 -0
  35. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/error.rs +0 -0
  36. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/distance.rs +0 -0
  37. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/fxhash.rs +0 -0
  38. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/hash.rs +0 -0
  39. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/memo.rs +0 -0
  40. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/mod.rs +0 -0
  41. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/pairing.rs +0 -0
  42. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/ignore_order/tests.rs +0 -0
  43. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/lcs.rs +0 -0
  44. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/lcs_tests.rs +0 -0
  45. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/lib.rs +0 -0
  46. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/path.rs +0 -0
  47. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/report.rs +0 -0
  48. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/report_tests.rs +0 -0
  49. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/test_support.rs +0 -0
  50. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/unified_diff.rs +0 -0
  51. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/unified_diff_tests.rs +0 -0
  52. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/value.rs +0 -0
  53. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/src/value_tests.rs +0 -0
  54. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/tests/golden.rs +0 -0
  55. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/tests/ignore_order_memory.rs +0 -0
  56. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/tests/memory_footprint.rs +0 -0
  57. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/tests/proptest_diff.rs +0 -0
  58. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-core/tests/proptest_ignore_order.rs +0 -0
  59. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/.python-version +0 -0
  60. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/Cargo.toml +0 -0
  61. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/benchmarks/bench_bindings.py +0 -0
  62. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/convert.rs +0 -0
  63. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/errors.rs +0 -0
  64. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/fast_path.rs +0 -0
  65. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/guard.rs +0 -0
  66. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/src/lib.rs +0 -0
  67. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/conftest.py +0 -0
  68. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_bindings_memory.py +0 -0
  69. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_conversions.py +0 -0
  70. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_datetimes.py +0 -0
  71. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_depth_guard.py +0 -0
  72. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_differential_fuzz.py +0 -0
  73. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_golden_parity.py +0 -0
  74. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_sets.py +0 -0
  75. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_signed_zero.py +0 -0
  76. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_smoke.py +0 -0
  77. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_suite_hygiene.py +0 -0
  78. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_table_row_diff.py +0 -0
  79. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_timedeltas.py +0 -0
  80. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_times.py +0 -0
  81. {deepdiff_rs-0.8.2 → deepdiff_rs-0.9.0}/crates/onix-py/tests/test_tuples.py +0 -0
@@ -629,7 +629,7 @@ checksum = "9f7c3e4beb33f85d45ae3e3a1792185706c8e16d043238c593331cc7cd313b50"
629
629
 
630
630
  [[package]]
631
631
  name = "onix-arrow"
632
- version = "0.8.2"
632
+ version = "0.9.0"
633
633
  dependencies = [
634
634
  "arrow-array",
635
635
  "arrow-buffer",
@@ -646,7 +646,7 @@ dependencies = [
646
646
 
647
647
  [[package]]
648
648
  name = "onix-cli"
649
- version = "0.8.2"
649
+ version = "0.9.0"
650
650
  dependencies = [
651
651
  "onix-core",
652
652
  "serde_json",
@@ -654,7 +654,7 @@ dependencies = [
654
654
 
655
655
  [[package]]
656
656
  name = "onix-core"
657
- version = "0.8.2"
657
+ version = "0.9.0"
658
658
  dependencies = [
659
659
  "proptest",
660
660
  "serde",
@@ -665,7 +665,7 @@ dependencies = [
665
665
 
666
666
  [[package]]
667
667
  name = "onix-py"
668
- version = "0.8.2"
668
+ version = "0.9.0"
669
669
  dependencies = [
670
670
  "arrow-array",
671
671
  "arrow-ipc",
@@ -3,7 +3,7 @@ resolver = "3"
3
3
  members = ["crates/onix-core", "crates/onix-py", "crates/onix-arrow"]
4
4
 
5
5
  [workspace.package]
6
- version = "0.8.2"
6
+ version = "0.9.0"
7
7
  edition = "2024"
8
8
  license = "MIT"
9
9
 
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: deepdiff-rs
3
- Version: 0.8.2
3
+ Version: 0.9.0
4
4
  Classifier: Programming Language :: Python :: 3
5
5
  Classifier: Programming Language :: Rust
6
6
  Classifier: License :: OSI Approved :: MIT License
@@ -56,7 +56,7 @@ From source:
56
56
  ```sh
57
57
  cd crates/onix-py
58
58
  uv tool install maturin # the build tool (skip if already installed)
59
- uv sync --group test # creates .venv, installs pytest, pinned deepdiff, and pyarrow/polars/duckdb for the table-diff tests
59
+ uv sync --group test # creates .venv, installs pytest, pinned deepdiff, and pyarrow/polars/duckdb/pandas for the table-diff tests
60
60
  uv run --group test maturin develop --release
61
61
  ```
62
62
 
@@ -118,15 +118,15 @@ Pass `--ignore-order` to compare every list by value instead of by position, mir
118
118
 
119
119
  `diff_tables` compares two tables the way `DeepDiff` compares two objects. It takes any object implementing the [Arrow PyCapsule interface](https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html) — a pyarrow `Table` or `RecordBatch`, a polars `DataFrame`, a DuckDB relation — and imports it with no Python round trip. The two tables are matched on a required, non-empty set of key columns (the table's primary key).
120
120
 
121
- It reports the **schema** diff (which columns were added, removed, or changed type), the keyed **row** diff (which rows were added, removed, or changed, and which keys are duplicated), and the per-cell diff (`cells_changed`): one row per changed cell of a changed row, carrying the key columns, the `column`, its `old_value`/`new_value` in a canonical string rendering (a decimal at its native scale and a string verbatim, both matching DuckDB; a timestamp as its UTC instant, keeping its zone when aware; a cross-variant interval with its variant appended; a duration as ISO 8601 `PT<seconds>S`, never through the Arrow formatter (which can emit a `<invalid>` sentinel); numbers of differing width at the wider type, so an `f32` `0.1` shows as `0.10000000149011612` against an `f64` `0.1` — the exact rules are in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs)), and a `change`: `became_null`/`became_non_null` for a one-sided null, `type_changed` when the two types are not losslessly comparable (different value kinds, an aware-versus-naive timestamp, or a cross-variant interval), otherwise `value_changed` — a lossless type difference (integer or float widening, a time/duration unit change, a decimal scale change) is `value_changed` only when the value truly differs, never merely for the type. Its rows are ordered by the canonical string rendering of the key columns (so numeric keys sort as strings — `10` before `2` — nulls first), then left-schema column order. Rows are matched by the key columns; `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` return Arrow tables, and `summary()` counts each outcome.
121
+ It reports the **schema** diff (which columns were added, removed, or changed type), the keyed **row** diff (which rows were added, removed, or changed, and which keys are duplicated), and the per-cell diff (`cells_changed`): one row per changed cell, carrying the key columns, `column`, `old_value`/`new_value`, and `change` (`became_null`/`became_non_null`, `type_changed`, or `value_changed`), ordered by the canonical string rendering of the key columns (nulls first), then left-schema column order — the exact rendering and change-classification rules are in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs). Rows are matched by the key columns; `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` return Arrow tables, and `summary()` counts each outcome.
122
122
 
123
123
  ```python
124
124
  import pyarrow as pa
125
125
  from deepdiff_rs import diff_tables
126
126
 
127
127
  left = pa.table({
128
- "id": pa.array([1, 2, 3], pa.int64()),
129
- "amount": pa.array([10, 20, 30], pa.int32()),
128
+ "id": pa.array([1, 2, 3, 9, 9], pa.int64()), # 9 is a duplicate key
129
+ "amount": pa.array([10, 20, 30, 90, 91], pa.int32()),
130
130
  })
131
131
  right = pa.table({
132
132
  "id": pa.array([2, 3, 4], pa.int64()),
@@ -135,22 +135,20 @@ right = pa.table({
135
135
  })
136
136
 
137
137
  diff = diff_tables(left, right, key=["id"])
138
- print(diff.summary())
139
- print("added ids:", pa.table(diff.rows_added()).column("id").to_pylist())
140
- print("cells changed:", pa.table(diff.cells_changed()).to_pylist())
138
+ print(diff.summary(), "added ids:", pa.table(diff.rows_added()).column("id").to_pylist(), "removed ids:", pa.table(diff.rows_removed()).column("id").to_pylist())
139
+ print("cells changed:", pa.table(diff.cells_changed()).to_pylist(), "duplicate keys:", pa.table(diff.duplicate_keys()).to_pylist())
141
140
  ```
142
141
 
143
142
  ```
144
- {'columns_added': 1, 'columns_removed': 0, 'columns_type_changed': 1, 'rows_added': 1, 'rows_removed': 1, 'rows_changed': 1, 'duplicate_keys': 0, 'null_keys': 0, 'cells_changed': 1}
145
- added ids: [4]
146
- cells changed: [{'id': 3, 'column': 'amount', 'old_value': '30', 'new_value': '31', 'change': 'value_changed'}]
143
+ {'columns_added': 1, 'columns_removed': 0, 'columns_type_changed': 1, 'rows_added': 1, 'rows_removed': 1, 'rows_changed': 1, 'duplicate_keys': 1, 'null_keys': 0, 'cells_changed': 1} added ids: [4] removed ids: [1]
144
+ cells changed: [{'id': 3, 'column': 'amount', 'old_value': '30', 'new_value': '31', 'change': 'value_changed'}] duplicate keys: [{'id': 9, 'left_count': 2, 'right_count': 0}]
147
145
  ```
148
146
 
149
147
  A key appearing more than once on either side is reported in `duplicate_keys` (with `left_count` and `right_count`) and excluded from the added/removed/changed sets; a null key matches its counterpart and is counted in `null_keys`. Rows are compared by the non-key columns present on *both* sides, with onix's value semantics (integers and integral floats fold together, all NaNs compare equal, `1.00` equals `1.0000`, a timestamp compares by its instant and a time or duration by its value across units, dictionary-encoded values equal their plain form, and null equals null); a nested non-key column is out of scope and is skipped rather than compared. The exact value-comparison rules are documented on the hashing functions in [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs).
150
148
 
151
- Type comparison uses the full logical Arrow type (timestamp unit and timezone, decimal precision and scale, and so on), but physical encodings that carry the same logical type compare equal — a dictionary-encoded string equals a plain string, polars' `Utf8View` equals pyarrow's `Utf8`, the list variants normalize together, and a map compares equal however a library spells it — so the same table read through pyarrow, polars, or DuckDB reports no spurious type changes. The full normalization rules are documented on `normalized_type` (and `map_entries`) in [`crates/onix-arrow/src/schema.rs`](crates/onix-arrow/src/schema.rs); nullability is ignored but reported in each record. Column names must be unique on each side; a repeated name raises `ValueError`. `diff.schema_arrow` is the same result as an Arrow table: it implements `__arrow_c_stream__`, so `polars.DataFrame(diff.schema_arrow)` and `pandas` consume it directly, and `diff.schema_arrow.to_pyarrow()` returns a `pyarrow.Table`.
149
+ Type comparison uses the full logical Arrow type (timestamp unit and timezone, decimal precision and scale, and so on), but physical encodings that carry the same logical type compare equal — a dictionary-encoded string equals a plain string, polars' `Utf8View` equals pyarrow's `Utf8`, the list variants normalize together, and a map compares equal however a library spells it — so the same table read through pyarrow, polars, or DuckDB reports no spurious type changes. The full normalization rules are documented on `normalized_type` (and `map_entries`) in [`crates/onix-arrow/src/schema.rs`](crates/onix-arrow/src/schema.rs); nullability is ignored but reported in each record. Column names must be unique on each side; a repeated name raises `ValueError`. `diff.schema_arrow` is the same result as an Arrow table: it implements `__arrow_c_stream__`, so `polars.DataFrame(diff.schema_arrow)` consumes it with no pyarrow needed, and `diff.schema_arrow.to_pyarrow()` returns a `pyarrow.Table`; `pandas.api.interchange.from_dataframe(diff.schema_arrow)` also works, but pandas' own implementation of that protocol needs pyarrow installed regardless of which path you take.
152
150
 
153
- `pyarrow` is optional: install it with `pip install deepdiff-rs[arrow]`. It is needed only for `to_pyarrow()` and for passing pyarrow objects in — importing `deepdiff_rs` and diffing polars or DuckDB tables need it not at all. Passing an object that implements neither Arrow protocol raises `TypeError`; calling `to_pyarrow()` without pyarrow installed raises `ImportError` naming the extra.
151
+ `pyarrow` is optional: install it with `pip install deepdiff-rs[arrow]`. It is needed only for `to_pyarrow()` and for passing pyarrow objects in — importing `deepdiff_rs` and diffing polars or DuckDB tables need it not at all. Passing an object that implements neither Arrow protocol raises `TypeError`; calling `to_pyarrow()` without pyarrow installed raises `ImportError` naming the extra. `diff.to_json()` gives the whole diff — schema, summary, and `rows_added`/`rows_removed`/`cells_changed`/`duplicate_keys` in full, one JSON object per row — as a single string with no pyarrow, polars, or pandas needed at all; see [Known limitations](#known-limitations) for its row cap.
154
152
 
155
153
  ## Performance
156
154
 
@@ -206,7 +204,7 @@ Both reports carry their full methodology, fairness rules, and the reproduce com
206
204
  - `DeepDiff(t1, t2, ignore_order=False, max_depth=None)`: diffs two live Python objects of supported value types — `None`, `bool`, `int`, `float`, `str`, `dict`, `list`, `tuple`, `set`, `frozenset`, `datetime.datetime`, `datetime.date`, `datetime.time`, and `datetime.timedelta` (see [Known limitations](#known-limitations) for the exact restrictions and exclusions, including which types a `dict` key may be); `.to_json()` returns the DeepDiff-compatible JSON string, `.to_dict()` the same report as a dict — with Python types preserved, so a value the diff found in a `tuple`, `set` or `frozenset` comes back as one and a `datetime`/`date`/`time`/`timedelta` comes back as a real one of those — and the instance is falsy when there is no difference. The `set_item_added`/`set_item_removed` categories are lists of path strings, each ending in the item itself (`root['a'][2]`, `root['x']`, `root[(1, 2)]`).
207
205
  - `diff_json(a, b, ignore_order=False, max_depth=None) -> str`: diffs two JSON strings entirely in Rust and returns the report as a JSON string.
208
206
  - `MaxDepthError` (a `ValueError` subclass) is raised when input exceeds `max_depth`; `MAX_DEPTH_CEILING` (20,000) is the hard upper bound on `max_depth`.
209
- - `diff_tables(left, right, key=[...]) -> TableDiff`: diffs two Arrow tables (see [Diffing tables](#diffing-tables)). `TableDiff.schema` is the list of changed columns, `.schema_arrow` the same as an Arrow table, `.summary()` the schema and row change counts, `.to_json()` the schema diff as JSON; `.rows_added()`, `.rows_removed()`, `.cells_changed()`, and `.duplicate_keys()` return Arrow tables.
207
+ - `diff_tables(left, right, key=[...]) -> TableDiff`: diffs two Arrow tables (see [Diffing tables](#diffing-tables)). `TableDiff.schema` is the list of changed columns, `.schema_arrow` the same as an Arrow table, `.summary()` the schema and row change counts, `.to_json()` the full diff (schema, summary, and every row-level member, capped at 10,000 embedded rows); `.rows_added()`, `.rows_removed()`, `.cells_changed()`, and `.duplicate_keys()` return Arrow tables.
210
208
 
211
209
  **CLI.** `onix diff <a.json> <b.json> [--max-depth N] [--ignore-order] [--timing]` reads both files as JSON and prints a compact, single-line DeepDiff-compatible report to stdout (`{}` when there is no difference).
212
210
 
@@ -252,6 +250,7 @@ perf/ # cross-language benchmark harness and RESULTS.md
252
250
  - In `diff_tables`, DuckDB labels a `TIMESTAMP WITH TIME ZONE` column with the connection's *session* time zone when it exports to Arrow (a UTC session as `Timestamp(µs, "UTC")`, an `America/New_York` session as `Timestamp(µs, "America/New_York")`), so on a non-UTC machine such a column can be reported as a type change against a UTC column from another library. Run `SET TimeZone='UTC'` on the DuckDB connection first for a deterministic, machine-independent result.
253
251
  - `diff_tables` refuses a column whose Arrow type is nested deeper than `MAX_NESTING_DEPTH` (128) with a `MaxDepthError`, because comparing arbitrarily deep nesting would overflow the native stack; 128 is far beyond any real schema. Importing a schema nested many thousands of levels deep is also slow regardless, a cost of the Arrow C Data Interface itself.
254
252
  - `diff_tables`'s row diff costs, per call: RAM for a 32-byte hash per row per side (sorted), so peak memory is linear in row count (about 75 MB at 1M rows/side, 660 MB at 10M) and time is `N·log N` (about 2 s for a 10M-row pair), plus a second term for the duplicate-key report, which holds the key values of every *distinct duplicated* key — an all-duplicate 200k-rows/side table (100k distinct duplicated keys) peaks at about 37 MB with 16-byte keys and 1.05 GB with 1 KB keys, 1M rows/side (500k distinct) at about 165 MB with 16-byte keys; a third term for the per-cell diff, which re-reads both inputs, holds the changed rows of both sides, and renders every changed cell to a string held once in the output — so its cost is the number of changed cells times the cell width, not the changed-row count alone (every value is rendered in full). Measured, same method: with two narrow `int64` columns, 85 MB at 1M rows/side with 2% changed and 629 MB with every row changed; with a 1 KB `string` cell changed on every row, 1.18 GB at 100k rows/side and 2.34 GB at 200k (about 11.6 KB per changed row, linear, so on the order of 11.6 GB at 1M). Then temp disk, because each input is re-read several times and so is spooled to an anonymous file (`tempfile`: unlinked at once, mode 0600, no predictable name — nothing is left on disk even on abnormal exit), both spools resident at once, peaking at the decoded size of both inputs (about 315 MB — 161 + 154 MB uncompressed Arrow IPC — for the 1M-row fixture pair; on the order of 10 GB for the full 5 GB-per-side fixture pair, which on Linux may be a RAM-backed `tmpfs`), a full temp filesystem raising `ValueError` naming `TMPDIR`. None of these has a built-in cap: for untrusted input, bound the row count, the changed fraction, and the column widths (key columns for duplicate-heavy data, changed cells — rendered in full — for wide value columns). Figures are the peak resident set of `cargo run -p onix-arrow --release --example row_diff_rss`, single run, macOS on an Apple M-series laptop, 2026-09-05, same method as [Performance](#performance). See [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs).
253
+ - `TableDiff.to_json()` is the one member with a built-in cap: it embeds `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` in full, one JSON object per row, so it refuses with `ValueError` — naming the row count and the cap — once those four together hold more than 10,000 rows. The cap bounds row count only, the same way the row-diff cost bullet above states its per-cell term as changed cells times cell width, not column count or cell width — so a table under the row cap but with wide or large cells can still be large; use the Arrow-returning accessors instead. See [`crates/onix-arrow/src/json_rows.rs`](crates/onix-arrow/src/json_rows.rs).
255
254
  - `diff_tables` compares scalar columns by value (hashed: null, booleans, every integer, float and decimal width, strings and binary in every encoding, timestamps, dates, times, durations, intervals, and dictionaries of these; refused with `ValueError`: run-end encoded columns and any type-and-unit combination Arrow itself cannot build; nested non-key columns skipped, nested key columns refused), with the exact enumeration in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs). It also refuses a key column whose type differs across the two inputs after encoding normalization (the conservative choice: a primary key that changed type is refused rather than guessed, not coerced). A row whose only difference is a lossless type change — an `Int32` widened to `Int64`, a timestamp unit change at the same instant — hashes equal on both sides, so it is in neither `rows_changed` nor `cells_changed`; the column's type change is still reported in `schema`.
256
255
  - Output is byte-identical to DeepDiff except for the cases listed above and two path-rendering quirks; [`tests/golden/README.md`](tests/golden/README.md) enumerates every accepted exception, including integers past `2^53` (the limit of exact `f64` representation) inside ordered scalar lists and `ignore_order` pairing among naive datetimes, which DeepDiff ranks using the *process's local timezone* while onix reads a naive value as UTC everywhere.
257
256
 
@@ -38,7 +38,7 @@ From source:
38
38
  ```sh
39
39
  cd crates/onix-py
40
40
  uv tool install maturin # the build tool (skip if already installed)
41
- uv sync --group test # creates .venv, installs pytest, pinned deepdiff, and pyarrow/polars/duckdb for the table-diff tests
41
+ uv sync --group test # creates .venv, installs pytest, pinned deepdiff, and pyarrow/polars/duckdb/pandas for the table-diff tests
42
42
  uv run --group test maturin develop --release
43
43
  ```
44
44
 
@@ -100,15 +100,15 @@ Pass `--ignore-order` to compare every list by value instead of by position, mir
100
100
 
101
101
  `diff_tables` compares two tables the way `DeepDiff` compares two objects. It takes any object implementing the [Arrow PyCapsule interface](https://arrow.apache.org/docs/format/CDataInterface/PyCapsuleInterface.html) — a pyarrow `Table` or `RecordBatch`, a polars `DataFrame`, a DuckDB relation — and imports it with no Python round trip. The two tables are matched on a required, non-empty set of key columns (the table's primary key).
102
102
 
103
- It reports the **schema** diff (which columns were added, removed, or changed type), the keyed **row** diff (which rows were added, removed, or changed, and which keys are duplicated), and the per-cell diff (`cells_changed`): one row per changed cell of a changed row, carrying the key columns, the `column`, its `old_value`/`new_value` in a canonical string rendering (a decimal at its native scale and a string verbatim, both matching DuckDB; a timestamp as its UTC instant, keeping its zone when aware; a cross-variant interval with its variant appended; a duration as ISO 8601 `PT<seconds>S`, never through the Arrow formatter (which can emit a `<invalid>` sentinel); numbers of differing width at the wider type, so an `f32` `0.1` shows as `0.10000000149011612` against an `f64` `0.1` — the exact rules are in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs)), and a `change`: `became_null`/`became_non_null` for a one-sided null, `type_changed` when the two types are not losslessly comparable (different value kinds, an aware-versus-naive timestamp, or a cross-variant interval), otherwise `value_changed` — a lossless type difference (integer or float widening, a time/duration unit change, a decimal scale change) is `value_changed` only when the value truly differs, never merely for the type. Its rows are ordered by the canonical string rendering of the key columns (so numeric keys sort as strings — `10` before `2` — nulls first), then left-schema column order. Rows are matched by the key columns; `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` return Arrow tables, and `summary()` counts each outcome.
103
+ It reports the **schema** diff (which columns were added, removed, or changed type), the keyed **row** diff (which rows were added, removed, or changed, and which keys are duplicated), and the per-cell diff (`cells_changed`): one row per changed cell, carrying the key columns, `column`, `old_value`/`new_value`, and `change` (`became_null`/`became_non_null`, `type_changed`, or `value_changed`), ordered by the canonical string rendering of the key columns (nulls first), then left-schema column order — the exact rendering and change-classification rules are in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs). Rows are matched by the key columns; `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` return Arrow tables, and `summary()` counts each outcome.
104
104
 
105
105
  ```python
106
106
  import pyarrow as pa
107
107
  from deepdiff_rs import diff_tables
108
108
 
109
109
  left = pa.table({
110
- "id": pa.array([1, 2, 3], pa.int64()),
111
- "amount": pa.array([10, 20, 30], pa.int32()),
110
+ "id": pa.array([1, 2, 3, 9, 9], pa.int64()), # 9 is a duplicate key
111
+ "amount": pa.array([10, 20, 30, 90, 91], pa.int32()),
112
112
  })
113
113
  right = pa.table({
114
114
  "id": pa.array([2, 3, 4], pa.int64()),
@@ -117,22 +117,20 @@ right = pa.table({
117
117
  })
118
118
 
119
119
  diff = diff_tables(left, right, key=["id"])
120
- print(diff.summary())
121
- print("added ids:", pa.table(diff.rows_added()).column("id").to_pylist())
122
- print("cells changed:", pa.table(diff.cells_changed()).to_pylist())
120
+ print(diff.summary(), "added ids:", pa.table(diff.rows_added()).column("id").to_pylist(), "removed ids:", pa.table(diff.rows_removed()).column("id").to_pylist())
121
+ print("cells changed:", pa.table(diff.cells_changed()).to_pylist(), "duplicate keys:", pa.table(diff.duplicate_keys()).to_pylist())
123
122
  ```
124
123
 
125
124
  ```
126
- {'columns_added': 1, 'columns_removed': 0, 'columns_type_changed': 1, 'rows_added': 1, 'rows_removed': 1, 'rows_changed': 1, 'duplicate_keys': 0, 'null_keys': 0, 'cells_changed': 1}
127
- added ids: [4]
128
- cells changed: [{'id': 3, 'column': 'amount', 'old_value': '30', 'new_value': '31', 'change': 'value_changed'}]
125
+ {'columns_added': 1, 'columns_removed': 0, 'columns_type_changed': 1, 'rows_added': 1, 'rows_removed': 1, 'rows_changed': 1, 'duplicate_keys': 1, 'null_keys': 0, 'cells_changed': 1} added ids: [4] removed ids: [1]
126
+ cells changed: [{'id': 3, 'column': 'amount', 'old_value': '30', 'new_value': '31', 'change': 'value_changed'}] duplicate keys: [{'id': 9, 'left_count': 2, 'right_count': 0}]
129
127
  ```
130
128
 
131
129
  A key appearing more than once on either side is reported in `duplicate_keys` (with `left_count` and `right_count`) and excluded from the added/removed/changed sets; a null key matches its counterpart and is counted in `null_keys`. Rows are compared by the non-key columns present on *both* sides, with onix's value semantics (integers and integral floats fold together, all NaNs compare equal, `1.00` equals `1.0000`, a timestamp compares by its instant and a time or duration by its value across units, dictionary-encoded values equal their plain form, and null equals null); a nested non-key column is out of scope and is skipped rather than compared. The exact value-comparison rules are documented on the hashing functions in [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs).
132
130
 
133
- Type comparison uses the full logical Arrow type (timestamp unit and timezone, decimal precision and scale, and so on), but physical encodings that carry the same logical type compare equal — a dictionary-encoded string equals a plain string, polars' `Utf8View` equals pyarrow's `Utf8`, the list variants normalize together, and a map compares equal however a library spells it — so the same table read through pyarrow, polars, or DuckDB reports no spurious type changes. The full normalization rules are documented on `normalized_type` (and `map_entries`) in [`crates/onix-arrow/src/schema.rs`](crates/onix-arrow/src/schema.rs); nullability is ignored but reported in each record. Column names must be unique on each side; a repeated name raises `ValueError`. `diff.schema_arrow` is the same result as an Arrow table: it implements `__arrow_c_stream__`, so `polars.DataFrame(diff.schema_arrow)` and `pandas` consume it directly, and `diff.schema_arrow.to_pyarrow()` returns a `pyarrow.Table`.
131
+ Type comparison uses the full logical Arrow type (timestamp unit and timezone, decimal precision and scale, and so on), but physical encodings that carry the same logical type compare equal — a dictionary-encoded string equals a plain string, polars' `Utf8View` equals pyarrow's `Utf8`, the list variants normalize together, and a map compares equal however a library spells it — so the same table read through pyarrow, polars, or DuckDB reports no spurious type changes. The full normalization rules are documented on `normalized_type` (and `map_entries`) in [`crates/onix-arrow/src/schema.rs`](crates/onix-arrow/src/schema.rs); nullability is ignored but reported in each record. Column names must be unique on each side; a repeated name raises `ValueError`. `diff.schema_arrow` is the same result as an Arrow table: it implements `__arrow_c_stream__`, so `polars.DataFrame(diff.schema_arrow)` consumes it with no pyarrow needed, and `diff.schema_arrow.to_pyarrow()` returns a `pyarrow.Table`; `pandas.api.interchange.from_dataframe(diff.schema_arrow)` also works, but pandas' own implementation of that protocol needs pyarrow installed regardless of which path you take.
134
132
 
135
- `pyarrow` is optional: install it with `pip install deepdiff-rs[arrow]`. It is needed only for `to_pyarrow()` and for passing pyarrow objects in — importing `deepdiff_rs` and diffing polars or DuckDB tables need it not at all. Passing an object that implements neither Arrow protocol raises `TypeError`; calling `to_pyarrow()` without pyarrow installed raises `ImportError` naming the extra.
133
+ `pyarrow` is optional: install it with `pip install deepdiff-rs[arrow]`. It is needed only for `to_pyarrow()` and for passing pyarrow objects in — importing `deepdiff_rs` and diffing polars or DuckDB tables need it not at all. Passing an object that implements neither Arrow protocol raises `TypeError`; calling `to_pyarrow()` without pyarrow installed raises `ImportError` naming the extra. `diff.to_json()` gives the whole diff — schema, summary, and `rows_added`/`rows_removed`/`cells_changed`/`duplicate_keys` in full, one JSON object per row — as a single string with no pyarrow, polars, or pandas needed at all; see [Known limitations](#known-limitations) for its row cap.
136
134
 
137
135
  ## Performance
138
136
 
@@ -188,7 +186,7 @@ Both reports carry their full methodology, fairness rules, and the reproduce com
188
186
  - `DeepDiff(t1, t2, ignore_order=False, max_depth=None)`: diffs two live Python objects of supported value types — `None`, `bool`, `int`, `float`, `str`, `dict`, `list`, `tuple`, `set`, `frozenset`, `datetime.datetime`, `datetime.date`, `datetime.time`, and `datetime.timedelta` (see [Known limitations](#known-limitations) for the exact restrictions and exclusions, including which types a `dict` key may be); `.to_json()` returns the DeepDiff-compatible JSON string, `.to_dict()` the same report as a dict — with Python types preserved, so a value the diff found in a `tuple`, `set` or `frozenset` comes back as one and a `datetime`/`date`/`time`/`timedelta` comes back as a real one of those — and the instance is falsy when there is no difference. The `set_item_added`/`set_item_removed` categories are lists of path strings, each ending in the item itself (`root['a'][2]`, `root['x']`, `root[(1, 2)]`).
189
187
  - `diff_json(a, b, ignore_order=False, max_depth=None) -> str`: diffs two JSON strings entirely in Rust and returns the report as a JSON string.
190
188
  - `MaxDepthError` (a `ValueError` subclass) is raised when input exceeds `max_depth`; `MAX_DEPTH_CEILING` (20,000) is the hard upper bound on `max_depth`.
191
- - `diff_tables(left, right, key=[...]) -> TableDiff`: diffs two Arrow tables (see [Diffing tables](#diffing-tables)). `TableDiff.schema` is the list of changed columns, `.schema_arrow` the same as an Arrow table, `.summary()` the schema and row change counts, `.to_json()` the schema diff as JSON; `.rows_added()`, `.rows_removed()`, `.cells_changed()`, and `.duplicate_keys()` return Arrow tables.
189
+ - `diff_tables(left, right, key=[...]) -> TableDiff`: diffs two Arrow tables (see [Diffing tables](#diffing-tables)). `TableDiff.schema` is the list of changed columns, `.schema_arrow` the same as an Arrow table, `.summary()` the schema and row change counts, `.to_json()` the full diff (schema, summary, and every row-level member, capped at 10,000 embedded rows); `.rows_added()`, `.rows_removed()`, `.cells_changed()`, and `.duplicate_keys()` return Arrow tables.
192
190
 
193
191
  **CLI.** `onix diff <a.json> <b.json> [--max-depth N] [--ignore-order] [--timing]` reads both files as JSON and prints a compact, single-line DeepDiff-compatible report to stdout (`{}` when there is no difference).
194
192
 
@@ -234,6 +232,7 @@ perf/ # cross-language benchmark harness and RESULTS.md
234
232
  - In `diff_tables`, DuckDB labels a `TIMESTAMP WITH TIME ZONE` column with the connection's *session* time zone when it exports to Arrow (a UTC session as `Timestamp(µs, "UTC")`, an `America/New_York` session as `Timestamp(µs, "America/New_York")`), so on a non-UTC machine such a column can be reported as a type change against a UTC column from another library. Run `SET TimeZone='UTC'` on the DuckDB connection first for a deterministic, machine-independent result.
235
233
  - `diff_tables` refuses a column whose Arrow type is nested deeper than `MAX_NESTING_DEPTH` (128) with a `MaxDepthError`, because comparing arbitrarily deep nesting would overflow the native stack; 128 is far beyond any real schema. Importing a schema nested many thousands of levels deep is also slow regardless, a cost of the Arrow C Data Interface itself.
236
234
  - `diff_tables`'s row diff costs, per call: RAM for a 32-byte hash per row per side (sorted), so peak memory is linear in row count (about 75 MB at 1M rows/side, 660 MB at 10M) and time is `N·log N` (about 2 s for a 10M-row pair), plus a second term for the duplicate-key report, which holds the key values of every *distinct duplicated* key — an all-duplicate 200k-rows/side table (100k distinct duplicated keys) peaks at about 37 MB with 16-byte keys and 1.05 GB with 1 KB keys, 1M rows/side (500k distinct) at about 165 MB with 16-byte keys; a third term for the per-cell diff, which re-reads both inputs, holds the changed rows of both sides, and renders every changed cell to a string held once in the output — so its cost is the number of changed cells times the cell width, not the changed-row count alone (every value is rendered in full). Measured, same method: with two narrow `int64` columns, 85 MB at 1M rows/side with 2% changed and 629 MB with every row changed; with a 1 KB `string` cell changed on every row, 1.18 GB at 100k rows/side and 2.34 GB at 200k (about 11.6 KB per changed row, linear, so on the order of 11.6 GB at 1M). Then temp disk, because each input is re-read several times and so is spooled to an anonymous file (`tempfile`: unlinked at once, mode 0600, no predictable name — nothing is left on disk even on abnormal exit), both spools resident at once, peaking at the decoded size of both inputs (about 315 MB — 161 + 154 MB uncompressed Arrow IPC — for the 1M-row fixture pair; on the order of 10 GB for the full 5 GB-per-side fixture pair, which on Linux may be a RAM-backed `tmpfs`), a full temp filesystem raising `ValueError` naming `TMPDIR`. None of these has a built-in cap: for untrusted input, bound the row count, the changed fraction, and the column widths (key columns for duplicate-heavy data, changed cells — rendered in full — for wide value columns). Figures are the peak resident set of `cargo run -p onix-arrow --release --example row_diff_rss`, single run, macOS on an Apple M-series laptop, 2026-09-05, same method as [Performance](#performance). See [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs).
235
+ - `TableDiff.to_json()` is the one member with a built-in cap: it embeds `rows_added`, `rows_removed`, `cells_changed`, and `duplicate_keys` in full, one JSON object per row, so it refuses with `ValueError` — naming the row count and the cap — once those four together hold more than 10,000 rows. The cap bounds row count only, the same way the row-diff cost bullet above states its per-cell term as changed cells times cell width, not column count or cell width — so a table under the row cap but with wide or large cells can still be large; use the Arrow-returning accessors instead. See [`crates/onix-arrow/src/json_rows.rs`](crates/onix-arrow/src/json_rows.rs).
237
236
  - `diff_tables` compares scalar columns by value (hashed: null, booleans, every integer, float and decimal width, strings and binary in every encoding, timestamps, dates, times, durations, intervals, and dictionaries of these; refused with `ValueError`: run-end encoded columns and any type-and-unit combination Arrow itself cannot build; nested non-key columns skipped, nested key columns refused), with the exact enumeration in the module doc of [`crates/onix-arrow/src/row_diff.rs`](crates/onix-arrow/src/row_diff.rs). It also refuses a key column whose type differs across the two inputs after encoding normalization (the conservative choice: a primary key that changed type is refused rather than guessed, not coerced). A row whose only difference is a lossless type change — an `Int32` widened to `Int64`, a timestamp unit change at the same instant — hashes equal on both sides, so it is in neither `rows_changed` nor `cells_changed`; the column's type change is still reported in `schema`.
238
237
  - Output is byte-identical to DeepDiff except for the cases listed above and two path-rendering quirks; [`tests/golden/README.md`](tests/golden/README.md) enumerates every accepted exception, including integers past `2^53` (the limit of exact `f64` representation) inside ordered scalar lists and `ignore_order` pairing among naive datetimes, which DeepDiff ranks using the *process's local timezone* while onix reads a naive value as UTC everywhere.
239
238
 
@@ -121,6 +121,25 @@ pub enum TableDiffError {
121
121
  /// The column whose two renderings were equal.
122
122
  column: String,
123
123
  },
124
+ /// [`crate::TableDiff::to_json`] would embed more row objects than
125
+ /// [`crate::MAX_JSON_ROWS`] allows (see its own doc for what that caps
126
+ /// and why). Use the Arrow-returning members instead, or export the
127
+ /// batches directly, for a diff this large.
128
+ TooManyJsonRows {
129
+ /// The number of row objects `to_json()` would have embedded.
130
+ rows: usize,
131
+ /// The cap that was exceeded.
132
+ max: usize,
133
+ },
134
+ /// [`crate::TableDiff::to_json`]'s `serde_json` serialization failed.
135
+ /// Its input is a fixed set of already-rendered strings, numbers, and
136
+ /// nested objects/arrays, so this does not happen in practice; it is a
137
+ /// typed error rather than a panic because a public API must return,
138
+ /// not abort, on an unexpected failure.
139
+ Json {
140
+ /// The underlying `serde_json` error's message.
141
+ message: String,
142
+ },
124
143
  }
125
144
 
126
145
  impl fmt::Display for TableDiffError {
@@ -170,6 +189,15 @@ impl fmt::Display for TableDiffError {
170
189
  "internal invariant: a value change in column {column:?} rendered identically \
171
190
  on both sides, which the common-form rendering is designed to prevent"
172
191
  ),
192
+ TableDiffError::TooManyJsonRows { rows, max } => write!(
193
+ f,
194
+ "to_json() would embed {rows} row objects, more than the {max}-row cap; use \
195
+ the Arrow-returning members (rows_added(), rows_removed(), cells_changed(), \
196
+ duplicate_keys()) or export the batches directly for a diff this large"
197
+ ),
198
+ TableDiffError::Json { message } => {
199
+ write!(f, "failed to serialize the table diff to JSON: {message}")
200
+ }
173
201
  }
174
202
  }
175
203
  }
@@ -278,6 +306,27 @@ mod tests {
278
306
  assert!(message.contains("changed-row count"));
279
307
  }
280
308
 
309
+ #[test]
310
+ fn too_many_json_rows_message_names_count_and_cap() {
311
+ let error = TableDiffError::TooManyJsonRows {
312
+ rows: 20_000,
313
+ max: 10_000,
314
+ };
315
+ let message = error.to_string();
316
+ assert!(message.contains("20000"));
317
+ assert!(message.contains("10000-row cap"));
318
+ assert!(message.contains("rows_added()"));
319
+ }
320
+
321
+ #[test]
322
+ fn json_message_names_the_underlying_error() {
323
+ let error = TableDiffError::Json {
324
+ message: "unexpected end of input".to_string(),
325
+ };
326
+ let message = error.to_string();
327
+ assert!(message.contains("unexpected end of input"));
328
+ }
329
+
281
330
  #[test]
282
331
  fn error_implements_std_error() {
283
332
  let error = TableDiffError::EmptyKey;
@@ -0,0 +1,141 @@
1
+ //! Renders an Arrow [`RecordBatch`] to a JSON array of row objects, for
2
+ //! [`crate::TableDiff::to_json`]. Reuses [`crate::row_diff::SideRenderer`],
3
+ //! the same renderer [`crate::TableDiff::cells_changed`]'s `old_value`/
4
+ //! `new_value` use, so no cell renders two different ways in the crate.
5
+ //!
6
+ //! [`MAX_JSON_ROWS`] bounds the row count: the JSON holds one object per row
7
+ //! and one owned string per non-null cell, so memory is proportional to
8
+ //! rows × columns × cell width, uncapped past that row count otherwise. A
9
+ //! batch over the cap is refused with [`crate::TableDiffError::TooManyJsonRows`].
10
+
11
+ use arrow_array::RecordBatch;
12
+ use arrow_cast::display::FormatOptions;
13
+ use serde_json::{Map, Value as JsonValue};
14
+
15
+ use crate::error::TableDiffError;
16
+ use crate::row_diff::{SideRenderer, cell_is_null};
17
+
18
+ /// The maximum number of row objects this module will render for one
19
+ /// [`RecordBatch`]; see the module doc for what this bounds.
20
+ pub const MAX_JSON_ROWS: usize = 10_000;
21
+
22
+ /// Renders every row of `batch` to a JSON object keyed by column name, or
23
+ /// [`TableDiffError::TooManyJsonRows`] if `batch` has more than
24
+ /// [`MAX_JSON_ROWS`] rows. A null cell renders as JSON `null`; every other
25
+ /// cell renders through [`SideRenderer`], the same renderer
26
+ /// [`crate::TableDiff::cells_changed`] uses.
27
+ ///
28
+ /// # Errors
29
+ ///
30
+ /// - [`TableDiffError::TooManyJsonRows`] if `batch.num_rows()` exceeds
31
+ /// [`MAX_JSON_ROWS`].
32
+ /// - [`TableDiffError::Render`] if a cell cannot be rendered to its
33
+ /// canonical string (naming the column), the same failure
34
+ /// [`crate::TableDiff::cells_changed`] can raise.
35
+ pub(crate) fn rows_to_json(batch: &RecordBatch) -> Result<Vec<JsonValue>, TableDiffError> {
36
+ if batch.num_rows() > MAX_JSON_ROWS {
37
+ return Err(TableDiffError::TooManyJsonRows {
38
+ rows: batch.num_rows(),
39
+ max: MAX_JSON_ROWS,
40
+ });
41
+ }
42
+
43
+ let format_options = FormatOptions::default();
44
+ let schema = batch.schema();
45
+ let columns = schema
46
+ .fields()
47
+ .iter()
48
+ .zip(batch.columns())
49
+ .map(|(field, array)| {
50
+ SideRenderer::new(array, &format_options)
51
+ .map(|renderer| (field.name(), array, renderer))
52
+ })
53
+ .collect::<Result<Vec<_>, _>>()?;
54
+
55
+ let mut rows = Vec::with_capacity(batch.num_rows());
56
+ for row in 0..batch.num_rows() {
57
+ let mut object = Map::with_capacity(columns.len());
58
+ for (name, array, renderer) in &columns {
59
+ let value = if cell_is_null(array, row) {
60
+ JsonValue::Null
61
+ } else {
62
+ JsonValue::String(renderer.render(row, name)?)
63
+ };
64
+ object.insert((*name).clone(), value);
65
+ }
66
+ rows.push(JsonValue::Object(object));
67
+ }
68
+
69
+ Ok(rows)
70
+ }
71
+
72
+ #[cfg(test)]
73
+ mod tests {
74
+ use std::sync::Arc;
75
+
76
+ use arrow_array::{Int64Array, RecordBatch, StringArray};
77
+ use arrow_schema::{DataType, Field, Schema};
78
+
79
+ use super::{MAX_JSON_ROWS, rows_to_json};
80
+ use crate::error::TableDiffError;
81
+
82
+ fn batch(rows: usize) -> RecordBatch {
83
+ let schema = Arc::new(Schema::new(vec![
84
+ Field::new("id", DataType::Int64, false),
85
+ Field::new("name", DataType::Utf8, true),
86
+ ]));
87
+ let ids: Vec<i64> = (0..rows).map(|i| i64::try_from(i).unwrap()).collect();
88
+ let names: Vec<Option<String>> = (0..rows)
89
+ .map(|i| {
90
+ if i % 2 == 0 {
91
+ None
92
+ } else {
93
+ Some(format!("n{i}"))
94
+ }
95
+ })
96
+ .collect();
97
+ RecordBatch::try_new(
98
+ schema,
99
+ vec![
100
+ Arc::new(Int64Array::from(ids)),
101
+ Arc::new(StringArray::from(names)),
102
+ ],
103
+ )
104
+ .unwrap()
105
+ }
106
+
107
+ #[test]
108
+ fn renders_one_object_per_row_with_column_keys() {
109
+ let rows = rows_to_json(&batch(2)).unwrap();
110
+ assert_eq!(rows.len(), 2);
111
+ assert_eq!(rows[0]["id"], serde_json::json!("0"));
112
+ assert_eq!(rows[0]["name"], serde_json::Value::Null);
113
+ assert_eq!(rows[1]["id"], serde_json::json!("1"));
114
+ assert_eq!(rows[1]["name"], serde_json::json!("n1"));
115
+ }
116
+
117
+ #[test]
118
+ fn empty_batch_renders_no_rows() {
119
+ assert_eq!(
120
+ rows_to_json(&batch(0)).unwrap(),
121
+ Vec::<serde_json::Value>::new()
122
+ );
123
+ }
124
+
125
+ #[test]
126
+ fn batch_over_the_cap_is_refused() {
127
+ let error = rows_to_json(&batch(MAX_JSON_ROWS + 1)).unwrap_err();
128
+ assert_eq!(
129
+ error,
130
+ TableDiffError::TooManyJsonRows {
131
+ rows: MAX_JSON_ROWS + 1,
132
+ max: MAX_JSON_ROWS,
133
+ }
134
+ );
135
+ }
136
+
137
+ #[test]
138
+ fn batch_at_the_cap_is_accepted() {
139
+ assert!(rows_to_json(&batch(MAX_JSON_ROWS)).is_ok());
140
+ }
141
+ }
@@ -102,12 +102,14 @@
102
102
  //! ```
103
103
 
104
104
  mod error;
105
+ mod json_rows;
105
106
  mod options;
106
107
  mod row_diff;
107
108
  mod schema;
108
109
  mod table_diff;
109
110
 
110
111
  pub use error::{Side, TableDiffError};
112
+ pub use json_rows::MAX_JSON_ROWS;
111
113
  pub use options::TableDiffOptions;
112
114
  pub use row_diff::{MemoryInput, TableInput};
113
115
  pub use schema::{ChangeKind, SchemaChange, diff_schemas};
@@ -66,11 +66,13 @@
66
66
  //!
67
67
  //! # Per-cell changes
68
68
  //!
69
- //! [`diff_cells`] reports, for every changed row, which cells differ. A cell is
70
- //! reported changed **if and only if its [`hash_cell`] contribution differs**
71
- //! between the two matched rows — the same helper the row hash is built from, so
72
- //! the cell list and the row-changed decision can never drift. Each reported
73
- //! cell is labelled:
69
+ //! [`diff_cells`] reports, for every changed row, which cells differ, as one
70
+ //! output row per differing cell: the key columns, then `column`, `old_value`,
71
+ //! `new_value`, and `change` (see [`diff_cells`] for the exact output order).
72
+ //! A cell is reported changed **if and only if its [`hash_cell`] contribution
73
+ //! differs** between the two matched rows — the same helper the row hash is
74
+ //! built from, so the cell list and the row-changed decision can never drift.
75
+ //! Each reported cell is labelled:
74
76
  //!
75
77
  //! - `became_null`/`became_non_null` when exactly one side is null;
76
78
  //! - `type_changed` when both are non-null and the two sides' types are not
@@ -93,11 +95,14 @@
93
95
  //! `0.10000000149011612` against an `f64` `0.1`), a timestamp renders as its UTC
94
96
  //! instant with its zone appended when aware (so an aware and a naive timestamp
95
97
  //! of the same instant differ), a decimal renders at its native scale, a string
96
- //! verbatim (decimals and strings match the `DuckDB` oracle), and a duration
98
+ //! verbatim (decimals and strings match the `DuckDB` oracle), a duration
97
99
  //! renders as an ISO 8601 `PT<seconds>S` string computed from its value — never
98
100
  //! through the Arrow formatter, whose second/millisecond duration formatter can
99
- //! emit a `<invalid>` sentinel while still succeeding. As a construction guard,
100
- //! a `value_changed` record whose two renderings are nonetheless equal is a
101
+ //! emit a `<invalid>` sentinel while still succeeding — and a cross-variant
102
+ //! interval renders with its variant appended, so two variants whose human
103
+ //! form would otherwise coincide stay distinct (see [`prepare_render`]). As a
104
+ //! construction guard, a `value_changed` record whose two renderings are
105
+ //! nonetheless equal is a
101
106
  //! [`TableDiffError::EqualRenderings`], not a silent row. There is no typed
102
107
  //! old/new
103
108
  //! column: a long-format table mixes every compared column's type in one column,
@@ -1287,7 +1292,7 @@ fn value_domain(data_type: &DataType) -> ValueDomain {
1287
1292
  /// diff both use. A `Null`-typed column is all-null by definition and carries no
1288
1293
  /// validity buffer, so it is detected by type; every other column defers to its
1289
1294
  /// validity bitmap.
1290
- fn cell_is_null(array: &ArrayRef, row: usize) -> bool {
1295
+ pub(crate) fn cell_is_null(array: &ArrayRef, row: usize) -> bool {
1291
1296
  matches!(array.data_type(), DataType::Null) || array.is_null(row)
1292
1297
  }
1293
1298
 
@@ -1351,13 +1356,16 @@ fn render_duration(raw: i64, unit: TimeUnit) -> String {
1351
1356
  /// One side's cell renderer: the Arrow formatter for most types, or a
1352
1357
  /// dependency-free [`render_duration`] for a `Duration` column (which the
1353
1358
  /// formatter can render as a `<invalid>` sentinel).
1354
- enum SideRenderer<'a> {
1359
+ pub(crate) enum SideRenderer<'a> {
1355
1360
  Formatter(ArrayFormatter<'a>),
1356
1361
  Duration(&'a ArrayRef, TimeUnit),
1357
1362
  }
1358
1363
 
1359
1364
  impl<'a> SideRenderer<'a> {
1360
- fn new(array: &'a ArrayRef, opts: &'a FormatOptions<'a>) -> Result<Self, TableDiffError> {
1365
+ pub(crate) fn new(
1366
+ array: &'a ArrayRef,
1367
+ opts: &'a FormatOptions<'a>,
1368
+ ) -> Result<Self, TableDiffError> {
1361
1369
  if let DataType::Duration(unit) = array.data_type() {
1362
1370
  Ok(SideRenderer::Duration(array, *unit))
1363
1371
  } else {
@@ -1366,7 +1374,7 @@ impl<'a> SideRenderer<'a> {
1366
1374
  }
1367
1375
  }
1368
1376
 
1369
- fn render(&self, row: usize, column: &str) -> Result<String, TableDiffError> {
1377
+ pub(crate) fn render(&self, row: usize, column: &str) -> Result<String, TableDiffError> {
1370
1378
  match self {
1371
1379
  SideRenderer::Formatter(formatter) => render_value(formatter, row, column),
1372
1380
  SideRenderer::Duration(array, unit) => {