@mastra/pg

PostgreSQL implementation for Mastra, providing both vector similarity search (using pgvector) and general storage capabilities with connection pooling and transaction support.

Installation

npm install @mastra/pg

Prerequisites

• PostgreSQL server with pgvector extension installed (if using vector store)
• PostgreSQL 11 or higher

Usage

Vector Store

import { PgVector } from '@mastra/pg';

const vectorStore = new PgVector({ connectionString: 'postgresql://user:pass@localhost:5432/db' });

// Create a new table with vector support
await vectorStore.createIndex({
  indexName: 'my_vectors',
  dimension: 1536,
  metric: 'cosine',
});

// Add vectors
const ids = await vectorStore.upsert({
  indexName: 'my_vectors',
  vectors: [[0.1, 0.2, ...], [0.3, 0.4, ...]],
  metadata: [{ text: 'doc1' }, { text: 'doc2' }],
});

// Query vectors
const results = await vectorStore.query({
  indexName: 'my_vectors',
  queryVector: [0.1, 0.2, ...],
  topK: 10, // topK
  filter: { text: 'doc1' }, // filter
  includeVector: false, // includeVector
  minScore: 0.5, // minScore
});

// Clean up
await vectorStore.disconnect();

Storage

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 by default
• Supports HNSW indexing with configurable parameters
• Supports flat indexing

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:

{
  $and: [{ age: { $gt: 25 } }, { tags: { $in: ['tag1', 'tag2'] } }];
}

Vector Store Methods

• createIndex({indexName, dimension, metric?, indexConfig?, defineIndex?}): 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
• defineIndex({indexName, metric?, indexConfig?}): Define an index
• 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
• PostgreSQL Documentation