A highly efficient, enterprise-grade TiDB distributed SQL database CRUD wrapper and state-routing backend client for the collaborative CoCreate ecosystem. This wrapper maps TiDB's advanced HTAP (Hybrid Transactional and Analytical Processing), cloud-native scale, and MySQL-compatible database engines into CoCreate's unified JSON interface.
For a complete guide and working integration examples, refer to the CoCreate TiDB Documentation.
- The Power of the CoCreate Unified Ecosystem
- Why TiDB?
- Installation
- Unified JSON Payload Examples
- Announcements
- Roadmap
- How to Contribute
- About
This is not just another database driver. By wrapping TiDB into the CoCreate state-routing pipeline, you unlock the full power of a multi-cloud, multi-model data orchestration mesh:
- Unified JSON Interface (MongoDB-like Syntax): You don't need to write manual relational SQL strings or manage massive sharding keys. CoCreate translates standard NoSQL JSON CRUD operations (such as
object.createorobject.read) transparently into highly optimized MySQL-compatible queries executed over TiDB's distributed engine layer. - Parallel Multi-Database Writing: Write to many target databases simultaneously with a single API call. You can stream transactional data to MongoDB (for instant operational state), vectorize it into Qdrant (for real-time semantic search), and persist it in TiDB (for elastic distributed SQL scaling and real-time HTAP metrics) in perfect parallel harmony:
- Dynamic State-Routing: Isolate multi-tenant environments effortlessly. The routing mesh automatically injects tenant metadata and organization boundaries, ensuring isolated relational query boundaries within your horizontally scaled TiDB clusters.
TiDB is an advanced, open-source distributed SQL database designed for elastic scalability and multi-cloud readiness. Built with absolute MySQL compatibility, TiDB separates compute from storage, allowing you to scale out processing power and database capacity independently. Its unique HTAP architecture features two storage formats—a row store (TiKV) for high-performance online transactional processing and a columnar store (TiFlash) for live analytical reporting.
By routing business-critical web transactions, massive multi-tenant analytics workloads, and high-velocity operational ledgers straight to TiDB via this wrapper, you experience enterprise relational stability, elastic scaling, and live operational analytics without managing manual database partitions.
npm i @cocreate/tidb
yarn add @cocreate/tidb
Here are the complete, real-world JSON objects representing raw payloads routed through the CoCreate system. By declaring an array in the storage key, CoCreate fires the write operations to all specified backends simultaneously in parallel.
When this operational payload is sent, CoCreate registers it, processes the nested JSON fields, and automatically warehouses it across all listed parallel storage platforms.
{
"method": "object.create",
"storage": ["tidb", "mongodb", "qdrant"], // Array of storages to store in parallel!
"database": "sales_analytics",
"array": "order_events",
"object": {
"_id": "order_77c8f2a9_3b01",
"customer": {
"id": "cust_88301",
"email": "customer@example.com",
"region": "North America",
"acquisition_channel": "Google Search"
},
"transaction": {
"payment_method": "Credit Card",
"currency": "USD",
"subtotal": 249.99,
"discount": 15.00,
"tax": 18.80,
"total": 253.79
},
"items": [
{
"product_id": "prod_head_009",
"name": "Wireless Noise-Cancelling Headphones",
"category": "Electronics",
"quantity": 1,
"unit_price": 199.99
},
{
"product_id": "prod_stand_012",
"name": "Aluminum Headphone Stand",
"category": "Accessories",
"quantity": 2,
"unit_price": 25.00
}
],
"shipping": {
"carrier": "FedEx",
"service": "2-Day Air",
"estimated_delivery": "2026-07-20T12:00:00.000Z"
}
},
"organization_id": "org_enterprise_99x",
"user_id": "usr_sales_runner_402",
"timeStamp": "2026-07-18T18:40:43.000Z"
}
Querying targets a single database engine via a string filter syntax. The query below retrieves high-value orders handled by a specific shipping carrier from TiDB, sorting them by total sale volume.
{
"method": "object.read",
"storage": "tidb",
"database": "sales_analytics",
"array": "order_events",
"$filter": {
"query": {
"transaction.total": { "$gte": 100.00 },
"shipping.carrier": "FedEx"
},
"sort": [
{ "key": "transaction.total", "direction": "desc" }
],
"limit": 50,
"index": 0
},
"organization_id": "org_enterprise_99x"
}
All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email for releases and breaking changes.
If you are interested in the future direction of this project, please take a look at our open issues and pull requests. We would love to hear your feedback.
We encourage contribution to our libraries (you might even score some nifty swag), please see our CONTRIBUTING guide for details.
We want this library to be community-driven, and CoCreate led. We need your help to realize this goal. To help make sure we are building the right things in the right order, we ask that you create issues and pull requests or merely upvote or comment on existing issues or pull requests.
We appreciate your continued support, thank you!
CoCreate-tidb is guided and supported by the CoCreate Developer Experience Team.
Please Email the Developer Experience Team here in case of any queries.
CoCreate-tidb is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.