# tigerbeetlex v0.17.3 - Table of Contents

Elixir client for TigerBeetle, the financial transactions database.

## Pages

- Introduction
  - [Walkthrough](walkthrough.md)
  - [Change Data Capture with Broadway](change_data_capture.md)

## Modules

- Message based API
  - [TigerBeetlex.Client](TigerBeetlex.Client.md): Message based API.
  - [TigerBeetlex.Response](TigerBeetlex.Response.md): NIF Response parsing.
This module is responsible for converting a response received from the TigerBeetle NIF to either
an error or a list of results.

- Blocking API
  - [TigerBeetlex.Connection](TigerBeetlex.Connection.md): Blocking API.

- Data structures
  - [TigerBeetlex.Account](TigerBeetlex.Account.md): See [Account](https://docs.tigerbeetle.com/reference/account#).

  - [TigerBeetlex.AccountBalance](TigerBeetlex.AccountBalance.md): See [AccountBalance](https://docs.tigerbeetle.com/reference/account-balance#).

  - [TigerBeetlex.AccountFilter](TigerBeetlex.AccountFilter.md): See [AccountFilter](https://docs.tigerbeetle.com/reference/account-filter#).

  - [TigerBeetlex.AccountFilterFlags](TigerBeetlex.AccountFilterFlags.md): See [AccountFilterFlags](https://docs.tigerbeetle.com/reference/account-filter#flags).

  - [TigerBeetlex.AccountFlags](TigerBeetlex.AccountFlags.md): See [AccountFlags](https://docs.tigerbeetle.com/reference/account#flags).

  - [TigerBeetlex.CreateAccountResult](TigerBeetlex.CreateAccountResult.md): See [CreateAccountResult](https://docs.tigerbeetle.com/reference/requests/create_accounts#result).

  - [TigerBeetlex.CreateTransferResult](TigerBeetlex.CreateTransferResult.md): See [CreateTransferResult](https://docs.tigerbeetle.com/reference/requests/create_transfers#result).

  - [TigerBeetlex.QueryFilter](TigerBeetlex.QueryFilter.md): See [QueryFilter](https://docs.tigerbeetle.com/reference/query-filter#).

  - [TigerBeetlex.QueryFilterFlags](TigerBeetlex.QueryFilterFlags.md): See [QueryFilterFlags](https://docs.tigerbeetle.com/reference/query-filter#flags).

  - [TigerBeetlex.Transfer](TigerBeetlex.Transfer.md): See [Transfer](https://docs.tigerbeetle.com/reference/transfer#).

  - [TigerBeetlex.TransferFlags](TigerBeetlex.TransferFlags.md): See [TransferFlags](https://docs.tigerbeetle.com/reference/transfer#flags).

- Utilities
  - [TigerBeetlex.ID](TigerBeetlex.ID.md): Utility functions to generate TigerBeetle Time-Based Identifiers.

- CDC
  - [TigerBeetlex.CDC.Account](TigerBeetlex.CDC.Account.md): A struct representing an Account in a TigerBeetle CDC event, see
[Change Data Capture](https://docs.tigerbeetle.com/operating/cdc/#message-content)
  - [TigerBeetlex.CDC.AccountFlags](TigerBeetlex.CDC.AccountFlags.md): A struct representing AccountFlags in a TigerBeetle CDC event, see
[Change Data Capture](https://docs.tigerbeetle.com/operating/cdc/#message-content)
  - [TigerBeetlex.CDC.Event](TigerBeetlex.CDC.Event.md): A struct representing TigerBeetle CDC event, see
[Change Data Capture](https://docs.tigerbeetle.com/operating/cdc/#message-content).
  - [TigerBeetlex.CDC.Transfer](TigerBeetlex.CDC.Transfer.md): A struct representing a Transfer in a TigerBeetle CDC event, see
[Change Data Capture](https://docs.tigerbeetle.com/operating/cdc/#message-content).
  - [TigerBeetlex.CDC.TransferFlags](TigerBeetlex.CDC.TransferFlags.md): A struct representing TransferFlags in a TigerBeetle CDC event, see
[Change Data Capture](https://docs.tigerbeetle.com/operating/cdc/#message-content)

- Types
  - [TigerBeetlex.Types](TigerBeetlex.Types.md): Common typespecs.

