API Documentation

Connects using provided $db configuration.

Internal accessor (read)

Internal accessor (write)

Fetch one row or null

Fetch one row or null using the write connection

Fetch all rows

Fetch all rows using the write connection

Execute a statement (write) -> affected row count

Begin transaction on write connection

Commit transaction

Roll back transaction

Last insert id

Execute a write statement and return a transaction id that can be
tracked via the configured socket signal and logs.
If $autoCommit is true, the statement runs in its own tx.
/

Return last generated transaction id (if any)

Trivial tracker — returns true once notified (always true immediately after)

Close connections

Load all locale resources once.

{
  "function": "I18n.loadResources",
  "parameters": ["...", "...", "..."]
}

Simple translate with interpolation and fallback.

{
  "function": "I18n.translate",
  "parameters": ["...", "..."]
}

Naive Accept-Language best match

{
  "function": "I18n.bestMatchFromAcceptLanguage",
  "parameters": ["...", "...", "..."]
}

Apply all pending migrations. Returns an array with migration names that
were applied. A logger callback can be provided to mirror CLI output.
@param callable|null $logger Receives a single message string.
@return array{applied: string[]}
/

Determine if any migrations are pending.
/

Return structured data about pending migrations.
@return array<int, array{name: string, path: string, checksum: string}>
/

@return array<string, string> filename => checksum
/

Split SQL file contents into individual statements.
@return string[]
/

Send a plain-text email. Returns true on success.
@param string $toEmail
@param string $subject
@param string $body
@param array $config
@return bool
/

{
  "function": "SimpleMail.sendPlainText",
  "parameters": ["...", "...", "...", "..."]
}