@mastra/pg 1.7.1 → 1.7.2-alpha.0

package/dist/docs/references/reference-vectors-pg.md

@@ -4,27 +4,27 @@ The PgVector class provides vector search using [PostgreSQL](https://www.postgre
 
 ## Constructor Options
 
-**connectionString?:** (`string`): PostgreSQL connection URL
+**connectionString** (`string`): PostgreSQL connection URL
 
-**host?:** (`string`): PostgreSQL server host
+**host** (`string`): PostgreSQL server host
 
-**port?:** (`number`): PostgreSQL server port
+**port** (`number`): PostgreSQL server port
 
-**database?:** (`string`): PostgreSQL database name
+**database** (`string`): PostgreSQL database name
 
-**user?:** (`string`): PostgreSQL user
+**user** (`string`): PostgreSQL user
 
-**password?:** (`string`): PostgreSQL password
+**password** (`string`): PostgreSQL password
 
-**ssl?:** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
+**ssl** (`boolean | ConnectionOptions`): Enable SSL or provide custom SSL configuration
 
-**schemaName?:** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
+**schemaName** (`string`): The name of the schema you want the vector store to use. Will use the default schema if not provided.
 
-**max?:** (`number`): Maximum number of pool connections (default: 20)
+**max** (`number`): Maximum number of pool connections (default: 20)
 
-**idleTimeoutMillis?:** (`number`): Idle connection timeout in milliseconds (default: 30000)
+**idleTimeoutMillis** (`number`): Idle connection timeout in milliseconds (default: 30000)
 
-**pgPoolOptions?:** (`PoolConfig`): Additional pg pool configuration options
+**pgPoolOptions** (`PoolConfig`): Additional pg pool configuration options
 
 ## Constructor Examples
 
@@ -72,23 +72,35 @@ const vectorStore = new PgVector({
 
 ### createIndex()
 
-**indexName:** (`string`): Name of the index to create
+**indexName** (`string`): Name of the index to create
 
-**dimension:** (`number`): Vector dimension (must match your embedding model)
+**dimension** (`number`): Vector dimension (must match your embedding model)
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig?:** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
+**indexConfig** (`IndexConfig`): Index configuration (Default: `{ type: 'ivfflat' }`)
 
-**buildIndex?:** (`boolean`): Whether to build the index (Default: `true`)
+**buildIndex** (`boolean`): Whether to build the index (Default: `true`)
 
 #### IndexConfig
 
-**type:** (`'flat' | 'hnsw' | 'ivfflat'`): stringflat:flatSequential scan (no index) that performs exhaustive search.ivfflat:ivfflatClusters vectors into lists for approximate search.hnsw:hnswGraph-based index offering fast search times and high recall. (Default: `ivfflat`)
+**type** (`'flat' | 'hnsw' | 'ivfflat'`): Index type (Default: `ivfflat`)
 
-**ivf?:** (`IVFConfig`): objectlists?:numberNumber of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+**type.flat** (`flat`): Sequential scan (no index) that performs exhaustive search.
 
-**hnsw?:** (`HNSWConfig`): objectm?:numberMaximum number of connections per node (default: 8)efConstruction?:numberBuild-time complexity (default: 32)
+**type.ivfflat** (`ivfflat`): Clusters vectors into lists for approximate search.
+
+**type.hnsw** (`hnsw`): Graph-based index offering fast search times and high recall.
+
+**ivf** (`IVFConfig`): IVF configuration
+
+**ivf.lists** (`number`): Number of lists. If not specified, automatically calculated based on dataset size. (Minimum 100, Maximum 4000)
+
+**hnsw** (`HNSWConfig`): HNSW configuration
+
+**hnsw\.m** (`number`): Maximum number of connections per node (default: 8)
+
+**hnsw\.efConstruction** (`number`): Build-time complexity (default: 32)
 
 #### Memory Requirements
 
@@ -102,29 +114,33 @@ Higher M values or efConstruction values will increase memory requirements signi
 
 ### upsert()
 
-**indexName:** (`string`): Name of the index to upsert vectors into
+**indexName** (`string`): Name of the index to upsert vectors into
 
-**vectors:** (`number[][]`): Array of embedding vectors
+**vectors** (`number[][]`): Array of embedding vectors
 
-**metadata?:** (`Record<string, any>[]`): Metadata for each vector
+**metadata** (`Record<string, any>[]`): Metadata for each vector
 
-**ids?:** (`string[]`): Optional vector IDs (auto-generated if not provided)
+**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
 
 ### query()
 
-**indexName:** (`string`): Name of the index to query
+**indexName** (`string`): Name of the index to query
+
+**queryVector** (`number[]`): Query vector
+
+**topK** (`number`): Number of results to return (Default: `10`)
 
-**queryVector:** (`number[]`): Query vector
+**filter** (`Record<string, any>`): Metadata filters
 
-**topK?:** (`number`): Number of results to return (Default: `10`)
+**includeVector** (`boolean`): Whether to include the vector in the result (Default: `false`)
 
-**filter?:** (`Record<string, any>`): Metadata filters
+**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
 
-**includeVector?:** (`boolean`): Whether to include the vector in the result (Default: `false`)
+**options** (`{ ef?: number; probes?: number }`): Additional options for HNSW and IVF indexes
 
-**minScore?:** (`number`): Minimum similarity score threshold (Default: `0`)
+**options.ef** (`number`): HNSW search parameter
 
-**options?:** (`{ ef?: number; probes?: number }`): objectef?:numberHNSW search parameterprobes?:numberIVF search parameter
+**options.probes** (`number`): IVF search parameter
 
 ### listIndexes()
 
@@ -132,7 +148,7 @@ Returns an array of index names as strings.
 
 ### describeIndex()
 
-**indexName:** (`string`): Name of the index to describe
+**indexName** (`string`): Name of the index to describe
 
 Returns:
 
@@ -153,19 +169,19 @@ interface PGIndexStats {
 
 ### deleteIndex()
 
-**indexName:** (`string`): Name of the index to delete
+**indexName** (`string`): Name of the index to delete
 
 ### updateVector()
 
 Update a single vector by ID or by metadata filter. Either `id` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id?:** (`string`): ID of the vector to update (mutually exclusive with filter)
+**id** (`string`): ID of the vector to update (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
+**filter** (`Record<string, any>`): Metadata filter to identify vector(s) to update (mutually exclusive with id)
 
-**update:** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
+**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
 
 Updates an existing vector by ID or filter. At least one of vector or metadata must be provided in the update object.
 
@@ -192,9 +208,9 @@ await pgVector.updateVector({
 
 ### deleteVector()
 
-**indexName:** (`string`): Name of the index containing the vector
+**indexName** (`string`): Name of the index containing the vector
 
-**id:** (`string`): ID of the vector to delete
+**id** (`string`): ID of the vector to delete
 
 Deletes a single vector by ID from the specified index.
 
@@ -206,11 +222,11 @@ await pgVector.deleteVector({ indexName: 'my_vectors', id: 'vector123' })
 
 Delete multiple vectors by IDs or by metadata filter. Either `ids` or `filter` must be provided, but not both.
 
-**indexName:** (`string`): Name of the index containing the vectors to delete
+**indexName** (`string`): Name of the index containing the vectors to delete
 
-**ids?:** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
+**ids** (`string[]`): Array of vector IDs to delete (mutually exclusive with filter)
 
-**filter?:** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
+**filter** (`Record<string, any>`): Metadata filter to identify vectors to delete (mutually exclusive with ids)
 
 ### disconnect()
 
@@ -218,11 +234,11 @@ Closes the database connection pool. Should be called when done using the store.
 
 ### buildIndex()
 
-**indexName:** (`string`): Name of the index to define
+**indexName** (`string`): Name of the index to define
 
-**metric?:** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
+**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
 
-**indexConfig:** (`IndexConfig`): Configuration for the index type and parameters
+**indexConfig** (`IndexConfig`): Configuration for the index type and parameters
 
 Builds or rebuilds an index with specified metric and configuration. Will drop any existing index before creating the new one.
 

package/dist/index.cjs

@@ -5187,6 +5187,10 @@ var ExperimentsPG = class _ExperimentsPG extends storage.ExperimentsStorage {
         setClauses.push(`"failedCount" = $${paramIndex++}`);
         values.push(input.failedCount);
       }
+      if (input.totalItems !== void 0) {
+        setClauses.push(`"totalItems" = $${paramIndex++}`);
+        values.push(input.totalItems);
+      }
       if (input.skippedCount !== void 0) {
         setClauses.push(`"skippedCount" = $${paramIndex++}`);
         values.push(input.skippedCount);