gmysql

Types

Connection

pub type Connection

ConnectionMode

</>

pub type ConnectionMode {
  Synchronous
  Asynchronous
  Lazy
}

Constructors

```
Synchronous
```
```
Asynchronous
```
```
Lazy
```

ConnectionOption

</>

pub type ConnectionOption {
  Host(String)
  Port(Int)
  User(String)
  Password(String)
  Database(String)
  ConnectMode(ConnectionMode)
  ConnectTimeout(Int)
  KeepAlive(Int)
}

Constructors

```
Host(String)
```
```
Port(Int)
```
```
User(String)
```
```
Password(String)
```
```
Database(String)
```
```
ConnectMode(ConnectionMode)
```
```
ConnectTimeout(Int)
```
```
KeepAlive(Int)
```

Error

</>

pub type Error {
  ServerError(Int, BitArray)
  UnknownError(Dynamic)
  DecodeError(dynamic.DecodeErrors)
}

Constructors

```
ServerError(Int, BitArray)
```
```
UnknownError(Dynamic)
```
```
DecodeError(dynamic.DecodeErrors)
```

Param

</>

pub type Param

TransactionError

</>

pub type TransactionError(a) {
  FunctionError(a)
  OtherError(Dynamic)
}

Constructors

```
FunctionError(a)
```
```
OtherError(Dynamic)
```

Functions

close

</>

pub fn close(connection: Connection) -> Nil

connect

</>

pub fn connect(
  options: List(ConnectionOption),
) -> Result(Connection, Dynamic)

exec

</>

pub fn exec(
  connection: Connection,
  query: String,
  timeout: Int,
) -> Result(Nil, Error)

query

</>

pub fn query(
  connection: Connection,
  query: String,
  params: List(Param),
  timeout: Int,
  decoder: fn(Dynamic) -> Result(a, List(DecodeError)),
) -> Result(a, Error)

to_param

</>

pub fn to_param(param: a) -> Param

with_connection

</>

pub fn with_connection(
  options: List(ConnectionOption),
  with function: fn(Connection) -> a,
) -> Result(a, Dynamic)

with_transaction

</>

pub fn with_transaction(
  connection: Connection,
  retry retries: Int,
  with function: fn(Connection) -> Result(a, b),
) -> Result(a, TransactionError(b))

Execute a function within a transaction. If the function throws or returns an error, it will rollback. You can nest this function, which will create a savepoint.