HivePersistenceConfig class

Hive-specific persistence configuration.

Implemented types

Constructors

HivePersistenceConfig({required String storagePath, required String commitLogPath, required String accessLogPath, required String notificationStoragePath, String? backendMarkerPath, bool enableAccessLog = true, bool enableNotificationKeystore = true, bool enableCommitLog = true})
HivePersistenceConfig.clientDefaults({required String storagePath, String? backendMarkerPath})
Convenience constructor for at_client_sdk-shaped consumers: opts in to the keystore only. The keystore is created commit-log-free — clients no longer rely on a commit log — so the .unused_* paths below are never opened.
factory
HivePersistenceConfig.serverDefaults({required String storagePath, required String commitLogPath, required String accessLogPath, required String notificationStoragePath, String? backendMarkerPath})
Convenience constructor for atSecondary servers: opts into all optional capabilities (access log, notification keystore).
factory

Properties

accessLogPath → String
Where the access log lives. Only consulted when enableAccessLog is true.
final
backend → AtPersistenceBackendId
The backend this config is for. Must match the AtPersistenceFactory.backendId you pass it to.
no setteroverride
backendMarkerPath → String
Where the marker file lives. A future backend-aware factory will use this to detect backend changes between restarts; the current implementation doesn't read it, it's declared here so the field is part of the contract from day one.
final
commitLogPath → String
Where the commit log lives.
final
enableAccessLog → bool
Whether the access log should be initialised. Server-only — clients leave this false and never read the access log.
final
enableCommitLog → bool
Whether the keystore should be initialised with a commit log. Server bundles set this true (every write appends to the commit log for sync). Clients that no longer rely on a commit log leave it false, in which case the keystore is created commit-log-free and commitLogPath is never consulted.
final
enableNotificationKeystore → bool
Whether the notification keystore should be initialised as persistence. Server-only — clients leave this false and handle notifications via the at_lookup connection instead.
final
hashCode → int
The hash code for this object.
no setterinherited
notificationStoragePath → String
Where the notification keystore lives. Only consulted when enableNotificationKeystore is true.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
storagePath → String
Where the keystore data lives.
final

Methods

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

Operators

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