@mastra/pg 0.1.0-alpha.2

package/CHANGELOG.md

@@ -0,0 +1,46 @@
+# @mastra/pg
+
+## 0.1.0-alpha.2
+
+### Minor Changes
+
+- c87eb4e: Combine PostgreSQL packages into `@mastra/pg`.
+
+  - Move and combine packages to `stores/pg`
+  - Reorganize source files into `src/vector` and `src/store`
+  - Add deprecation notices to old packages
+  - Update documentation and examples
+  - No breaking changes in functionality
+
+## 0.1.0-alpha.1
+
+### Major Changes
+
+- Combined @mastra/vector-pg and @mastra/store-pg into a single package
+- Unified configuration and connection handling
+- Updated documentation to cover both vector and storage capabilities
+
+### Previous Changes from @mastra/vector-pg
+
+#### 0.1.0-alpha.26
+
+- Updated dependencies [4d4f6b6]
+  - @mastra/core@0.2.0-alpha.92
+
+#### 0.1.0-alpha.25
+
+- a10b7a3: Implemented new filtering for vectorQueryTool and updated docs
+- Updated dependencies [d7d465a, 2017553, a10b7a3, 16e5b04]
+  - @mastra/core@0.2.0-alpha.91
+
+### Previous Changes from @mastra/store-pg
+
+#### 0.0.0-alpha.11
+
+- Updated dependencies [4d4f6b6]
+  - @mastra/core@0.2.0-alpha.92
+
+#### 0.0.0-alpha.10
+
+- Updated dependencies [d7d465a, 2017553, a10b7a3, 16e5b04]
+  - @mastra/core@0.2.0-alpha.91

package/LICENSE

