Skip to content
Registry

database

v0.2.0

Talk to PostgreSQL, MySQL, and SQLite from iii — query, execute, transactions, prepared statements, and change feeds.

dbmysqlpostgressqlsqlite

Install

bash
iii trigger compose::add worker=database@0.2.0

Run in your project with the iii engine running. Exact versions are immutable and digest-pinned.

Functions10

database::commitTransaction

Function

Commit and finalize an interactive transaction.

Request
  • transaction_idstringrequired
Response
  • committedbooleanrequired

database::beginTransaction

Function

Open an interactive transaction; returns a handle to use with transactionQuery/transactionExecute/commitTransaction/rollbackTransaction.

Request
  • dbstringrequired
  • isolationstring
  • timeout_msinteger· uint64min 0
Response
  • transactionobjectrequired

    JSON wire envelope returned by `beginTransaction`.

    • expires_atstring· date-timerequired
    • idstringrequired

database::execute

Function

Run a write statement (INSERT/UPDATE/DELETE/DDL).

Request
  • dbstringrequired
  • paramsunknown[]
  • returningstring[]
  • sqlstringrequired
Response
  • affected_rowsinteger· uint64requiredmin 0
  • last_insert_idstring
  • returned_rowsobject[]required
    Empty object

database::transactionQuery

Function

Run a read-only SQL query inside an interactive transaction.

Request
  • paramsunknown[]
  • sqlstringrequired
  • transaction_idstringrequired
Response
  • columnsobject[]required
    • namestringrequired
    • typestringrequired
  • row_countinteger· uintrequiredmin 0
  • rowsobject[]required
    Empty object

database::query

Function

Run a read-only SQL query and return the result rows.

Request
  • dbstringrequired
  • paramsunknown[]
  • sqlstringrequired
  • timeout_msinteger· uint64min 0
Response
  • columnsobject[]required
    • namestringrequired
    • typestringrequired
  • row_countinteger· uintrequiredmin 0
  • rowsobject[]required
    Empty object

database::rollbackTransaction

Function

Rollback and finalize an interactive transaction.

Request
  • transaction_idstringrequired
Response
  • rolled_backbooleanrequired

database::prepareStatement

Function

Prepare a parameterized statement once.

Request
  • dbstringrequired
  • sqlstringrequired
  • ttl_secondsinteger· uint64min 0
Response
  • handleobjectrequired
    • expires_atstring· date-timerequired
    • idstringrequired

database::transaction

Function

Run a sequence of statements atomically.

Request
  • dbstringrequired
  • isolationstring
  • statementsobject[]required
    • paramsunknown[]
    • sqlstringrequired
Response
  • committedbooleanrequired
  • errorunknown
  • failed_indexinteger· uintmin 0
  • resultsobject[]
    • affected_rowsinteger· uint64requiredmin 0
    • rowsunknown[][]required

database::transactionExecute

Function

Run a write statement inside an interactive transaction. BEGIN/COMMIT/ROLLBACK are rejected; use commit/rollbackTransaction.

Request
  • paramsunknown[]
  • returningstring[]
  • sqlstringrequired
  • transaction_idstringrequired
Response
  • affected_rowsinteger· uint64requiredmin 0
  • last_insert_idstring
  • returned_rowsobject[]required
    Empty object

database::runStatement

Function

Run a previously-prepared handle.

Request
  • handle_idstringrequired
  • paramsunknown[]
Response
  • columnsobject[]required
    • namestringrequired
    • typestringrequired
  • row_countinteger· uintrequiredmin 0
  • rowsobject[]required
    Empty object

Triggers1

database::row-change

Trigger

Postgres logical replication. Stubbed in v1.0 pending tokio-postgres replication API.

Invocation
valueunknown
Return
valueunknown

Search the registry

Find workers, kits and executables, or jump to a page.