HarperFast / HarperFast/documentation

`delete_audit_logs_before` example passes a `table` parameter that errors on the default (RocksDB) engine

Open Beginner friendly
#665 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
MDX
Stars
9
Forks
9
Avg merge
2d 12h
Merged PRs (30d)
32

Description

## What happens

`reference/database/transaction.md` documents `delete_audit_logs_before` with an example body that includes a `table` parameter:

```json
{
"operation": "delete_audit_logs_before",
"schema": "dev",
"table": "dog",
"timestamp": 1598290282817
}
```

On the **default** storage engine (RocksDB) that request errors. `dataLayer/harperBridge/ResourceBridge.ts` rejects a table-scoped audit/transaction-log deletion on RocksDB with a 400: all tables in a database share one transaction log, so the operation cannot be scoped to one table. A reader who copies the documented example gets a failure.

## What is already correct

The same section already carries a `v5.2.0` version badge stating that the operation is unsupported with `table` on RocksDB. So the warning landed; the example immediately below it was never updated to match. The fix is to drop the `table` line from the example body (and, if the surrounding prose implies table scoping, adjust that too), not to add a new warning.

## Verified

- `HarperFast/documentation` `origin/main` at `677ad213d` (2026-08-31) — badge present, example still shows `"table": "dog"`.
- `HarperFast/harper` `origin/main` — the RocksDB guard that makes the example fail is live and unchanged.

Searched the documentation tracker for `delete_audit_logs_before`, `table RocksDB transaction log`, and `audit log` across all states: no existing issue covers this.

*Found by exploratory QA (finding F-310); triaged 2026-09-02.*

Contributor guide

Open the contributing guide

Research direction

Open reference/database/transaction.md and read the delete_audit_logs_before section, including its v5.2.0 warning. Update the example to remove the table parameter and adjust nearby prose only if it implies table scoping. Done means the documented request matches the RocksDB behavior and no copied example fails for that reason.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
92/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.