Skip to content
Pen

Sql

This package provides a SQL database client.

{
  "type": "system"
}

Install

Section titled “Install”
{
  "dependencies": {
    "Sql": "pen:///sql"
  }
}

Sql'Context module

Section titled “Sql'Context module”

Types

Section titled “Types”

Context

Section titled “Context”

A SQL database context

type Context = context'Context

Functions

Section titled “Functions”

No functions are defined.

Sql'Pool module

Section titled “Sql'Pool module”

Types

Section titled “Types”

Pool

Section titled “Pool”

A connection pool

type Pool = pool'Pool

Functions

Section titled “Functions”

New

Section titled “New”

Create a connection pool.

\(context Context, uri string, options Options) Pool | error

Query

Section titled “Query”

Run a query and return its rows.

\(context Context, pool Pool, query string, arguments [Value]) [[Value]] | error

Execute

Section titled “Execute”

Run a query and return a number of affected rows.

\(context Context, pool Pool, query string, arguments [Value]) number | error

Sql'Pool'Options module

Section titled “Sql'Pool'Options module”

Types

Section titled “Types”

Options

Section titled “Options”

Connection pool options

type Options {
  MinConnections number
  MaxConnections number
  ConnectTimeout number
}

Functions

Section titled “Functions”

No functions are defined.

Sql'Value module

Section titled “Sql'Value module”

Types

Section titled “Types”

Value

Section titled “Value”

A value in a column

type Value = boolean | none | number | string

Functions

Section titled “Functions”

No functions are defined.