gdo/driver

Types

Authentication

pub type Authentication {
  NoAuthentication
  UsernameAndPassword(username: String, password: String)
}

Constructors

```
NoAuthentication
```

UsernameAndPassword(username: String, password: String)

Capability

</>

pub type Capability {
  SupportsTransactions
  SupportsLastInsertId
  SupportsPositionalParameters
  SupportsNamedParameters
  SupportsEmbeddedConnections
  SupportsNetworkConnections
  SupportsAuthentication
  SupportsTlsConfiguration
}

Constructors

```
SupportsTransactions
```
```
SupportsLastInsertId
```
```
SupportsPositionalParameters
```
```
SupportsNamedParameters
```
```
SupportsEmbeddedConnections
```
```
SupportsNetworkConnections
```
```
SupportsAuthentication
```
```
SupportsTlsConfiguration
```

ConnectionTarget

</>

pub type ConnectionTarget {
  EmbeddedDatabase(path: String)
  ServerDatabase(network: NetworkEndpoint)
}

Constructors

```
EmbeddedDatabase(path: String)
```

ServerDatabase(network: NetworkEndpoint)

Driver

</>

pub type Driver {
  Sqlite
}

Constructors

```
Sqlite
```

DriverConnectionState

</>

pub type DriverConnectionState {
  SqliteConnectionState(
    database: String,
    connection: sqlight.Connection,
    last_insert_id: option.Option(Int),
  )
}

Constructors

SqliteConnectionState(
  database: String,
  connection: sqlight.Connection,
  last_insert_id: option.Option(Int),
)

DriverContract

</>

pub type DriverContract {
  DriverContract(
    connect: fn(ConnectionTarget) -> Result(
      DriverConnectionState,
      error.Error,
    ),
    close: fn(DriverConnectionState) -> Result(Nil, error.Error),
    prepare: fn(DriverConnectionState, String) -> Result(
      DriverStatementState,
      error.Error,
    ),
    exec: fn(DriverStatementState, List(value.Param)) -> Result(
      result.ExecutionResult,
      error.Error,
    ),
    query_all: fn(DriverStatementState, List(value.Param)) -> Result(
      result.QueryResult,
      error.Error,
    ),
    begin: fn(DriverConnectionState) -> Result(
      DriverConnectionState,
      error.Error,
    ),
    commit: fn(DriverConnectionState) -> Result(
      DriverConnectionState,
      error.Error,
    ),
    rollback: fn(DriverConnectionState) -> Result(
      DriverConnectionState,
      error.Error,
    ),
    last_insert_id: fn(DriverConnectionState) -> option.Option(
      Int,
    ),
  )
}

Constructors

DriverContract(
  connect: fn(ConnectionTarget) -> Result(
    DriverConnectionState,
    error.Error,
  ),
  close: fn(DriverConnectionState) -> Result(Nil, error.Error),
  prepare: fn(DriverConnectionState, String) -> Result(
    DriverStatementState,
    error.Error,
  ),
  exec: fn(DriverStatementState, List(value.Param)) -> Result(
    result.ExecutionResult,
    error.Error,
  ),
  query_all: fn(DriverStatementState, List(value.Param)) -> Result(
    result.QueryResult,
    error.Error,
  ),
  begin: fn(DriverConnectionState) -> Result(
    DriverConnectionState,
    error.Error,
  ),
  commit: fn(DriverConnectionState) -> Result(
    DriverConnectionState,
    error.Error,
  ),
  rollback: fn(DriverConnectionState) -> Result(
    DriverConnectionState,
    error.Error,
  ),
  last_insert_id: fn(DriverConnectionState) -> option.Option(Int),
)

DriverStatementState

</>

pub type DriverStatementState {
  SqliteStatementState(
    connection: sqlight.Connection,
    sql: String,
  )
}

Constructors

SqliteStatementState(connection: sqlight.Connection, sql: String)

NetworkEndpoint

</>

pub type NetworkEndpoint {
  NetworkEndpoint(
    host: String,
    port: Int,
    database: String,
    authentication: Authentication,
    tls: TransportSecurity,
  )
}

Constructors

NetworkEndpoint(
  host: String,
  port: Int,
  database: String,
  authentication: Authentication,
  tls: TransportSecurity,
)

TransportSecurity

</>

pub type TransportSecurity {
  DisableTls
  PreferTls
  RequireTls
}

Constructors

```
DisableTls
```
```
PreferTls
```
```
RequireTls
```

Values

begin

</>

pub fn begin(
  contract: DriverContract,
  connection_state: DriverConnectionState,
) -> Result(DriverConnectionState, error.Error)

capabilities

</>

pub fn capabilities(driver: Driver) -> List(Capability)

close

</>

pub fn close(
  contract: DriverContract,
  connection_state: DriverConnectionState,
) -> Result(Nil, error.Error)

commit

</>

pub fn commit(
  contract: DriverContract,
  connection_state: DriverConnectionState,
) -> Result(DriverConnectionState, error.Error)

connect

</>

pub fn connect(
  contract: DriverContract,
  target: ConnectionTarget,
) -> Result(DriverConnectionState, error.Error)

connection_target_name

</>

pub fn connection_target_name(target: ConnectionTarget) -> String

exec

</>

pub fn exec(
  contract: DriverContract,
  statement_state: DriverStatementState,
  params: List(value.Param),
) -> Result(result.ExecutionResult, error.Error)

identifier

</>

pub fn identifier(target: ConnectionTarget) -> String

last_insert_id

</>

pub fn last_insert_id(
  contract: DriverContract,
  connection_state: DriverConnectionState,
) -> option.Option(Int)

name

</>

pub fn name(driver: Driver) -> String

prepare

</>

pub fn prepare(
  contract: DriverContract,
  connection_state: DriverConnectionState,
  sql: String,
) -> Result(DriverStatementState, error.Error)

query_all

</>

pub fn query_all(
  contract: DriverContract,
  statement_state: DriverStatementState,
  params: List(value.Param),
) -> Result(result.QueryResult, error.Error)

rollback

</>

pub fn rollback(
  contract: DriverContract,
  connection_state: DriverConnectionState,
) -> Result(DriverConnectionState, error.Error)

supports

</>

pub fn supports(
  driver: Driver,
  capability capability: Capability,
) -> Bool