@@ -0,0 +1,44 @@
+Elastic License 2.0 (ELv2)
+
+**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,155 @@
+# @mastra/pg
+
+PostgreSQL implementation for Mastra, providing both vector similarity search (using pgvector) and general storage capabilities with connection pooling and transaction support.
+
+## Installation
+
+```bash
+npm install @mastra/pg
+```
+
+## Prerequisites
+
+- PostgreSQL server with pgvector extension installed (if using vector store)
+- PostgreSQL 11 or higher
+
+## Usage
+
+### Vector Store
+
+```typescript
+import { PgVector } from '@mastra/pg';
+
+const vectorStore = new PgVector('postgresql://user:pass@localhost:5432/db');
+
+// Create a new table with vector support
+await vectorStore.createIndex('my_vectors', 1536, 'cosine');
+
+// Add vectors
+const ids = await vectorStore.upsert(
+  'my_vectors',
+  [[0.1, 0.2, ...], [0.3, 0.4, ...]],
+  [{ text: 'doc1' }, { text: 'doc2' }]
+);
+
+// Query vectors
+const results = await vectorStore.query(
+  'my_vectors',
+  [0.1, 0.2, ...],
+  10,              // topK
+  { text: 'doc1' }, // filter
+  false,           // includeVector
+  0.5              // minScore
+);
+
+// Clean up
+await vectorStore.disconnect();
+```
+
+### Storage
+
+```typescript
+import { PostgresStore } from '@mastra/pg';
+
+const store = new PostgresStore({
+  host: 'localhost',
+  port: 5432,
+  database: 'mastra',
+  user: 'postgres',
+  password: 'postgres'
+});
+
+// Create a thread
+await store.saveThread({
+  id: 'thread-123',
+  resourceId: 'resource-456',
+  title: 'My Thread',
+  metadata: { key: 'value' }
+});
+
+// Add messages to thread
+await store.saveMessages([{
+  id: 'msg-789',
+  threadId: 'thread-123',
+  role: 'user',
+  type: 'text',
+  content: [{ type: 'text', text: 'Hello' }]
+}]);
+
+// Query threads and messages
+const savedThread = await store.getThread('thread-123');
+const messages = await store.getMessages('thread-123');
+```
+
+## Configuration
+
+The PostgreSQL store can be initialized with either:
+
+- `connectionString`: PostgreSQL connection string (for vector store)
+- Configuration object with host, port, database, user, and password (for storage)
+
+Connection pool settings:
+
+- Maximum connections: 20
+- Idle timeout: 30 seconds
+- Connection timeout: 2 seconds
+
+## Features
+
+### Vector Store Features
+- Vector similarity search with cosine, euclidean, and dot product metrics
+- Advanced metadata filtering with MongoDB-like query syntax
+- Minimum score threshold for queries
+- Automatic UUID generation for vectors
+- Table management (create, list, describe, delete, truncate)
+- Uses pgvector's IVFFLAT indexing with 100 lists
+
+### Storage Features
+- Thread and message storage with JSON support
+- Atomic transactions for data consistency
+- Efficient batch operations
+- Rich metadata support
+- Timestamp tracking
+- Cascading deletes
+
+## Supported Filter Operators
+
+The following filter operators are supported for metadata queries:
+
+- Comparison: `$eq`, `$ne`, `$gt`, `$gte`, `$lt`, `$lte`
+- Logical: `$and`, `$or`
+- Array: `$in`, `$nin`
+- Text: `$regex`, `$like`
+
+Example filter:
+
+```typescript
+{
+  $and: [{ age: { $gt: 25 } }, { tags: { $in: ['tag1', 'tag2'] } }];
+}
+```
+
+## Vector Store Methods
+
+- `createIndex(indexName, dimension, metric?)`: Create a new table with vector support
+- `upsert(indexName, vectors, metadata?, ids?)`: Add or update vectors
+- `query(indexName, queryVector, topK?, filter?, includeVector?, minScore?)`: Search for similar vectors
+- `listIndexes()`: List all vector-enabled tables
+- `describeIndex(indexName)`: Get table statistics
+- `deleteIndex(indexName)`: Delete a table
+- `truncateIndex(indexName)`: Remove all data from a table
+- `disconnect()`: Close all database connections
+
+## Storage Methods
+
+- `saveThread(thread)`: Create or update a thread
+- `getThread(threadId)`: Get a thread by ID
+- `deleteThread(threadId)`: Delete a thread and its messages
+- `saveMessages(messages)`: Save multiple messages in a transaction
+- `getMessages(threadId)`: Get all messages for a thread
+- `deleteMessages(messageIds)`: Delete specific messages
+
+## Related Links
+
+- [pgvector Documentation](https://github.com/pgvector/pgvector)
+- [PostgreSQL Documentation](https://www.postgresql.org/docs/)

package/dist/index.d.ts

@@ -0,0 +1,82 @@
+import { Filter } from '@mastra/core/filter';
+import { MastraVector, QueryResult, IndexStats } from '@mastra/core/vector';
+import { StorageThreadType, MessageType } from '@mastra/core/memory';
+import { MastraStorage, TABLE_NAMES, StorageColumn, StorageGetMessagesArg } from '@mastra/core/storage';
+import { WorkflowRunState } from '@mastra/core/workflows';
+
+declare class PgVector extends MastraVector {
+    private pool;
+    constructor(connectionString: string);
+    transformFilter(filter?: Filter): Filter;
+    query(indexName: string, queryVector: number[], topK?: number, filter?: Filter, includeVector?: boolean, minScore?: number): Promise<QueryResult[]>;
+    upsert(indexName: string, vectors: number[][], metadata?: Record<string, any>[], ids?: string[]): Promise<string[]>;
+    createIndex(indexName: string, dimension: number, metric?: 'cosine' | 'euclidean' | 'dotproduct'): Promise<void>;
+    listIndexes(): Promise<string[]>;
+    describeIndex(indexName: string): Promise<IndexStats>;
+    deleteIndex(indexName: string): Promise<void>;
+    truncateIndex(indexName: string): Promise<void>;
+    disconnect(): Promise<void>;
+}
+
+type PostgresConfig = {
+    host: string;
+    port: number;
+    database: string;
+    user: string;
+    password: string;
+} | {
+    connectionString: string;
+};
+declare class PostgresStore extends MastraStorage {
+    private db;
+    private pgp;
+    constructor(config: PostgresConfig);
+    createTable({ tableName, schema, }: {
+        tableName: TABLE_NAMES;
+        schema: Record<string, StorageColumn>;
+    }): Promise<void>;
+    clearTable({ tableName }: {
+        tableName: TABLE_NAMES;
+    }): Promise<void>;
+    insert({ tableName, record }: {
+        tableName: TABLE_NAMES;
+        record: Record<string, any>;
+    }): Promise<void>;
+    load<R>({ tableName, keys }: {
+        tableName: TABLE_NAMES;
+        keys: Record<string, string>;
+    }): Promise<R | null>;
+    getThreadById({ threadId }: {
+        threadId: string;
+    }): Promise<StorageThreadType | null>;
+    getThreadsByResourceId({ resourceId }: {
+        resourceId: string;
+    }): Promise<StorageThreadType[]>;
+    saveThread({ thread }: {
+        thread: StorageThreadType;
+    }): Promise<StorageThreadType>;
+    updateThread({ id, title, metadata, }: {
+        id: string;
+        title: string;
+        metadata: Record<string, unknown>;
+    }): Promise<StorageThreadType>;
+    deleteThread({ threadId }: {
+        threadId: string;
+    }): Promise<void>;
+    getMessages<T = unknown>({ threadId, selectBy }: StorageGetMessagesArg): Promise<T>;
+    saveMessages({ messages }: {
+        messages: MessageType[];
+    }): Promise<MessageType[]>;
+    persistWorkflowSnapshot({ workflowName, runId, snapshot, }: {
+        workflowName: string;
+        runId: string;
+        snapshot: WorkflowRunState;
+    }): Promise<void>;
+    loadWorkflowSnapshot({ workflowName, runId, }: {
+        workflowName: string;
+        runId: string;
+    }): Promise<WorkflowRunState | null>;
+    close(): Promise<void>;
+}
+
+export { PgVector, type PostgresConfig, PostgresStore };