Skip to content

SqliteClient

9 exports Added in v1.0.0 Source

Constructor

make

Added in v1.0.0 Source

Signature

declare function make(options: SqliteClientConfig): Effect<SqliteClient, never, any>;

Layers

layer

Added in v1.0.0 Source

Signature

declare function layer(config: SqliteClientConfig): Layer<any, ConfigError>;

layerConfig

Added in v1.0.0 Source

Signature

declare function layerConfig(config: Wrap<SqliteClientConfig>): Layer<any, ConfigError>;

Models

BackupMetadata interface

Added in v1.0.0 Source

Signature

interface BackupMetadata {
  readonly remainingPages: number;
  readonly totalPages: number;
}

SqliteClient interface

Added in v1.0.0 Source

Signature

interface SqliteClient extends unknown {
  readonly [TypeId]: typeof TypeId;
  readonly backup: (destination: string) => Effect<BackupMetadata, SqlError>;
  readonly config: SqliteClientConfig;
  readonly export: Effect<Uint8Array<ArrayBufferLike>, SqlError>;
  readonly loadExtension: (path: string) => Effect<void, SqlError>;
  readonly updateValues: never;
}

SqliteClientConfig interface

Added in v1.0.0 Source

Signature

interface SqliteClientConfig {
  readonly disableWAL?: boolean;
  readonly filename: string;
  readonly prepareCacheSize?: number;
  readonly prepareCacheTTL?: any;
  readonly readonly?: boolean;
  readonly spanAttributes?: Record<string, unknown>;
  readonly transformQueryNames?: (str: string) => string;
  readonly transformResultNames?: (str: string) => string;
}

Tags

SqliteClient

Added in v1.0.0 Source

Signature

declare const SqliteClient: any;

Type Ids

TypeId

Added in v1.0.0 Source

Signature

declare const TypeId: unique symbol;

TypeId type

Added in v1.0.0 Source

Signature

type TypeId = typeof TypeId;