PhoenixOptions class

Engine options applied when a database is opened.

Every field has an engine default. Options only take effect for the first handle that opens a file in a process: later opens of the same path join the running engine and share its options.

Constructors

PhoenixOptions({bool syncOnCommit = true, int cachePages = 0, int checkpointBytes = 0, bool tracing = false, double? fillFactor})
Creates engine options; every argument is optional.
const

Properties

cachePages → int
Page cache capacity in 4 KiB pages; 0 selects the engine default.
final
checkpointBytes → int
Write-ahead-log size, in bytes, that triggers an automatic checkpoint; 0 selects the engine default (4 MiB).
final
fillFactor → double?
How full a B+Tree leaf may get before it splits, in (0.5, 1.0]. Lower values leave room for in-place growth at the cost of space.
final
hashCode → int
The hash code for this object.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
syncOnCommit → bool
fsync the write-ahead log on every commit (the default).
final
tracing → bool
Record engine spans, readable with spans().
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Constants

fast → const PhoenixOptions
Options tuned for throughput over power-loss durability.