@mastra/memory 1.5.0 → 1.5.1

package/dist/docs/references/reference-storage-dynamodb.md

@@ -1,282 +0,0 @@
-# DynamoDB Storage
-
-The DynamoDB storage implementation provides a scalable and performant NoSQL database solution for Mastra, leveraging a single-table design pattern with [ElectroDB](https://electrodb.dev/).
-
-> **Observability Not Supported:** DynamoDB storage **does not support the observability domain**. Traces from the `DefaultExporter` cannot be persisted to DynamoDB, and Mastra Studio's observability features won't work with DynamoDB as your only storage provider. To enable observability, use [composite storage](https://mastra.ai/reference/storage/composite) to route observability data to a supported provider like ClickHouse or PostgreSQL.
-
-> **Item Size Limit:** DynamoDB enforces a **400 KB maximum item size**. This limit can be exceeded when storing messages with base64-encoded attachments such as images. See [Handling large attachments](https://mastra.ai/docs/memory/storage) for workarounds including uploading attachments to external storage.
-
-## Features
-
-- Efficient single-table design for all Mastra storage needs
-- Based on ElectroDB for type-safe DynamoDB access
-- Support for AWS credentials, regions, and endpoints
-- Compatible with AWS DynamoDB Local for development
-- Stores Thread, Message, Eval, and Workflow data
-- Optimized for serverless environments
-- Configurable TTL (Time To Live) for automatic data expiration per entity type
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/dynamodb@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/dynamodb@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/dynamodb@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/dynamodb@latest
-```
-
-## Prerequisites
-
-Before using this package, you **must** create a DynamoDB table with a specific structure, including primary keys and Global Secondary Indexes (GSIs). This adapter expects the DynamoDB table and its GSIs to be provisioned externally.
-
-Detailed instructions for setting up the table using AWS CloudFormation or AWS CDK are available in [TABLE\_SETUP.md](https://github.com/mastra-ai/mastra/blob/main/stores/dynamodb/TABLE_SETUP.md). Please ensure your table is configured according to those instructions before proceeding.
-
-## Usage
-
-### Basic Usage
-
-```typescript
-import { Memory } from "@mastra/memory";
-import { DynamoDBStore } from "@mastra/dynamodb";
-
-// Initialize the DynamoDB storage
-const storage = new DynamoDBStore({
-  id: "dynamodb", // Unique identifier for this storage instance
-  config: {
-    tableName: "mastra-single-table", // Name of your DynamoDB table
-    region: "us-east-1", // Optional: AWS region, defaults to 'us-east-1'
-    // endpoint: "http://localhost:8000", // Optional: For local DynamoDB
-    // credentials: { accessKeyId: "YOUR_ACCESS_KEY", secretAccessKey: "YOUR_SECRET_KEY" } // Optional
-  },
-});
-
-// Example: Initialize Memory with DynamoDB storage
-const memory = new Memory({
-  storage,
-  options: {
-    lastMessages: 10,
-  },
-});
-```
-
-### Local Development with DynamoDB Local
-
-For local development, you can use [DynamoDB Local](https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/DynamoDBLocal.html).
-
-1. **Run DynamoDB Local (e.g., using Docker):**
-
-   ```bash
-   docker run -p 8000:8000 amazon/dynamodb-local
-   ```
-
-2. **Configure `DynamoDBStore` to use the local endpoint:**
-
-   ```typescript
-   import { DynamoDBStore } from "@mastra/dynamodb";
-
-   const storage = new DynamoDBStore({
-     id: "dynamodb-local",
-     config: {
-       tableName: "mastra-single-table", // Ensure this table is created in your local DynamoDB
-       region: "localhost", // Can be any string for local, 'localhost' is common
-       endpoint: "http://localhost:8000",
-       // For DynamoDB Local, credentials are not typically required unless configured.
-       // If you've configured local credentials:
-       // credentials: { accessKeyId: "fakeMyKeyId", secretAccessKey: "fakeSecretAccessKey" }
-     },
-   });
-   ```
-
-   You will still need to create the table and GSIs in your local DynamoDB instance, for example, using the AWS CLI pointed to your local endpoint.
-
-## Parameters
-
-**id:** (`string`): Unique identifier for this storage instance.
-
-**config.tableName:** (`string`): The name of your DynamoDB table.
-
-**config.region?:** (`string`): AWS region. Defaults to 'us-east-1'. For local development, can be set to 'localhost' or similar.
-
-**config.endpoint?:** (`string`): Custom endpoint for DynamoDB (e.g., 'http\://localhost:8000' for local development).
-
-**config.credentials?:** (`object`): AWS credentials object with \`accessKeyId\` and \`secretAccessKey\`. If not provided, the AWS SDK will attempt to source credentials from environment variables, IAM roles (e.g., for EC2/Lambda), or the shared AWS credentials file.
-
-**config.ttl?:** (`object`): TTL (Time To Live) configuration for automatic data expiration. Configure per entity type: thread, message, trace, eval, workflow\_snapshot, resource, score. Each entity config includes: enabled (boolean), attributeName (string, default: 'ttl'), defaultTtlSeconds (number).
-
-## TTL (Time To Live) Configuration
-
-DynamoDB TTL allows you to automatically delete items after a specified time period. This is useful for:
-
-- **Cost optimization**: Automatically remove old data to reduce storage costs
-- **Data lifecycle management**: Implement retention policies for compliance
-- **Performance**: Prevent tables from growing indefinitely
-- **Privacy compliance**: Automatically purge personal data after specified periods
-
-### Enabling TTL
-
-To use TTL, you must:
-
-1. **Configure TTL in DynamoDBStore** (shown below)
-2. **Enable TTL on your DynamoDB table** via AWS Console or CLI, specifying the attribute name (default: `ttl`)
-
-```typescript
-import { DynamoDBStore } from "@mastra/dynamodb";
-
-const storage = new DynamoDBStore({
-  name: "dynamodb",
-  config: {
-    tableName: "mastra-single-table",
-    region: "us-east-1",
-    ttl: {
-      // Messages expire after 30 days
-      message: {
-        enabled: true,
-        defaultTtlSeconds: 30 * 24 * 60 * 60, // 30 days
-      },
-      // Threads expire after 90 days
-      thread: {
-        enabled: true,
-        defaultTtlSeconds: 90 * 24 * 60 * 60, // 90 days
-      },
-      // Traces expire after 7 days with custom attribute name
-      trace: {
-        enabled: true,
-        attributeName: "expiresAt", // Custom TTL attribute
-        defaultTtlSeconds: 7 * 24 * 60 * 60, // 7 days
-      },
-      // Workflow snapshots don't expire
-      workflow_snapshot: {
-        enabled: false,
-      },
-    },
-  },
-});
-```
-
-### Supported Entity Types
-
-TTL can be configured for these entity types:
-
-| Entity              | Description              |
-| ------------------- | ------------------------ |
-| `thread`            | Conversation threads     |
-| `message`           | Messages within threads  |
-| `trace`             | Observability traces     |
-| `eval`              | Evaluation results       |
-| `workflow_snapshot` | Workflow state snapshots |
-| `resource`          | User/resource data       |
-| `score`             | Scoring results          |
-
-### TTL Entity Configuration
-
-Each entity type accepts the following configuration:
-
-**enabled:** (`boolean`): Whether TTL is enabled for this entity type.
-
-**attributeName?:** (`string`): The DynamoDB attribute name to use for TTL. Must match the TTL attribute configured on your DynamoDB table. Defaults to 'ttl'.
-
-**defaultTtlSeconds?:** (`number`): Default TTL in seconds from item creation time. Items will be automatically deleted by DynamoDB after this duration.
-
-### Enabling TTL on Your DynamoDB Table
-
-After configuring TTL in your code, you must enable TTL on the DynamoDB table itself:
-
-**Using AWS CLI:**
-
-```bash
-aws dynamodb update-time-to-live \
-  --table-name mastra-single-table \
-  --time-to-live-specification "Enabled=true, AttributeName=ttl"
-```
-
-**Using AWS Console:**
-
-1. Go to the DynamoDB console
-2. Select your table
-3. Go to "Additional settings" tab
-4. Under "Time to Live (TTL)", click "Manage TTL"
-5. Enable TTL and specify the attribute name (default: `ttl`)
-
-> **Note**: DynamoDB deletes expired items within 48 hours after expiration. Items remain queryable until actually deleted.
-
-## AWS IAM Permissions
-
-The IAM role or user executing the code needs appropriate permissions to interact with the specified DynamoDB table and its indexes. Below is a sample policy. Replace `${YOUR_TABLE_NAME}` with your actual table name and `${YOUR_AWS_REGION}` and `${YOUR_AWS_ACCOUNT_ID}` with appropriate values.
-
-```json
-{
-  "Version": "2012-10-17",
-  "Statement": [
-    {
-      "Effect": "Allow",
-      "Action": [
-        "dynamodb:DescribeTable",
-        "dynamodb:GetItem",
-        "dynamodb:PutItem",
-        "dynamodb:UpdateItem",
-        "dynamodb:DeleteItem",
-        "dynamodb:Query",
-        "dynamodb:Scan",
-        "dynamodb:BatchGetItem",
-        "dynamodb:BatchWriteItem"
-      ],
-      "Resource": [
-        "arn:aws:dynamodb:${YOUR_AWS_REGION}:${YOUR_AWS_ACCOUNT_ID}:table/${YOUR_TABLE_NAME}",
-        "arn:aws:dynamodb:${YOUR_AWS_REGION}:${YOUR_AWS_ACCOUNT_ID}:table/${YOUR_TABLE_NAME}/index/*"
-      ]
-    }
-  ]
-}
-```
-
-## Key Considerations
-
-Before diving into the architectural details, keep these key points in mind when working with the DynamoDB storage adapter:
-
-- **External Table Provisioning:** This adapter _requires_ you to create and configure the DynamoDB table and its Global Secondary Indexes (GSIs) yourself, prior to using the adapter. Follow the guide in [TABLE\_SETUP.md](https://github.com/mastra-ai/mastra/blob/main/stores/dynamodb/TABLE_SETUP.md).
-- **Single-Table Design:** All Mastra data (threads, messages, etc.) is stored in one DynamoDB table. This is a deliberate design choice optimized for DynamoDB, differing from relational database approaches.
-- **Understanding GSIs:** Familiarity with how the GSIs are structured (as per `TABLE_SETUP.md`) is important for understanding data retrieval and potential query patterns.
-- **ElectroDB:** The adapter uses ElectroDB to manage interactions with DynamoDB, providing a layer of abstraction and type safety over raw DynamoDB operations.
-
-## Architectural Approach
-
-This storage adapter utilizes a **single-table design pattern** leveraging [ElectroDB](https://electrodb.dev/), a common and recommended approach for DynamoDB. This differs architecturally from relational database adapters (like `@mastra/pg` or `@mastra/libsql`) that typically use multiple tables, each dedicated to a specific entity (threads, messages, etc.).
-
-Key aspects of this approach:
-
-- **DynamoDB Native:** The single-table design is optimized for DynamoDB's key-value and query capabilities, often leading to better performance and scalability compared to mimicking relational models.
-- **External Table Management:** Unlike some adapters that might offer helper functions to create tables via code, this adapter **expects the DynamoDB table and its associated Global Secondary Indexes (GSIs) to be provisioned externally** before use. Please refer to [TABLE\_SETUP.md](https://github.com/mastra-ai/mastra/blob/main/stores/dynamodb/TABLE_SETUP.md) for detailed instructions using tools like AWS CloudFormation or CDK. The adapter focuses solely on interacting with the pre-existing table structure.
-- **Consistency via Interface:** While the underlying storage model differs, this adapter adheres to the same `MastraStorage` interface as other adapters, ensuring it can be used interchangeably within the Mastra `Memory` component.
-
-### Mastra Data in the Single Table
-
-Within the single DynamoDB table, different Mastra data entities (such as Threads, Messages, Traces, Evals, and Workflows) are managed and distinguished using ElectroDB. ElectroDB defines specific models for each entity type, which include unique key structures and attributes. This allows the adapter to store and retrieve diverse data types efficiently within the same table.
-
-For example, a `Thread` item might have a primary key like `THREAD#<threadId>`, while a `Message` item belonging to that thread might use `THREAD#<threadId>` as a partition key and `MESSAGE#<messageId>` as a sort key. The Global Secondary Indexes (GSIs), detailed in `TABLE_SETUP.md`, are strategically designed to support common access patterns across these different entities, such as fetching all messages for a thread or querying traces associated with a particular workflow.
-
-### Advantages of Single-Table Design
-
-This implementation uses a single-table design pattern with ElectroDB, which offers several advantages within the context of DynamoDB:
-
-1. **Lower cost (potentially):** Fewer tables can simplify Read/Write Capacity Unit (RCU/WCU) provisioning and management, especially with on-demand capacity.
-2. **Better performance:** Related data can be co-located or accessed efficiently through GSIs, enabling fast lookups for common access patterns.
-3. **Simplified administration:** Fewer distinct tables to monitor, back up, and manage.
-4. **Reduced complexity in access patterns:** ElectroDB helps manage the complexity of item types and access patterns on a single table.
-5. **Transaction support:** DynamoDB transactions can be used across different "entity" types stored within the same table if needed.

package/dist/docs/references/reference-storage-libsql.md

@@ -1,135 +0,0 @@
-# libSQL Storage
-
-[libSQL](https://docs.turso.tech/libsql) is an open-source, SQLite-compatible database that supports both local and remote deployments. It can be used to store message history, workflow snapshots, traces, and eval scores.
-
-For vectors like semantic recall or traditional RAG, use [libSQL Vector](https://mastra.ai/reference/vectors/libsql) which covers embeddings and vector search.
-
-## Installation
-
-Storage providers must be installed as separate packages:
-
-**npm**:
-
-```bash
-npm install @mastra/libsql@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/libsql@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/libsql@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/libsql@latest
-```
-
-## Usage
-
-```typescript
-import { LibSQLStore } from "@mastra/libsql";
-import { Mastra } from "@mastra/core";
-
-const mastra = new Mastra({
-  storage: new LibSQLStore({
-    id: 'libsql-storage',
-    url: "file:./storage.db",
-  }),
-});
-```
-
-Agent-level file storage:
-
-```typescript
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { LibSQLStore } from "@mastra/libsql";
-
-export const agent = new Agent({
-  id: "example-agent",
-  memory: new Memory({
-    storage: new LibSQLStore({
-      id: 'libsql-storage',
-      url: "file:./agent.db",
-    }),
-  }),
-});
-```
-
-> **Warning:** File storage doesn't work with serverless platforms that have ephemeral file systems. For serverless deployments, use [Turso](https://turso.tech) or a different database engine.
-
-Production with remote database:
-
-```typescript
-storage: new LibSQLStore({
-  id: 'libsql-storage',
-  url: "libsql://your-db-name.aws-ap-northeast-1.turso.io",
-  authToken: process.env.TURSO_AUTH_TOKEN,
-})
-```
-
-For local development and testing, you can store data in memory:
-
-```typescript
-storage: new LibSQLStore({
-  id: 'libsql-storage',
-  url: ":memory:",
-})
-```
-
-> **Warning:** In-memory storage resets when the process changes. Only suitable for development.
-
-## Options
-
-**url:** (`string`): Database URL. Use \`:memory:\` for in-memory database, \`file:filename.db\` for a file database, or a libSQL connection string (e.g., \`libsql://your-database.turso.io\`) for remote storage.
-
-**authToken?:** (`string`): Authentication token for remote libSQL databases.
-
-## Initialization
-
-When you pass storage to the Mastra class, `init()` is called automatically to create the [core schema](https://mastra.ai/reference/storage/overview):
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { LibSQLStore } from "@mastra/libsql";
-
-const storage = new LibSQLStore({
-  id: 'libsql-storage',
-  url: "file:./storage.db",
-});
-
-const mastra = new Mastra({
-  storage, // init() called automatically
-});
-```
-
-If using storage directly without Mastra, call `init()` explicitly:
-
-```typescript
-import { LibSQLStore } from "@mastra/libsql";
-
-const storage = new LibSQLStore({
-  id: 'libsql-storage',
-  url: "file:./storage.db",
-});
-
-await storage.init();
-
-// Access domain-specific stores via getStore()
-const memoryStore = await storage.getStore('memory');
-const thread = await memoryStore?.getThreadById({ threadId: "..." });
-```
-
-## Observability
-
-libSQL supports observability and is ideal for local development. Use the `realtime` [tracing strategy](https://mastra.ai/docs/observability/tracing/exporters/default) for immediate visibility while debugging.
-
-For production environments with higher trace volumes, consider using [PostgreSQL](https://mastra.ai/reference/storage/postgresql) or [ClickHouse via composite storage](https://mastra.ai/reference/storage/composite).

package/dist/docs/references/reference-storage-mongodb.md

@@ -1,262 +0,0 @@
-# MongoDB Storage
-
-The MongoDB storage implementation provides a scalable storage solution using MongoDB databases with support for both document storage and vector operations.
-
-## Installation
-
-**npm**:
-
-```bash
-npm install @mastra/mongodb@latest
-```
-
-**pnpm**:
-
-```bash
-pnpm add @mastra/mongodb@latest
-```
-
-**Yarn**:
-
-```bash
-yarn add @mastra/mongodb@latest
-```
-
-**Bun**:
-
-```bash
-bun add @mastra/mongodb@latest
-```
-
-## Usage
-
-Ensure you have a MongoDB Atlas Local (via Docker) or MongoDB Atlas Cloud instance with Atlas Search enabled. MongoDB 7.0+ is recommended.
-
-```typescript
-import { MongoDBStore } from "@mastra/mongodb";
-
-const storage = new MongoDBStore({
-  id: 'mongodb-storage',
-  uri: process.env.MONGODB_URI,
-  dbName: process.env.MONGODB_DATABASE,
-});
-```
-
-## Parameters
-
-**id:** (`string`): Unique identifier for this storage instance.
-
-**uri:** (`string`): MongoDB connection string (e.g., mongodb+srv://user:password\@cluster.mongodb.net)
-
-**url?:** (`string`): Deprecated. Use uri instead. MongoDB connection string (supported for backward compatibility).
-
-**dbName:** (`string`): The name of the database you want the storage to use.
-
-**options?:** (`MongoClientOptions`): MongoDB client options for advanced configuration (SSL, connection pooling, etc.).
-
-> **Deprecation Notice:** The `url` parameter is deprecated but still supported for backward compatibility. Please use `uri` instead in all new code.
-
-## Constructor Examples
-
-You can instantiate `MongoDBStore` in the following ways:
-
-```ts
-import { MongoDBStore } from "@mastra/mongodb";
-
-// Basic connection without custom options
-const store1 = new MongoDBStore({
-  id: 'mongodb-storage-01',
-  uri: "mongodb+srv://user:password@cluster.mongodb.net",
-  dbName: "mastra_storage",
-});
-
-// Using connection string with options
-const store2 = new MongoDBStore({
-  id: 'mongodb-storage-02',
-  uri: "mongodb+srv://user:password@cluster.mongodb.net",
-  dbName: "mastra_storage",
-  options: {
-    retryWrites: true,
-    maxPoolSize: 10,
-    serverSelectionTimeoutMS: 5000,
-    socketTimeoutMS: 45000,
-  },
-});
-```
-
-## Additional Notes
-
-### Collection Management
-
-The storage implementation handles collection creation and management automatically. It creates the following collections:
-
-- `mastra_workflow_snapshot`: Stores workflow state and execution data
-- `mastra_evals`: Stores evaluation results and metadata
-- `mastra_threads`: Stores conversation threads
-- `mastra_messages`: Stores individual messages
-- `mastra_traces`: Stores telemetry and tracing data
-- `mastra_scorers`: Stores scoring and evaluation data
-- `mastra_resources`: Stores resource working memory data
-
-### Initialization
-
-When you pass storage to the Mastra class, `init()` is called automatically before any storage operation:
-
-```typescript
-import { Mastra } from "@mastra/core";
-import { MongoDBStore } from "@mastra/mongodb";
-
-const storage = new MongoDBStore({
-  id: 'mongodb-storage',
-  uri: process.env.MONGODB_URI,
-  dbName: process.env.MONGODB_DATABASE,
-});
-
-const mastra = new Mastra({
-  storage, // init() is called automatically
-});
-```
-
-If you're using storage directly without Mastra, you must call `init()` explicitly to create the collections:
-
-```typescript
-import { MongoDBStore } from "@mastra/mongodb";
-
-const storage = new MongoDBStore({
-  id: 'mongodb-storage',
-  uri: process.env.MONGODB_URI,
-  dbName: process.env.MONGODB_DATABASE,
-});
-
-// Required when using storage directly
-await storage.init();
-
-// Access domain-specific stores via getStore()
-const memoryStore = await storage.getStore('memory');
-const thread = await memoryStore?.getThreadById({ threadId: "..." });
-```
-
-> **Warning:** If `init()` is not called, collections won't be created and storage operations will fail silently or throw errors.
-
-## Vector Search Capabilities
-
-MongoDB storage includes built-in vector search capabilities for AI applications:
-
-### Vector Index Creation
-
-```typescript
-import { MongoDBVector } from "@mastra/mongodb";
-
-const vectorStore = new MongoDBVector({
-  id: 'mongodb-vector',
-  uri: process.env.MONGODB_URI,
-  dbName: process.env.MONGODB_DATABASE,
-});
-
-// Create a vector index for embeddings
-await vectorStore.createIndex({
-  indexName: "document_embeddings",
-  dimension: 1536,
-});
-```
-
-### Vector Operations
-
-```typescript
-// Store vectors with metadata
-await vectorStore.upsert({
-  indexName: "document_embeddings",
-  vectors: [
-    {
-      id: "doc-1",
-      values: [0.1, 0.2, 0.3, ...], // 1536-dimensional vector
-      metadata: {
-        title: "Document Title",
-        category: "technical",
-        source: "api-docs",
-      },
-    },
-  ],
-});
-
-// Similarity search
-const results = await vectorStore.query({
-  indexName: "document_embeddings",
-  vector: queryEmbedding,
-  topK: 5,
-  filter: {
-    category: "technical",
-  },
-});
-```
-
-## Usage Example
-
-### Adding memory to an agent
-
-To add MongoDB memory to an agent use the `Memory` class and create a new `storage` key using `MongoDBStore`. The configuration supports both local and remote MongoDB instances.
-
-```typescript
-import { Memory } from "@mastra/memory";
-import { Agent } from "@mastra/core/agent";
-import { MongoDBStore } from "@mastra/mongodb";
-
-export const mongodbAgent = new Agent({
-  id: "mongodb-agent",
-  name: "mongodb-agent",
-  instructions:
-    "You are an AI agent with the ability to automatically recall memories from previous interactions.",
-  model: "openai/gpt-5.1",
-  memory: new Memory({
-    storage: new MongoDBStore({
-      uri: process.env.MONGODB_URI!,
-      dbName: process.env.MONGODB_DB_NAME!,
-    }),
-    options: {
-      generateTitle: true,
-    },
-  }),
-});
-```
-
-### Using the agent
-
-Use `memoryOptions` to scope recall for this request. Set `lastMessages: 5` to limit recency-based recall, and use `semanticRecall` to fetch the `topK: 3` most relevant messages, including `messageRange: 2` neighboring messages for context around each match.
-
-```typescript
-import "dotenv/config";
-
-import { mastra } from "./mastra";
-
-const threadId = "123";
-const resourceId = "user-456";
-
-const agent = mastra.getAgent("mongodbAgent");
-
-const message = await agent.stream("My name is Mastra", {
-  memory: {
-    thread: threadId,
-    resource: resourceId,
-  },
-});
-
-await message.textStream.pipeTo(new WritableStream());
-
-const stream = await agent.stream("What's my name?", {
-  memory: {
-    thread: threadId,
-    resource: resourceId,
-  },
-  memoryOptions: {
-    lastMessages: 5,
-    semanticRecall: {
-      topK: 3,
-      messageRange: 2,
-    },
-  },
-});
-
-for await (const chunk of stream.textStream) {
-  process.stdout.write(chunk);
-}
-```