@mastra/lance 0.1.1-alpha.0

package/.turbo/turbo-build.log

@@ -0,0 +1,23 @@
+
+> @mastra/lance@0.1.1-alpha.0 build /home/runner/work/mastra/mastra/stores/lance
+> tsup src/index.ts --format esm,cjs --experimental-dts --clean --treeshake=smallest --splitting
+
+CLI Building entry: src/index.ts
+CLI Using tsconfig: tsconfig.json
+CLI tsup v8.5.0
+TSC Build start
+TSC ⚡️ Build success in 11991ms
+DTS Build start
+CLI Target: es2022
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/stores/lance/dist/_tsup-dts-rollup.d.ts
+Analysis will use the bundled TypeScript version 5.8.3
+Writing package typings: /home/runner/work/mastra/mastra/stores/lance/dist/_tsup-dts-rollup.d.cts
+DTS ⚡️ Build success in 13115ms
+CLI Cleaning output folder
+ESM Build start
+CJS Build start
+ESM dist/index.js 52.70 KB
+ESM ⚡️ Build success in 1414ms
+CJS dist/index.cjs 52.99 KB
+CJS ⚡️ Build success in 1414ms

package/CHANGELOG.md

@@ -0,0 +1,13 @@
+# @mastra/lance
+
+## 0.1.1-alpha.0
+
+### Patch Changes
+
+- dffb67b: updated stores to add alter table and change tests
+- f7f8293: Added LanceDB implementations for MastraVector and MastraStorage
+- Updated dependencies [f6fd25f]
+- Updated dependencies [dffb67b]
+- Updated dependencies [f1309d3]
+- Updated dependencies [f7f8293]
+  - @mastra/core@0.10.4-alpha.1

package/LICENSE.md

@@ -0,0 +1,46 @@
+# Elastic License 2.0 (ELv2)
+
+Copyright (c) 2025 Mastra AI, Inc.
+
+**Acceptance**
+By using the software, you agree to all of the terms and conditions below.
+
+**Copyright License**
+The licensor grants you a non-exclusive, royalty-free, worldwide, non-sublicensable, non-transferable license to use, copy, distribute, make available, and prepare derivative works of the software, in each case subject to the limitations and conditions below
+
+**Limitations**
+You may not provide the software to third parties as a hosted or managed service, where the service provides users with access to any substantial set of the features or functionality of the software.
+
+You may not move, change, disable, or circumvent the license key functionality in the software, and you may not remove or obscure any functionality in the software that is protected by the license key.
+
+You may not alter, remove, or obscure any licensing, copyright, or other notices of the licensor in the software. Any use of the licensor’s trademarks is subject to applicable law.
+
+**Patents**
+The licensor grants you a license, under any patent claims the licensor can license, or becomes able to license, to make, have made, use, sell, offer for sale, import and have imported the software, in each case subject to the limitations and conditions in this license. This license does not cover any patent claims that you cause to be infringed by modifications or additions to the software. If you or your company make any written claim that the software infringes or contributes to infringement of any patent, your patent license for the software granted under these terms ends immediately. If your company makes such a claim, your patent license ends immediately for work on behalf of your company.
+
+**Notices**
+You must ensure that anyone who gets a copy of any part of the software from you also gets a copy of these terms.
+
+If you modify the software, you must include in any modified copies of the software prominent notices stating that you have modified the software.
+
+**No Other Rights**
+These terms do not imply any licenses other than those expressly granted in these terms.
+
+**Termination**
+If you use the software in violation of these terms, such use is not licensed, and your licenses will automatically terminate. If the licensor provides you with a notice of your violation, and you cease all violation of this license no later than 30 days after you receive that notice, your licenses will be reinstated retroactively. However, if you violate these terms after such reinstatement, any additional violation of these terms will cause your licenses to terminate automatically and permanently.
+
+**No Liability**
+As far as the law allows, the software comes as is, without any warranty or condition, and the licensor will not be liable to you for any damages arising out of these terms or the use or nature of the software, under any kind of legal claim.
+
+**Definitions**
+The _licensor_ is the entity offering these terms, and the _software_ is the software the licensor makes available under these terms, including any portion of it.
+
+_you_ refers to the individual or entity agreeing to these terms.
+
+_your company_ is any legal entity, sole proprietorship, or other kind of organization that you work for, plus all organizations that have control over, are under the control of, or are under common control with that organization. _control_ means ownership of substantially all the assets of an entity, or the power to direct its management and policies by vote, contract, or otherwise. Control can be direct or indirect.
+
+_your licenses_ are all the licenses granted to you for the software under these terms.
+
+_use_ means anything you do with the software requiring one of your licenses.
+
+_trademark_ means trademarks, service marks, and similar rights.

