index overview

Added in v1.0.0

---

Table of contents

• constructor
  • MssqlClientConfig (interface)
  • make
  • makeCompiler
  • makeLayer
• model
  • MssqlClient (interface)
• tag
  • tag
• utils
  • TYPES
  • defaultParameterTypes
  • transform

---

constructor

MssqlClientConfig (interface)

Signature

export interface MssqlClientConfig {
  readonly domain?: string
  readonly server?: string
  readonly instanceName?: string
  readonly encrypt?: boolean
  readonly trustServer?: boolean
  readonly port?: number
  readonly authType?: string
  readonly database?: string
  readonly username?: string
  readonly password?: Secret.Secret
  readonly connectTimeout?: DurationInput

  readonly minConnections?: number
  readonly maxConnections?: number
  readonly connectionTTL?: DurationInput

  readonly parameterTypes?: Record<Statement.PrimitiveKind, Tedious.TediousType>

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

Added in v1.0.0

make

Signature

export declare const make: (options: MssqlClientConfig) => Effect.Effect<MssqlClient, 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<MssqlClientConfig>) => Layer.Layer<MssqlClient, ConfigError>

Added in v1.0.0

model

MssqlClient (interface)

Signature

export interface MssqlClient extends Client.Client {
  readonly config: MssqlClientConfig

  readonly param: (
    type: Tedious.TediousType,
    value: Statement.Primitive,
    options?: Tedious.ParameterOptions
  ) => Statement.Fragment

  readonly call: <I extends Record<string, Parameter<any>>, O extends Record<string, Parameter<any>>, A extends object>(
    procedure: ProcedureWithValues<I, O, A>
  ) => Effect.Effect<Procedure.Result<O, A>, SqlError>
}

Added in v1.0.0

tag

tag

Signature

export declare const tag: Tag<MssqlClient, MssqlClient>

Added in v1.0.0

utils

TYPES

Parameter types

Signature

export declare const TYPES: Tedious.TediousTypes

Added in v1.0.0

defaultParameterTypes

Signature

export declare const defaultParameterTypes: Record<Statement.PrimitiveKind, Tedious.TediousType>

Added in v1.0.0

transform

Column renaming helpers.

Signature

export declare const transform: typeof transform

Added in v1.0.0