adding new tplogutils module #78
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Author
|
Member
jonathonmcmurray
left a comment
jonathonmcmurray
left a comment
There was a problem hiding this comment.
please align all code to style guide at https://github.com/DataIntellectTech/kdbx-modules/blob/main/style.md
(e.g. comment style, naming conventions etc.)
jonathonmcmurray
requested changes
Jan 27, 2026
Member
There was a problem hiding this comment.
do these tests still pass? (I'm pretty sure they won't)
Member
There was a problem hiding this comment.
bumping this, have you re-run the tests? I'm fairly certain they will fail
Member
There was a problem hiding this comment.
bumping this, have you re-run the tests? I'm fairly certain they will fail
di/tplogutils/test.q
Outdated
| result:tplogsutils.repair[testfile]; | ||
|
|
||
| / assert | ||
| nameCorrect:result~goodfile; |
Member
There was a problem hiding this comment.
still some camelCase in here
di/tplogutils/tplogutils.md
Outdated
| |----------|-------------| | ||
| | `check[logfile;lastmsgtoreplay]` | Returns `logfile` if it should be used as-is per `check` logic, otherwise triggers `repair` and returns `<logfile>.good`. | | ||
| | `repair[logfile]` | Creates `<logfile>.good` and writes any recoverable messages into it. Returns the new filename. | | ||
| | `repairover[logfile;goodlogh;d]` | Internal chunk worker called repeatedly by `repair` (exported for testing/advanced use). | |
Member
There was a problem hiding this comment.
this is no longer exported
di/tplogutils/tplogutils.md
Outdated
Comment on lines
127
to
143
| ### `repairover` | ||
|
|
||
| ```q | ||
| tplogutils.repairover[logfile; goodlogh; d] | ||
| ``` | ||
|
|
||
| **Parameters** | ||
|
|
||
| | Parameter | Type | Description | | ||
| |----------:|------|-------------| | ||
| | `logfile` | symbol | Source logfile | | ||
| | `goodlogh` | int | Handle to the output `.good` logfile (opened via `hopen`) | | ||
| | `d` | dict | State dictionary with keys `start` and `size` (byte offset and chunk length) | | ||
|
|
||
| **Notes** | ||
| - `repair` calls `repairover` repeatedly using `over` and a `(start;size)` state dictionary. | ||
| - This is exported for transparency/testing; most users should call `check` or `repair`. |
di/tplogutils/tplogutils.md
Outdated
| The module exports: | ||
|
|
||
| ```q | ||
| export:([check;repair;repairover]) |
di/tplogutils/init.q
Outdated
Comment on lines
1
to
8
| / header to build deserialisable msg | ||
| header: 8 # -8!(`upd;`trade;()); | ||
| / first part of tp update msg | ||
| updmsg: `char$10 # 8 _ -8!(`upd;`trade;()); | ||
| / size of default chunk to read (10MB) | ||
| chunk: 10 * 1024 * 1024; | ||
| / don't let single read exceed this | ||
| maxchunk: 8 * chunk; |
Member
There was a problem hiding this comment.
Suggested change
| / header to build deserialisable msg | |
| header: 8 # -8!(`upd;`trade;()); | |
| / first part of tp update msg | |
| updmsg: `char$10 # 8 _ -8!(`upd;`trade;()); | |
| / size of default chunk to read (10MB) | |
| chunk: 10 * 1024 * 1024; | |
| / don't let single read exceed this | |
| maxchunk: 8 * chunk; | |
| / header to build deserialisable msg | |
| header:8#-8!(`upd;`trade;()); | |
| / first part of tp update msg | |
| updmsg:`char$10#8_-8!(`upd;`trade;()); | |
| / size of default chunk to read (10MB) | |
| chunk:10*1024*1024; | |
| / don't let single read exceed this | |
| maxchunk:8*chunk; |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Create module containing utils for recovering data from corrupt log files
Potential start point:
TorQ TP Log Utils Documentation
TorQ TP Log Utils Code
KDB-X Modules
Acceptance Criteria
Please create a separate directory for each package and place code, documentation and unit tests within. All packages must have documentation and unit tests to be accepted.Package: TP Log File Recovery · DataIntellectTech kdbx-modules · Discussion #20
Project Owner
Jonathon McMurray