Skip to content

SQLiteOptions

Jump to bottom
Brian Lehnen edited this page Apr 8, 2026 · 4 revisions

SQLite Options

NuGet package: DotNetWorkQueue.Transport.SQLite

Options class: SqLiteMessageQueueTransportOptions

Namespace: DotNetWorkQueue.Transport.SQLite.Basic

Time source

The SQLite transport uses the local machine's clock for all time-dependent operations (delayed processing, expiration, heartbeat). If consumers run on multiple machines, their clocks should be synchronized.

EnableWalMode

SQLite has an EnableWalMode option (default: true) that turns on WAL (Write-Ahead Logging) journal mode. In WAL mode, readers do not block the writer and the writer does not block readers, improving throughput.

This setting only applies to file-based databases. In-memory databases ignore it.

createQueue.Options.EnableWalMode = false;
Queue creation options

All feature flags below are set at queue creation time via the creation class and cannot be changed after the queue exists. See SQLiteQueueCreationOptions for usage examples.

Property Type Default Notes
EnablePriority bool false Adds a priority column
EnableStatus bool true Required when EnableHeartBeat is true
EnableHeartBeat bool true Enables dead message recovery
EnableDelayedProcessing bool false Required for retry delays
EnableStatusTable bool false Auto-set to true if AdditionalColumns are present
EnableRoute bool false Tag messages with a route string
EnableMessageExpiration bool false RPC queues force this to true
EnableWalMode bool true SQLite-specific. Ignored for in-memory databases
EnableHoldTransactionUntilMessageCommitted bool always false Present in the interface but permanently disabled. SQLite does not support this feature. The setter is a no-op.
EnableHistory bool false Creates a history table for message lifecycle tracking
QueueType QueueTypes Normal Normal, RpcSend, or RpcReceive
AdditionalColumns ColumnList empty Custom columns on the status or metadata table
AdditionalConstraints ConstraintList empty Custom indexes on user columns
AdditionalColumnsOnMetaData bool false If true, user columns go on the metadata table

When EnableHistory is true, the HistoryOptions property (type HistoryTransportOptions) controls retention:

Property Type Default
RetentionDays int 30
MaxExceptionLength int 4000
StoreBody bool false
TrackEnqueue bool true
TrackProcessing bool true
TrackComplete bool true
TrackError bool true
TrackDelete bool true
TrackExpire bool true
MonitorTime TimeSpan 1 day

See MessageHistory for details on history tracking behavior.

See SQLiteInMemoryDB for in-memory database usage.

For any issues please use the GitHub issues

  1. Introduction
  2. Usage
  3. Logging
  4. Admin
  5. Metrics
  6. Trace
  7. Monitoring
  8. Message Interception
  9. Dashboard
  10. Maintenance Mode
  11. Message History
  12. Transports
  13. Job Scheduler
  14. Migration Guide

Clone this wiki locally