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

MysqlClient.ts overview

Since v1.0.0


Exports Grouped by Category


compiler

makeCompiler

Signature

declare const makeCompiler: (transform?: (_: string) => string) => any

Source

Since v1.0.0

constructors

make

Signature

declare const make: (options: MysqlClientConfig) => Effect.Effect<MysqlClient, SqlError, Scope | Reactivity.Reactivity>

Source

Since v1.0.0

layers

layer

Signature

declare const layer: (config: MysqlClientConfig) => Layer.Layer<MysqlClient | Client.SqlClient, ConfigError | SqlError>

Source

Since v1.0.0

layerConfig

Signature

declare const layerConfig: (
  config: Config.Config.Wrap<MysqlClientConfig>
) => Layer.Layer<MysqlClient | Client.SqlClient, ConfigError | SqlError>

Source

Since v1.0.0

models

MysqlClient (interface)

Signature

export interface MysqlClient extends Client.SqlClient {
  readonly [TypeId]: TypeId
  readonly config: MysqlClientConfig
}

Source

Since v1.0.0

MysqlClientConfig (interface)

Signature

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

  readonly host?: string | undefined
  readonly port?: number | undefined
  readonly database?: string | undefined
  readonly username?: string | undefined
  readonly password?: Redacted.Redacted | undefined

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

  readonly poolConfig?: Mysql.PoolOptions | undefined

  readonly spanAttributes?: Record<string, unknown> | undefined

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

Source

Since v1.0.0

tags

MysqlClient

Signature

declare const MysqlClient: any

Source

Since v1.0.0

type ids

TypeId

Signature

declare const TypeId: unique symbol

Source

Since v1.0.0

TypeId (type alias)

Signature

type TypeId = typeof TypeId

Source

Since v1.0.0