Interface PerformanceConfig

Performance configuration options provided by users.

All fields are optional; unspecified fields use tier defaults.

Example: Override specific settings while using a tier

const db = await createDatabase({
  performance: {
    tier: 'balanced',
    cacheTtlMs: 30000,     // Override: longer cache
    trackMetrics: true,    // Override: enable metrics
  }
});
interface PerformanceConfig {
    tier?: PerformanceTier;
    cacheEnabled?: boolean;
    cacheTtlMs?: number;
    cacheMaxEntries?: number;
    batchWrites?: boolean;
    batchFlushIntervalMs?: number;
    batchMaxSize?: number;
    validateSql?: boolean;
    trackMetrics?: boolean;
    slowQueryThresholdMs?: number;
    retryOnError?: boolean;
    maxRetries?: number;
    retryDelayMs?: number;
}

Properties

tier? cacheEnabled? cacheTtlMs? cacheMaxEntries? batchWrites? batchFlushIntervalMs? batchMaxSize? validateSql? trackMetrics? slowQueryThresholdMs? retryOnError? maxRetries? retryDelayMs?

Properties

Optionaltier

tier?: PerformanceTier

Performance tier preset.

Default Value

'balanced'

OptionalcacheEnabled

cacheEnabled?: boolean

Enable query result caching.

When enabled, identical SELECT queries return cached results until the cache TTL expires or cache is invalidated.

Remarks

  • Caching is per-adapter instance (not shared)
  • Cache is invalidated on any write operation to affected tables
  • Use accurate tier for systems where stale data is unacceptable

Default Value

tier-dependent

OptionalcacheTtlMs

cacheTtlMs?: number

Cache time-to-live in milliseconds.

After this duration, cached query results are considered stale and will be re-fetched on next access.

Default Value

5000 for balanced tier

OptionalcacheMaxEntries

cacheMaxEntries?: number

Maximum number of cached query results.

When exceeded, least-recently-used entries are evicted.

Default Value

1000 for balanced tier

OptionalbatchWrites

batchWrites?: boolean

Enable write batching.

When enabled, write operations (INSERT, UPDATE, DELETE) are collected and executed in batches to reduce I/O operations.

Remarks

  • Recommended for mobile/browser environments
  • Not recommended for systems requiring immediate consistency
  • Batch is flushed on batchFlushIntervalMs or batchMaxSize

Default Value

false for balanced tier, true for efficient tier

OptionalbatchFlushIntervalMs

batchFlushIntervalMs?: number

Batch flush interval in milliseconds.

Accumulated writes are flushed after this interval.

Default Value

100 for balanced tier

OptionalbatchMaxSize

batchMaxSize?: number

Maximum batch size before auto-flush.

When batch reaches this size, it is immediately flushed regardless of the flush interval.

Default Value

50 for balanced tier

OptionalvalidateSql

validateSql?: boolean

Validate SQL statements before execution.

Performs basic syntax and injection checks.

Default Value

true for balanced tier

OptionaltrackMetrics

trackMetrics?: boolean

Track performance metrics.

When enabled, the adapter tracks:

  • Total queries/mutations/transactions
  • Average query duration
  • Error counts
  • Uptime

Retrieve metrics via adapter.getMetrics().

Default Value

true for balanced tier

OptionalslowQueryThresholdMs

slowQueryThresholdMs?: number

Slow query logging threshold in milliseconds.

Queries exceeding this duration are logged at warn level.

Default Value

100 for balanced tier

OptionalretryOnError

retryOnError?: boolean

Retry operations on transient errors.

Transient errors include network timeouts, connection resets, and deadlocks.

Default Value

true for balanced tier

OptionalmaxRetries

maxRetries?: number

Maximum retry attempts.

Default Value

3 for balanced tier

OptionalretryDelayMs

retryDelayMs?: number

Delay between retry attempts in milliseconds.

Uses exponential backoff: delay * 2^attempt.

Default Value

100 for balanced tier

Settings

Member Visibility

On This Page

Properties