@mastra/pg 0.17.3 → 0.17.4

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # @mastra/pg
 
+## 0.17.4
+
+### Patch Changes
+
+- Add configuration documentation and tests for PgVector and PostgresStore, including examples for connection methods, SSL configuration, and pool options ([#8723](https://github.com/mastra-ai/mastra/pull/8723))
+
+- Updated dependencies [[`ca85c93`](https://github.com/mastra-ai/mastra/commit/ca85c932b232e6ad820c811ec176d98e68c59b0a), [`a1d40f8`](https://github.com/mastra-ai/mastra/commit/a1d40f88d4ce42c4508774ad22e38ac582157af2), [`01c4a25`](https://github.com/mastra-ai/mastra/commit/01c4a2506c514d5e861c004d3d2fb3791c6391f3), [`cce8aad`](https://github.com/mastra-ai/mastra/commit/cce8aad878a0dd98e5647680f3765caba0b1701c)]:
+  - @mastra/core@0.21.1
+
+## 0.17.4-alpha.0
+
+### Patch Changes
+
+- Add configuration documentation and tests for PgVector and PostgresStore, including examples for connection methods, SSL configuration, and pool options ([#8723](https://github.com/mastra-ai/mastra/pull/8723))
+
+- Updated dependencies [[`ca85c93`](https://github.com/mastra-ai/mastra/commit/ca85c932b232e6ad820c811ec176d98e68c59b0a), [`a1d40f8`](https://github.com/mastra-ai/mastra/commit/a1d40f88d4ce42c4508774ad22e38ac582157af2), [`01c4a25`](https://github.com/mastra-ai/mastra/commit/01c4a2506c514d5e861c004d3d2fb3791c6391f3), [`cce8aad`](https://github.com/mastra-ai/mastra/commit/cce8aad878a0dd98e5647680f3765caba0b1701c)]:
+  - @mastra/core@0.21.1-alpha.0
+
 ## 0.17.3
 
 ### Patch Changes

package/README.md

@@ -17,11 +17,53 @@ npm install @mastra/pg
 
 ### Vector Store
 
+#### Basic Configuration
+
+PgVector supports multiple connection methods:
+
+**1. Connection String (Recommended)**
+
 ```typescript
 import { PgVector } from '@mastra/pg';
 
-const vectorStore = new PgVector({ connectionString: 'postgresql://user:pass@localhost:5432/db' });
+const vectorStore = new PgVector({
+  connectionString: 'postgresql://user:pass@localhost:5432/db',
+});
+```
+
+**2. Host/Port/Database Configuration**
+
+```typescript
+const vectorStore = new PgVector({
+  host: 'localhost',
+  port: 5432,
+  database: 'mydb',
+  user: 'postgres',
+  password: 'password',
+});
+```
+
+> **Note:** PgVector also supports advanced configurations like Google Cloud SQL Connector via `pg.ClientConfig`.
 
+#### Advanced Options
+
+```typescript
+const vectorStore = new PgVector({
+  connectionString: 'postgresql://user:pass@localhost:5432/db',
+  schemaName: 'custom_schema', // Use custom schema (default: public)
+  max: 30, // Max pool connections (default: 20)
+  idleTimeoutMillis: 60000, // Idle timeout (default: 30000)
+  pgPoolOptions: {
+    // Additional pg pool options
+    connectionTimeoutMillis: 5000,
+    allowExitOnIdle: true,
+  },
+});
+```
+
+#### Usage Example
+
+```typescript
 // Create a new table with vector support
 await vectorStore.createIndex({
   indexName: 'my_vectors',
@@ -97,12 +139,40 @@ const messages = await store.getMessages('thread-123');
 
 ## Configuration
 
-The PostgreSQL store can be initialized with either:
+### Connection Methods
+
+Both `PgVector` and `PostgresStore` support multiple connection methods:
+
+1. **Connection String**
+
+   ```typescript
+   {
+     connectionString: 'postgresql://user:pass@localhost:5432/db';
+   }
+   ```
+
+2. **Host/Port/Database**
+   ```typescript
+   {
+     host: 'localhost',
+     port: 5432,
+     database: 'mydb',
+     user: 'postgres',
+     password: 'password'
+   }
+   ```
+
+> **Advanced:** Also supports `pg.ClientConfig` for use cases like Google Cloud SQL Connector with IAM authentication.
+
+### Optional Configuration
 
-- `connectionString`: PostgreSQL connection string (for vector store)
-- Configuration object with host, port, database, user, and password (for storage)
+- `schemaName`: Custom PostgreSQL schema (default: `public`)
+- `ssl`: Enable SSL or provide custom SSL options (`true` | `false` | `ConnectionOptions`)
+- `max`: Maximum pool connections (default: `20`)
+- `idleTimeoutMillis`: Idle connection timeout (default: `30000`)
+- `pgPoolOptions`: Additional pg pool options (PgVector only)
 
-Connection pool settings:
+### Default Connection Pool Settings
 
 - Maximum connections: 20
 - Idle timeout: 30 seconds

package/dist/storage/test-utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/storage/test-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAG5D,eAAO,MAAM,WAAW,EAAE,mBAMzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAA6H,CAAC;AAE3J,wBAAgB,OAAO,SA4ZtB"}
+{"version":3,"file":"test-utils.d.ts","sourceRoot":"","sources":["../../src/storage/test-utils.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAE,mBAAmB,EAAE,MAAM,kBAAkB,CAAC;AAG5D,eAAO,MAAM,WAAW,EAAE,mBAMzB,CAAC;AAEF,eAAO,MAAM,gBAAgB,QAA6H,CAAC;AAE3J,wBAAgB,OAAO,SA8dtB"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@mastra/pg",
-  "version": "0.17.3",
+  "version": "0.17.4",
   "description": "Postgres provider for Mastra - includes both vector and db storage capabilities",
   "type": "module",
   "main": "dist/index.js",
@@ -33,10 +33,10 @@
     "tsup": "^8.5.0",
     "typescript": "^5.8.3",
     "vitest": "^3.2.4",
-    "@internal/storage-test-utils": "0.0.45",
-    "@mastra/core": "0.21.0",
-    "@internal/types-builder": "0.0.24",
-    "@internal/lint": "0.0.49"
+    "@internal/lint": "0.0.50",
+    "@internal/storage-test-utils": "0.0.46",
+    "@mastra/core": "0.21.1",
+    "@internal/types-builder": "0.0.25"
   },
   "peerDependencies": {
     "@mastra/core": ">=0.20.1-0 <0.22.0-0"