Repository navigation
docs: sync README and CHANGELOG with outcome, cancel, inspection, pause - #24
Merged
Merged
Conversation
README: house skeleton (nav, intro, Trade-offs, no emoji/rule), WithQueue, Job outcome and cancel, Job records and inspection, Queue pause, __sqliteq_ name ban, side tables + trigger + BEGIN IMMEDIATE in How It Works, Requires VarMQ >= v1.11.0, VarMQ casing, ack ID. CHANGELOG: PR numbers (#21, #22, #23), Breaking Changes heading, one point per line, sqliteq casing. example/README: sqliteq casing.
Drop cap per transaction, kept cancelled rows, contract import, trusted producers for the id field, Upgrading from v0.3, split CHANGELOG lines.
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
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.
Docs left stale by #21 (Reject), #22 (job outcome and cancel), #23 (inspection and durable pause). Docs only, no code change.
README
---, Installation folded into Quick Start, new Trade-offs. Storage and Configuration moved under Usage.worker.WithQueuereplaces deprecatedWithPersistentQueue.WatchOutcome,AcknowledgeResult,CancelJob,OnCancel,AcknowledgeCancelled, 50 ms poll, fixed retention), Job records and inspection, Queue pause.Rejectreason: stored as outcome error when job has a job ID (was "not stored").__sqliteq_ban. How It Works:<name>__sqliteq_jobs,<name>__sqliteq_cancelled,__sqliteq_readdtrigger,BEGIN IMMEDIATE, poll goroutine, retention trim.contractmodule in code), Requires VarMQ ≥ v1.11.0 + link to the VarMQ versions table; no workflow store, one-job read answers 501.CHANGELOG
### Breaking->### ⚠️ Breaking Changes(Unreleased and 0.3.0).example/README.mdprose. Example output block keeps "SQLiteQ Examples" to matchexample/main.go.Checks
go build ./...(examples incl.)grep "WithPersistentQueue\|message queue" README.mdemptyNote: VarMQ v1.11.0 not tagged yet (go.mod pins a v1.10.1 pseudo-version); line assumes the planned release.