Skip to content

Commit 7e26a35

Browse files
author
Tim
committed
docs: fix stale and inaccurate README claims
Five corrections found in an audit against the live schema and tree: * dolt_history_users example used WHERE rowid_val = 42, but the vtable's columns are the user table's PK and columns (no rowid_val); fix to WHERE id = 42. * dolt_conflicts shows column "table" (not "table_name") and dolt_conflicts_users columns are (from_root_ish, base_<col>..., our_<col>..., our_diff_type, their_<col>..., their_diff_type, dolt_conflict_id), not the generic base_rowid/our_rowid/their_value triple the README invented. Update the example and the resolution DELETE to use dolt_conflict_id. * Sysbench: 31 workloads, not 23 (test/sysbench_compare.sh has 31 make_test() entries). * Doltlite shell tests: 60+ suites, not 40 (the test/doltlite_*.sh file count is 68). * doltlite_parity.sh: 119 tests, not 110. Doc-only; no code change.
1 parent 688262e commit 7e26a35

1 file changed

Lines changed: 13 additions & 10 deletions

File tree

README.md

Lines changed: 13 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -343,7 +343,7 @@ Two per-table virtual tables for time travel:
343343

344344
```sql
345345
-- Every version of every row across all commits
346-
SELECT * FROM dolt_history_users WHERE rowid_val = 42;
346+
SELECT * FROM dolt_history_users WHERE id = 42;
347347

348348
-- The table as it existed at a specific commit / branch / tag
349349
SELECT * FROM dolt_at_users('abc123...');
@@ -494,15 +494,18 @@ View and resolve merge conflicts:
494494
```sql
495495
-- View which tables have conflicts (summary)
496496
SELECT * FROM dolt_conflicts;
497-
-- table_name | num_conflicts
498-
-- users | 2
499-
500-
-- View individual conflict rows for a table
497+
-- table | num_conflicts
498+
-- users | 2
499+
500+
-- View individual conflict rows for a table. Columns are
501+
-- (from_root_ish, base_<col>..., our_<col>..., our_diff_type,
502+
-- their_<col>..., their_diff_type, dolt_conflict_id) — one base/our/their
503+
-- triple per user column, plus per-side diff_type and a stable
504+
-- dolt_conflict_id for resolution.
501505
SELECT * FROM dolt_conflicts_users;
502-
-- base_rowid | base_value | our_rowid | our_value | their_rowid | their_value
503506

504507
-- Resolve individual conflicts by deleting them (keeps current working value)
505-
DELETE FROM dolt_conflicts_users WHERE base_rowid = 5;
508+
DELETE FROM dolt_conflicts_users WHERE dolt_conflict_id = 5;
506509

507510
-- Or resolve all conflicts for a table at once
508511
SELECT dolt_conflicts_resolve('--ours', 'users'); -- keep our values
@@ -819,7 +822,7 @@ Doltlite is a drop-in replacement for SQLite, so the natural question is: what
819822
does version control cost?
820823

821824
Every PR runs a [sysbench-style benchmark](test/sysbench_compare.sh) comparing
822-
doltlite against stock SQLite on 23 OLTP workloads, with a 2× ceiling enforced
825+
doltlite against stock SQLite on 31 OLTP workloads, with a 2× ceiling enforced
823826
by CI. The per-release numbers (reads + writes table) are published with each
824827
release on the [GitHub releases page](https://github.com/dolthub/doltlite/releases).
825828
Run `test/sysbench_compare.sh` to reproduce locally.
@@ -845,15 +848,15 @@ invocation).
845848

846849
### Doltlite Shell Tests
847850

848-
40 test suites covering all features:
851+
60+ test suites covering all features:
849852

850853
```bash
851854
# Run all suites
852855
cd build
853856
bash ../test/run_doltlite_tests.sh
854857

855858
# Run individual suites
856-
bash ../test/doltlite_parity.sh # SQLite compatibility (110 tests)
859+
bash ../test/doltlite_parity.sh # SQLite compatibility (119 tests)
857860
bash ../test/doltlite_commit.sh # Commits and log
858861
bash ../test/doltlite_staging.sh # Add, status, staging
859862
bash ../test/doltlite_branch.sh # Branching and checkout

0 commit comments

Comments
 (0)