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

Client overview

Added in v1.0.0


Table of contents


compiler

makeCompiler

Signature

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

Added in v1.0.0

constructors

make

Signature

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

Added in v1.0.0

layers

layer

Signature

export declare const layer: (config: Config.Config.Wrap<MssqlClientConfig>) => Layer.Layer<any, ConfigError>

Added in v1.0.0

models

MssqlClient (interface)

Signature

export interface MssqlClient extends Client.Client {
  readonly [TypeId]: TypeId

  readonly config: MssqlClientConfig

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

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

Added in v1.0.0

MssqlClientConfig (interface)

Signature

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

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

  readonly parameterTypes?: Record<Statement.PrimitiveKind, DataType> | undefined

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

Added in v1.0.0

tags

MssqlClient

Signature

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

utils

defaultParameterTypes

Signature

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

Added in v1.0.0