Skip to main content Link Search Menu Expand Document (external link)

SqliteClient overview

Added in v1.0.0


Table of contents


constructor

make

Signature

export declare const make: (options: SqliteClientConfig) => Effect.Effect<SqliteClient, never, Scope.Scope>

Added in v1.0.0

fiber refs

asyncQuery

Signature

export declare const asyncQuery: FiberRef.FiberRef<boolean>

Added in v1.0.0

withAsyncQuery

Signature

export declare const withAsyncQuery: <R, E, A>(effect: Effect.Effect<A, E, R>) => any

Added in v1.0.0

layers

layer

Signature

export declare const layer: (
  config: Config.Config.Wrap<SqliteClientConfig>
) => Layer.Layer<SqliteClient | Client.SqlClient, ConfigError>

Added in v1.0.0

models

SqliteClient (interface)

Signature

export interface SqliteClient extends Client.SqlClient {
  readonly [TypeId]: TypeId
  readonly config: SqliteClientConfig
  readonly reactive: <A>(
    statement: Statement.Statement<A>,
    fireOn: ReadonlyArray<{
      readonly table: string
      readonly ids?: ReadonlyArray<number>
    }>
  ) => Stream.Stream<ReadonlyArray<A>, SqlError>

  /** Not supported in sqlite */
  readonly updateValues: never
}

Added in v1.0.0

SqliteClientConfig (interface)

Signature

export interface SqliteClientConfig {
  readonly filename: string
  readonly location?: string | undefined
  readonly encryptionKey?: string | undefined
  readonly spanAttributes?: Record<string, unknown> | undefined
  readonly transformResultNames?: ((str: string) => string) | undefined
  readonly transformQueryNames?: ((str: string) => string) | undefined
}

Added in v1.0.0

tags

SqliteClient

Signature

export declare const SqliteClient: any

Added in v1.0.0

type ids

TypeId

Signature

export declare const TypeId: typeof TypeId

Added in v1.0.0

TypeId (type alias)

Signature

export type TypeId = typeof TypeId

Added in v1.0.0