@mastra/mysql 0.8.5-alpha.1 → 0.8.5

package/README.md

@@ -8,51 +8,9 @@ MySQL storage implementation for Mastra, providing persistent storage for thread
 npm install @mastra/mysql
 ```
 
-## Prerequisites
-
-- MySQL 8.0 or higher
-
 ## Usage
 
-```typescript
-import { MySQLStore } from '@mastra/mysql';
-
-const store = new MySQLStore({
-  connectionString: 'mysql://user:password@localhost:3306/mastra',
-});
-
-// Create a thread
-await store.saveThread({
-  thread: {
-    id: 'thread-123',
-    resourceId: 'resource-456',
-    title: 'My Thread',
-    metadata: { key: 'value' },
-    createdAt: new Date(),
-    updatedAt: new Date(),
-  },
-});
-
-// Add messages to thread
-await store.saveMessages({
-  messages: [
-    {
-      id: 'msg-789',
-      threadId: 'thread-123',
-      role: 'user',
-      content: { content: 'Hello' },
-      resourceId: 'resource-456',
-      createdAt: new Date(),
-    },
-  ],
-});
-
-// Query threads and messages
-const savedThread = await store.getThreadById({ threadId: 'thread-123' });
-const messages = await store.listMessages({ threadId: 'thread-123' });
-```
-
-### With Mastra
+Configure the database credentials required by your provider.
 
 ```typescript
 import { Mastra } from '@mastra/core';
@@ -65,88 +23,14 @@ export const mastra = new Mastra({
 });
 ```
 
-## Configuration
-
-`MySQLStore` supports two connection methods:
-
-**1. Connection String**
-
-```typescript
-const store = new MySQLStore({
-  connectionString: 'mysql://user:password@localhost:3306/mastra',
-});
-```
-
-**2. Host/Port/Database**
+## Documentation
 
-```typescript
-const store = new MySQLStore({
-  host: 'localhost',
-  port: 3306,
-  user: 'mastra',
-  password: 'mastra',
-  database: 'mastra',
-});
-```
-
-### Optional Configuration
-
-- `ssl`: Enable SSL or provide custom SSL options (`true` | `false` | object)
-- `max`: Maximum pool connections (default: `10`)
-- `database`: Override the database name parsed from the connection string
-- `waitForConnections`: Queue requests when the pool is full (default: `true`, host config only)
-- `queueLimit`: Maximum queued connection requests, `0` for unlimited (default: `0`, host config only)
-- `skipDefaultIndexes`: Skip creating the built-in performance indexes during setup (default: `false`)
-- `indexes`: Additional custom indexes to create during setup
-
-## Features
-
-- Persistent storage for threads, messages, workflows, scores, datasets, and experiments
-- Full observability/tracing storage (spans and traces)
-- Atomic transactions for data consistency
-- Efficient batch operations
-- Connection pooling via `mysql2`
-- Automatic table and index setup on first use
-- Rich metadata support with JSON columns
-- Timestamp tracking and cascading deletes
-
-## Storage Methods
-
-- `saveThread({ thread })`: Create or update a thread
-- `getThreadById({ threadId })`: Get a thread by ID
-- `deleteThread({ threadId })`: Delete a thread and its messages
-- `saveMessages({ messages })`: Save multiple messages in a transaction
-- `listMessages({ threadId, perPage?, page? })`: Get messages for a thread with pagination
-- `deleteMessages(messageIds)`: Delete specific messages
-
-## Development
+This README is the package guide. `MySQLStore` provides Mastra's storage domains through a MySQL connection pool, including agents, messages, workflows, observability, scores, datasets, prompt blocks, MCP records, and workspaces.
 
-### Environment Variables
+## Changelog
 
-The test suite reads the following variables to connect to MySQL, falling back to the defaults shown:
-
-- `MYSQL_HOST` (default: `localhost`)
-- `MYSQL_PORT` (default: `3306`)
-- `MYSQL_USER` (default: `mastra`)
-- `MYSQL_PASSWORD` (default: `mastra`)
-- `MYSQL_DB` (default: `mastra`)
-
-### Running Tests
-
-Unit tests run without a database:
-
-```bash
-pnpm test src/storage/index.unit.test.ts
-```
-
-Integration tests use Docker to start a MySQL instance, run the suite, and clean up afterward:
-
-```bash
-# Ensure Docker is running
-pnpm test
-```
+See the [package changelog](https://github.com/mastra-ai/mastra/blob/main/stores/mysql/CHANGELOG.md) for version history and release notes.
 
-## Related Links
+## Support
 
-- [Mastra Storage Documentation](https://mastra.ai/docs)
-- [MySQL Documentation](https://dev.mysql.com/doc/)
+We have an [open community Discord](https://discord.gg/mastra-ai). Come and say hello and let us know if you have any questions or need any help getting things running.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/mysql",
-  "version": "0.8.5-alpha.1",
+  "version": "0.8.5",
   "description": "MySQL provider for Mastra - db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -31,10 +31,10 @@
     "tsx": "^4.23.1",
     "typescript": "^7.0.2",
     "vitest": "4.1.10",
-    "@internal/lint": "0.0.129",
-    "@internal/storage-test-utils": "0.0.125",
-    "@internal/types-builder": "0.0.104",
-    "@mastra/core": "1.64.0-alpha.5"
+    "@internal/lint": "0.0.130",
+    "@internal/types-builder": "0.0.105",
+    "@internal/storage-test-utils": "0.0.126",
+    "@mastra/core": "1.64.0"
   },
   "peerDependencies": {
     "@mastra/core": ">=1.63.1-0 <2.0.0-0"