package/README.md

@@ -0,0 +1,263 @@
+# Mastra LanceDB Storage & Vector Usage Guide
+
+This guide explains how to use LanceDB as both a storage backend and vector database with Mastra. LanceDB provides a high-performance, open-source, and embeddable vector database built on [Lance](https://github.com/eto-ai/lance) file format.
+
+## Installation
+
+```bash
+pnpm add @mastra/lance @lancedb/lancedb apache-arrow
+```
+
+## Setup & Configuration
+
+### Basic Setup
+
+```typescript
+import { LanceStorage } from '@mastra/lance';
+import { Mastra } from '@mastra/core/mastra';
+
+// Initialize LanceStorage
+const storage = await LanceStorage.create(
+  'myApp', // Name for your storage instance
+  'path/to/db', // Path to database directory
+);
+
+// Configure Mastra with LanceStorage
+const mastra = new Mastra({
+  storage: storage,
+});
+```
+
+### Connection Options
+
+LanceStorage supports multiple connection configurations:
+
+```typescript
+// Local database
+const localStore = await LanceStorage.create('myApp', '/path/to/db');
+
+// LanceDB Cloud
+const cloudStore = await LanceStorage.create('myApp', 'db://host:port');
+
+// S3 bucket
+const s3Store = await LanceStorage.create('myApp', 's3://bucket/db', { storageOptions: { timeout: '60s' } });
+```
+
+## Basic Operations
+
+### Creating Tables
+
+```typescript
+import { TABLE_MESSAGES } from '@mastra/core/storage';
+import type { StorageColumn } from '@mastra/core/storage';
+
+// Define schema with appropriate types
+const schema: Record<string, StorageColumn> = {
+  id: { type: 'uuid', nullable: false },
+  threadId: { type: 'uuid', nullable: false },
+  content: { type: 'text', nullable: true },
+  createdAt: { type: 'timestamp', nullable: false },
+  metadata: { type: 'jsonb', nullable: true },
+};
+
+// Create table
+await storage.createTable({
+  tableName: TABLE_MESSAGES,
+  schema,
+});
+```
+
+### Inserting Records
+
+```typescript
+// Insert a single record
+await storage.insert({
+  tableName: TABLE_MESSAGES,
+  record: {
+    id: '123e4567-e89b-12d3-a456-426614174000',
+    threadId: '123e4567-e89b-12d3-a456-426614174001',
+    content: 'Hello, world!',
+    createdAt: new Date(),
+    metadata: { tags: ['important', 'greeting'] },
+  },
+});
+
+// Batch insert multiple records
+await storage.batchInsert({
+  tableName: TABLE_MESSAGES,
+  records: [
+    {
+      id: '123e4567-e89b-12d3-a456-426614174002',
+      threadId: '123e4567-e89b-12d3-a456-426614174001',
+      content: 'First message',
+      createdAt: new Date(),
+      metadata: { priority: 'high' },
+    },
+    {
+      id: '123e4567-e89b-12d3-a456-426614174003',
+      threadId: '123e4567-e89b-12d3-a456-426614174001',
+      content: 'Second message',
+      createdAt: new Date(),
+      metadata: { priority: 'low' },
+    },
+  ],
+});
+```
+
+### Querying Data
+
+```typescript
+// Load a record by id
+const message = await storage.load({
+  tableName: TABLE_MESSAGES,
+  keys: { id: '123e4567-e89b-12d3-a456-426614174000' },
+});
+
+// Load messages from a thread
+const messages = await storage.getMessages({
+  threadId: '123e4567-e89b-12d3-a456-426614174001',
+});
+```
+
+## Working with Threads & Messages
+
+### Creating Threads
+
+```typescript
+import type { StorageThreadType } from '@mastra/core';
+
+// Create a new thread
+const thread: StorageThreadType = {
+  id: '123e4567-e89b-12d3-a456-426614174010',
+  resourceId: 'resource-123',
+  title: 'New Discussion',
+  createdAt: new Date(),
+  metadata: { topic: 'technical-support' },
+};
+
+// Save the thread
+const savedThread = await storage.saveThread({ thread });
+```
+
+### Working with Messages
+
+```typescript
+import type { MessageType } from '@mastra/core';
+
+// Create messages
+const messages: MessageType[] = [
+  {
+    id: 'msg-001',
+    threadId: '123e4567-e89b-12d3-a456-426614174010',
+    resourceId: 'resource-123',
+    role: 'user',
+    content: 'How can I use LanceDB with Mastra?',
+    createdAt: new Date(),
+    type: 'text',
+    toolCallIds: [],
+    toolCallArgs: [],
+    toolNames: [],
+  },
+  {
+    id: 'msg-002',
+    threadId: '123e4567-e89b-12d3-a456-426614174010',
+    resourceId: 'resource-123',
+    role: 'assistant',
+    content: 'You can use LanceDB with Mastra by installing @mastra/lance package.',
+    createdAt: new Date(),
+    type: 'text',
+    toolCallIds: [],
+    toolCallArgs: [],
+    toolNames: [],
+  },
+];
+
+// Save messages
+await storage.saveMessages({ messages });
+
+// Retrieve messages with context
+const retrievedMessages = await storage.getMessages({
+  threadId: '123e4567-e89b-12d3-a456-426614174010',
+  selectBy: [
+    {
+      id: 'msg-001',
+      withPreviousMessages: 5, // Include up to 5 messages before this one
+      withNextMessages: 5, // Include up to 5 messages after this one
+    },
+  ],
+});
+```
+
+## Working with Workflows
+
+Mastra's workflow system uses LanceDB to persist workflow state for continuity across runs:
+
+```typescript
+import type { WorkflowRunState } from '@mastra/core';
+
+// Persist a workflow snapshot
+await storage.persistWorkflowSnapshot({
+  workflowName: 'documentProcessing',
+  runId: 'run-123',
+  snapshot: {
+    context: {
+      steps: {
+        step1: { status: 'success', payload: { data: 'processed' } },
+        step2: { status: 'waiting' },
+      },
+      triggerData: { documentId: 'doc-123' },
+      attempts: { step1: 1, step2: 0 },
+    },
+  } as WorkflowRunState,
+});
+
+// Load a workflow snapshot
+const workflowState = await storage.loadWorkflowSnapshot({
+  workflowName: 'documentProcessing',
+  runId: 'run-123',
+});
+```
+
+## Using Lance for Vector Storage
+
+The LanceDB integration in Mastra can be used for both traditional storage and vector search:
+
+```typescript
+// Create a schema with vector field
+const vectorSchema: Record<string, StorageColumn> = {
+  id: { type: 'uuid', nullable: false },
+  content: { type: 'text', nullable: true },
+  embedding: { type: 'binary', nullable: false }, // Vector embedding
+  metadata: { type: 'jsonb', nullable: true },
+};
+
+// Create a vector table
+await storage.createTable({
+  tableName: 'vector_store',
+  schema: vectorSchema,
+});
+
+// Insert a vector with content and metadata
+await storage.insert({
+  tableName: 'vector_store',
+  record: {
+    id: 'vec-001',
+    content: 'This is a document about LanceDB and Mastra integration',
+    embedding: new Float32Array([0.1, 0.2, 0.3, 0.4]), // Your embedding vector
+    metadata: { source: 'documentation', category: 'integration' },
+  },
+});
+```
+
+## Data Management
+
+```typescript
+// Drop a table
+await storage.dropTable(TABLE_MESSAGES);
+
+// Clear all records from a table
+await storage.clearTable({ tableName: TABLE_MESSAGES });
+
+// Get table schema
+const schema = await storage.getTableSchema(TABLE_MESSAGES);
+```