# BlockDB Docs

> BlockDB product documentation: a logical multi-model database for blockchain data, with ready-to-use on-chain semantic tables and event subscription.

## Getting started

- [Overview](https://docs.blockdb.chaintable.com/index.md): BlockDB product documentation: a logical multi-model database built for blockchain data.
- [Quickstart](https://docs.blockdb.chaintable.com/quickstart.md): Make your first reads, writes, and subscriptions against BlockDB gRPC in a few minutes.

## Core concepts

- [Introduction](https://docs.blockdb.chaintable.com/concepts/overview.md): BlockDB is a logical database layer: it manages MySQL-protocol databases underneath and exposes regular tables, Block State/Event tables, and Time Tables with their own read/write APIs.
- [Data model](https://docs.blockdb.chaintable.com/concepts/data-model.md): BlockDB's regular tables, Block State Table, Block Event Table, and Time Table, plus the shadow table mechanism.
- [Block tables](https://docs.blockdb.chaintable.com/concepts/block-tables.md): A deep dive into BlockDB's two core logical table models: model definitions, logical types, start and consensus height, and core features.
- [Time tables](https://docs.blockdb.chaintable.com/concepts/time-table.md): Time Table: a series table bucketed by physical time, with built-in dedup and storage compaction.
- [Writes & subscriptions](https://docs.blockdb.chaintable.com/concepts/write-subscribe.md): BlockDB's real-time writes, batch writes, block subscription events, and the subscription loop.

## Architecture

- [Architecture](https://docs.blockdb.chaintable.com/architecture/overview.md): BlockDB's multi-service design as a logical database layer, its deployment options, and its underlying dependencies.
- [Components](https://docs.blockdb.chaintable.com/architecture/components.md): The responsibility and positioning of each BlockDB gRPC service, background service, and core component.
- [Write architecture](https://docs.blockdb.chaintable.com/architecture/batch-write.md): BlockDB's write architecture: batch writes by default, asynchronous at the core, with logical models guaranteeing consistency.

## Guides

- [Read and write data](https://docs.blockdb.chaintable.com/guides/data-access.md): Read and write data using the Table, BlockTable, and TimeTable model wrappers.
- [Subscriptions](https://docs.blockdb.chaintable.com/guides/subscribe.md): Use Subscribe to consume block write events and build real-time incremental pipelines.
- [Multi-table alignment](https://docs.blockdb.chaintable.com/guides/multi-table-alignment.md): Use the Aligned state machine so all tables are ready at the same height before triggering downstream compute.
- [Filters & operators](https://docs.blockdb.chaintable.com/guides/filter-operator.md): Build condition expressions with Column / filter, and filter + deduplicate preprocessing pipelines with Operator.
- [Compute with BlockX](https://docs.blockdb.chaintable.com/guides/blockx.md): Subscribe to an upstream block table, compute with BlockX functions, and write to your target block table — real-time and backfill share one configuration.

## Reference

- [API reference](https://docs.blockdb.chaintable.com/reference/api.md): BlockDB gRPC services and methods, expressed as protobuf, JSON payloads, and grpcurl invocations.
- [Data types](https://docs.blockdb.chaintable.com/reference/value-types.md): All logical types supported by BlockDB: categories, formats, length limits, and usage constraints.
- [Error codes](https://docs.blockdb.chaintable.com/reference/errors.md): BlockDB's business error codes and their gRPC status code mapping.

> The links below point to documentation indexes. Follow each `/_llms/` index recursively until you reach documentation pages.

## Indexes

- [Chinese (18 pages)](https://docs.blockdb.chaintable.com/_llms/zh.txt): Documentation for Chinese.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.