db-core/custom-adapter

Official

Create custom adapters for new backends.

AuthorTanStack
Version1.0.0
Installs0

System Documentation

What problem does it solve?

Custom adapters let you plug new backends into TanStack DB without rewriting core logic, translating backend-specific data models into a unified collection API.

Core Features & Use Cases

  • On-demand sync with custom backends, including LoadSubset options and a persisted metadata API for per-row and per-collection state.
  • Rich change messaging and synchronization lifecycle support for Insert/Update/Delete flows.
  • Seamless integration with existing db-core tooling and patterns to accelerate backend integration and real-time data workflows.

Quick Start

Create a new backend adapter by implementing a CollectionConfig with a sync function that uses begin, write, commit, and markReady, then register the collection to start syncing.

Dependency Matrix

Required Modules

None required

Components

Standard package

💻 Claude Code Installation

Recommended: Let Claude install automatically. Simply copy and paste the text below to Claude Code.

Please help me install this Skill:
Name: db-core/custom-adapter
Download link: https://github.com/TanStack/db/archive/main.zip#db-core-custom-adapter

Please download this .zip file, extract it, and install it in the .claude/skills/ directory.
View Source Repository

Agent Skills Search Helper

Install a tiny helper to your Agent, search and equip skill from 471,000+ vetted skills library on demand.