index overview

Added in v1.0.0

---

Table of contents

• constructor
  • MysqlClientConfig (interface)
  • make
  • makeCompiler
  • makeLayer
• model
  • MysqlClient (interface)
• tag
  • tag
• utils
  • transform

---

constructor

MysqlClientConfig (interface)

Signature

export interface MysqlClientConfig {
  /**
   * Connection URI. Setting this will override the other connection options
   */
  readonly url?: Secret.Secret

  readonly host?: string
  readonly port?: number
  readonly database?: string
  readonly username?: string
  readonly password?: Secret.Secret

  readonly maxConnections?: number
  readonly connectionTTL?: Duration.DurationInput

  readonly poolConfig?: Mysql.PoolOptions

  readonly transformResultNames?: (str: string) => string
  readonly transformQueryNames?: (str: string) => string
}

Added in v1.0.0

make

Signature

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

Added in v1.0.0

makeCompiler

Signature

export declare const makeCompiler: (transform?: ((_: string) => string) | undefined) => Statement.Compiler

Added in v1.0.0

makeLayer

Signature

export declare const makeLayer: (config: Config.Config.Wrap<MysqlClientConfig>) => Layer.Layer<MysqlClient, ConfigError>

Added in v1.0.0

model

MysqlClient (interface)

Signature

export interface MysqlClient extends Client.Client {
  readonly config: MysqlClientConfig
}

Added in v1.0.0

tag

tag

Signature

export declare const tag: Tag<MysqlClient, MysqlClient>

Added in v1.0.0

utils

transform

Column renaming helpers.

Signature

export declare const transform: typeof transform

Added in v1.0.0