mysql

A highly efficient, enterprise-grade MySQL relational database CRUD wrapper and state-routing backend client for the collaborative CoCreate ecosystem. This wrapper maps MySQL's robust, world-standard structured SQL capabilities into CoCreate's unified JSON interface.

Documentation

For a complete guide and working integration examples, refer to the CoCreate MySQL Documentation.

---

Table of Contents

• The Power of the CoCreate Unified Ecosystem
• Why MySQL?
• Installation
• Unified JSON Payload Examples
• Announcements
• Roadmap
• How to Contribute
• About

---

The Power of the CoCreate Unified Ecosystem

This is not just another database driver. By wrapping MySQL 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 custom SQL strings or manually manage relational column mappings. CoCreate translates standard NoSQL JSON CRUD operations (such as object.create or object.read) transparently into optimized MySQL transactional SQL under the hood.
• 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 MySQL (for enterprise-grade relational warehousing) in perfect parallel harmony:

$$\text{Write Command} \xrightarrow{\text{Parallel Mesh}} \begin{cases} \text{MongoDB} & \text{(ACID Transaction Store)} \ \text{Qdrant} & \text{(Semantic Vector Search)} \ \text{MySQL} & \text{(Enterprise Relational Core)} \end{cases}$$

• Dynamic State-Routing: Isolate multi-tenant environments effortlessly. The routing mesh automatically injects tenant metadata and organization boundaries, ensuring isolated database processing within your shared MySQL infrastructure.

---

Why MySQL?

MySQL is the world's most popular open-source relational database management system. It serves as the primary relational backbone for many of the world's largest digital enterprises. It offers robust transaction support (via InnoDB), enterprise-grade replication options, high availability setups, and strict data integrity compliance.

By routing operational states, structured analytical reporting datasets, and secure transactional tables to MySQL via this wrapper, you unlock standard, fault-tolerant SQL reliability directly within your unified infrastructure.

---

Installation

NPM Installation

npm i @cocreate/mysql

Yarn Installation

yarn add @cocreate/mysql

---

Unified JSON Payload Examples

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.

1. Writing a Full Transaction Object (object.create)

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": ["mysql", "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"
}

2. Reading and Filtering Warehoused Data (object.read)

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 MySQL, sorting them by total sale volume.

{
  "method": "object.read",
  "storage": "mysql",
  "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"
}

---

Announcements

All updates to this library are documented in our CHANGELOG and releases. You may also subscribe to email for releases and breaking changes.

---

Roadmap

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.

---

How to Contribute

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!

---

About

CoCreate-mysql is guided and supported by the CoCreate Developer Experience Team.

Please Email the Developer Experience Team here in case of any queries.

CoCreate-mysql is maintained and funded by CoCreate. The names and logos for CoCreate are trademarks of CoCreate, LLC.