Struct Config 

pub struct Config {
    pub embedding_provider: EmbeddingProvider,
    pub embedding_dimension: EmbeddingDimension,
    pub default_collective: Option<CollectiveId>,
    pub cache_size_mb: usize,
    pub sync_mode: SyncMode,
    pub hnsw: HnswConfig,
    pub activity: ActivityConfig,
    pub watch: WatchConfig,
    pub read_only: bool,
}

Database configuration options.

All fields have sensible defaults. Use struct update syntax to override specific settings:

use pulsedb::Config;

let config = Config {
    cache_size_mb: 256,
    ..Default::default()
};

Fields

embedding_provider: EmbeddingProvider

How embeddings are generated or provided.

embedding_dimension: EmbeddingDimension

Embedding vector dimension (must match provider output).

default_collective: Option<CollectiveId>

Default collective for operations when none specified.

cache_size_mb: usize

Cache size in megabytes for the storage engine.

Higher values improve read performance but use more memory. Default: 64 MB

sync_mode: SyncMode

Durability mode for write operations.

hnsw: HnswConfig

HNSW vector index parameters.

Controls the quality and performance of semantic search. See HnswConfig for tuning guidelines.

activity: ActivityConfig

Agent activity tracking parameters.

Controls staleness detection for agent heartbeats. See ActivityConfig for details.

watch: WatchConfig

Watch system parameters.

Controls the in-process event notification channel. See WatchConfig for details.

read_only: bool

Read-only mode.

When true, all mutation methods (record_experience, store_relation, etc.) return PulseDBError::ReadOnly. Read operations work normally.

Use this for read-only consumers like PulseVision that open the same database file a writer is using.

Default: false

Implementations

impl Config

pub fn new() -> Self

Creates a new Config with default settings.

pub fn read_only() -> Self

Creates a Config for read-only access.

All mutation methods will return PulseDBError::ReadOnly. Use this for read-only consumers like visualization tools that open the same database file a writer is using.

Example

use pulsedb::Config;

let config = Config::read_only();
assert!(config.read_only);

pub fn with_builtin_embeddings() -> Self

Creates a Config for builtin embedding generation.

This requires the builtin-embeddings feature to be enabled.

Example

use pulsedb::Config;

let config = Config::with_builtin_embeddings();

pub fn with_external_embeddings(dimension: EmbeddingDimension) -> Self

Creates a Config for external embedding provider.

When using external embeddings, you must provide pre-computed embedding vectors when recording experiences.

Example

use pulsedb::{Config, EmbeddingDimension};

// OpenAI ada-002 uses 1536 dimensions
let config = Config::with_external_embeddings(EmbeddingDimension::Custom(1536));

pub fn validate(&self) -> Result<(), ValidationError>

Validates the configuration.

Called automatically by PulseDB::open(). You can also call this explicitly to check configuration before attempting to open.

Errors

Returns ValidationError if:

• cache_size_mb is 0
• Custom dimension is 0 or > 4096

pub fn dimension(&self) -> usize

Returns the embedding dimension as a numeric value.

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Config

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.