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

D1Client overview

Added in v1.0.0


Table of contents


constructor

make

Signature

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

Added in v1.0.0

layers

layer

Signature

export declare const layer: (config: D1ClientConfig) => Layer.Layer<D1Client | Client.SqlClient, ConfigError>

Added in v1.0.0

layerConfig

Signature

export declare const layerConfig: (
  config: Config.Config.Wrap<D1ClientConfig>
) => Layer.Layer<D1Client | Client.SqlClient, ConfigError>

Added in v1.0.0

models

D1Client (interface)

Signature

export interface D1Client extends Client.SqlClient {
  readonly [TypeId]: TypeId
  readonly config: D1ClientConfig

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

Added in v1.0.0

D1ClientConfig (interface)

Signature

export interface D1ClientConfig {
  readonly db: D1Database
  readonly prepareCacheSize?: number | undefined
  readonly prepareCacheTTL?: Duration.DurationInput | 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

D1Client

Signature

export declare const D1Client: 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