@mastra/pg 1.0.0-beta.1 → 1.0.0-beta.11
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +548 -0
- package/README.md +3 -0
- package/dist/index.cjs +3239 -2110
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.ts +1 -1
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +3232 -2108
- package/dist/index.js.map +1 -1
- package/dist/shared/config.d.ts +121 -31
- package/dist/shared/config.d.ts.map +1 -1
- package/dist/storage/client.d.ts +91 -0
- package/dist/storage/client.d.ts.map +1 -0
- package/dist/storage/db/index.d.ts +170 -0
- package/dist/storage/db/index.d.ts.map +1 -0
- package/dist/storage/domains/agents/index.d.ts +39 -0
- package/dist/storage/domains/agents/index.d.ts.map +1 -0
- package/dist/storage/domains/memory/index.d.ts +30 -11
- package/dist/storage/domains/memory/index.d.ts.map +1 -1
- package/dist/storage/domains/observability/index.d.ts +29 -36
- package/dist/storage/domains/observability/index.d.ts.map +1 -1
- package/dist/storage/domains/scores/index.d.ts +26 -29
- package/dist/storage/domains/scores/index.d.ts.map +1 -1
- package/dist/storage/domains/utils.d.ts +1 -5
- package/dist/storage/domains/utils.d.ts.map +1 -1
- package/dist/storage/domains/workflows/index.d.ts +30 -19
- package/dist/storage/domains/workflows/index.d.ts.map +1 -1
- package/dist/storage/index.d.ts +51 -195
- package/dist/storage/index.d.ts.map +1 -1
- package/dist/storage/performance-indexes/performance-test.d.ts +3 -1
- package/dist/storage/performance-indexes/performance-test.d.ts.map +1 -1
- package/dist/storage/test-utils.d.ts.map +1 -1
- package/dist/vector/index.d.ts +42 -6
- package/dist/vector/index.d.ts.map +1 -1
- package/dist/vector/sql-builder.d.ts +4 -0
- package/dist/vector/sql-builder.d.ts.map +1 -1
- package/dist/vector/types.d.ts +10 -0
- package/dist/vector/types.d.ts.map +1 -1
- package/package.json +6 -8
- package/dist/storage/domains/operations/index.d.ts +0 -119
- package/dist/storage/domains/operations/index.d.ts.map +0 -1
package/dist/vector/index.d.ts
CHANGED
|
@@ -1,11 +1,17 @@
|
|
|
1
1
|
import { MastraVector } from '@mastra/core/vector';
|
|
2
|
-
import type { IndexStats, QueryResult, QueryVectorParams, CreateIndexParams, UpsertVectorParams, DescribeIndexParams, DeleteIndexParams, DeleteVectorParams, UpdateVectorParams } from '@mastra/core/vector';
|
|
2
|
+
import type { IndexStats, QueryResult, QueryVectorParams, CreateIndexParams, UpsertVectorParams, DescribeIndexParams, DeleteIndexParams, DeleteVectorParams, DeleteVectorsParams, UpdateVectorParams } from '@mastra/core/vector';
|
|
3
3
|
import * as pg from 'pg';
|
|
4
4
|
import type { PgVectorConfig } from '../shared/config.js';
|
|
5
5
|
import type { PGVectorFilter } from './filter.js';
|
|
6
|
-
import type { IndexConfig, IndexType } from './types.js';
|
|
6
|
+
import type { IndexConfig, IndexType, VectorType } from './types.js';
|
|
7
7
|
export interface PGIndexStats extends IndexStats {
|
|
8
8
|
type: IndexType;
|
|
9
|
+
/**
|
|
10
|
+
* The pgvector storage type used for this index.
|
|
11
|
+
* - 'vector': Full precision (4 bytes per dimension)
|
|
12
|
+
* - 'halfvec': Half precision (2 bytes per dimension)
|
|
13
|
+
*/
|
|
14
|
+
vectorType: VectorType;
|
|
9
15
|
config: {
|
|
10
16
|
m?: number;
|
|
11
17
|
efConstruction?: number;
|
|
@@ -29,22 +35,33 @@ interface PgQueryVectorParams extends QueryVectorParams<PGVectorFilter> {
|
|
|
29
35
|
interface PgCreateIndexParams extends CreateIndexParams {
|
|
30
36
|
indexConfig?: IndexConfig;
|
|
31
37
|
buildIndex?: boolean;
|
|
38
|
+
/**
|
|
39
|
+
* The pgvector storage type for embeddings.
|
|
40
|
+
* - 'vector': Full precision (4 bytes per dimension), max 2000 dimensions for indexes (default)
|
|
41
|
+
* - 'halfvec': Half precision (2 bytes per dimension), max 4000 dimensions for indexes
|
|
42
|
+
*
|
|
43
|
+
* Use 'halfvec' for large dimension models like text-embedding-3-large (3072 dimensions)
|
|
44
|
+
*/
|
|
45
|
+
vectorType?: VectorType;
|
|
32
46
|
}
|
|
33
47
|
interface PgDefineIndexParams {
|
|
34
48
|
indexName: string;
|
|
35
49
|
metric: 'cosine' | 'euclidean' | 'dotproduct';
|
|
36
50
|
indexConfig: IndexConfig;
|
|
51
|
+
vectorType?: VectorType;
|
|
37
52
|
}
|
|
38
53
|
export declare class PgVector extends MastraVector<PGVectorFilter> {
|
|
39
54
|
pool: pg.Pool;
|
|
40
55
|
private describeIndexCache;
|
|
41
56
|
private createdIndexes;
|
|
57
|
+
private indexVectorTypes;
|
|
42
58
|
private mutexesByName;
|
|
43
59
|
private schema?;
|
|
44
60
|
private setupSchemaPromise;
|
|
45
61
|
private installVectorExtensionPromise;
|
|
46
62
|
private vectorExtensionInstalled;
|
|
47
63
|
private vectorExtensionSchema;
|
|
64
|
+
private vectorExtensionVersion;
|
|
48
65
|
private schemaSetupComplete;
|
|
49
66
|
private cacheWarmupPromise;
|
|
50
67
|
constructor(config: PgVectorConfig & {
|
|
@@ -52,24 +69,35 @@ export declare class PgVector extends MastraVector<PGVectorFilter> {
|
|
|
52
69
|
});
|
|
53
70
|
private getMutexByName;
|
|
54
71
|
/**
|
|
55
|
-
* Detects which schema contains the vector extension
|
|
72
|
+
* Detects which schema contains the vector extension and its version
|
|
56
73
|
*/
|
|
57
74
|
private detectVectorExtensionSchema;
|
|
75
|
+
/**
|
|
76
|
+
* Checks if the installed pgvector version supports halfvec type.
|
|
77
|
+
* halfvec was introduced in pgvector 0.7.0.
|
|
78
|
+
*/
|
|
79
|
+
private supportsHalfvec;
|
|
58
80
|
/**
|
|
59
81
|
* Gets the properly qualified vector type name
|
|
82
|
+
* @param vectorType - The type of vector storage ('vector' or 'halfvec')
|
|
60
83
|
*/
|
|
61
84
|
private getVectorTypeName;
|
|
85
|
+
/**
|
|
86
|
+
* Gets the operator class for index creation based on metric and vector type.
|
|
87
|
+
* pgvector uses different operator classes for vector vs halfvec types.
|
|
88
|
+
*/
|
|
89
|
+
private getMetricOperatorClass;
|
|
62
90
|
private getTableName;
|
|
63
91
|
private getSchemaName;
|
|
64
92
|
transformFilter(filter?: PGVectorFilter): PGVectorFilter;
|
|
65
93
|
getIndexInfo({ indexName }: DescribeIndexParams): Promise<PGIndexStats>;
|
|
66
94
|
query({ indexName, queryVector, topK, filter, includeVector, minScore, ef, probes, }: PgQueryVectorParams): Promise<QueryResult[]>;
|
|
67
|
-
upsert({ indexName, vectors, metadata, ids }: UpsertVectorParams): Promise<string[]>;
|
|
95
|
+
upsert({ indexName, vectors, metadata, ids, deleteFilter, }: UpsertVectorParams<PGVectorFilter>): Promise<string[]>;
|
|
68
96
|
private hasher;
|
|
69
97
|
private getIndexCacheKey;
|
|
70
98
|
private cachedIndexExists;
|
|
71
99
|
private setupSchema;
|
|
72
|
-
createIndex({ indexName, dimension, metric, indexConfig, buildIndex, }: PgCreateIndexParams): Promise<void>;
|
|
100
|
+
createIndex({ indexName, dimension, metric, indexConfig, buildIndex, vectorType, }: PgCreateIndexParams): Promise<void>;
|
|
73
101
|
buildIndex({ indexName, metric, indexConfig }: PgDefineIndexParams): Promise<void>;
|
|
74
102
|
private setupIndex;
|
|
75
103
|
private installVectorExtension;
|
|
@@ -94,7 +122,7 @@ export declare class PgVector extends MastraVector<PGVectorFilter> {
|
|
|
94
122
|
* @returns A promise that resolves when the update is complete.
|
|
95
123
|
* @throws Will throw an error if no updates are provided or if the update operation fails.
|
|
96
124
|
*/
|
|
97
|
-
updateVector({ indexName, id, update }: UpdateVectorParams): Promise<void>;
|
|
125
|
+
updateVector({ indexName, id, filter, update }: UpdateVectorParams<PGVectorFilter>): Promise<void>;
|
|
98
126
|
/**
|
|
99
127
|
* Deletes a vector by its ID.
|
|
100
128
|
* @param indexName - The name of the index containing the vector.
|
|
@@ -103,6 +131,14 @@ export declare class PgVector extends MastraVector<PGVectorFilter> {
|
|
|
103
131
|
* @throws Will throw an error if the deletion operation fails.
|
|
104
132
|
*/
|
|
105
133
|
deleteVector({ indexName, id }: DeleteVectorParams): Promise<void>;
|
|
134
|
+
/**
|
|
135
|
+
* Delete vectors matching a metadata filter.
|
|
136
|
+
* @param indexName - The name of the index containing the vectors.
|
|
137
|
+
* @param filter - The filter to match vectors for deletion.
|
|
138
|
+
* @returns A promise that resolves when the deletion is complete.
|
|
139
|
+
* @throws Will throw an error if the deletion operation fails.
|
|
140
|
+
*/
|
|
141
|
+
deleteVectors({ indexName, filter, ids }: DeleteVectorsParams<PGVectorFilter>): Promise<void>;
|
|
106
142
|
}
|
|
107
143
|
export {};
|
|
108
144
|
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vector/index.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/vector/index.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,YAAY,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EACV,UAAU,EACV,WAAW,EACX,iBAAiB,EACjB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,iBAAiB,EACjB,kBAAkB,EAClB,mBAAmB,EACnB,kBAAkB,EACnB,MAAM,qBAAqB,CAAC;AAE7B,OAAO,KAAK,EAAE,MAAM,IAAI,CAAC;AAIzB,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAC;AAEvD,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAE/C,OAAO,KAAK,EAAE,WAAW,EAAE,SAAS,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AAElE,MAAM,WAAW,YAAa,SAAQ,UAAU;IAC9C,IAAI,EAAE,SAAS,CAAC;IAChB;;;;OAIG;IACH,UAAU,EAAE,UAAU,CAAC;IACvB,MAAM,EAAE;QACN,CAAC,CAAC,EAAE,MAAM,CAAC;QACX,cAAc,CAAC,EAAE,MAAM,CAAC;QACxB,KAAK,CAAC,EAAE,MAAM,CAAC;QACf,MAAM,CAAC,EAAE,MAAM,CAAC;KACjB,CAAC;CACH;AAED,UAAU,mBAAoB,SAAQ,iBAAiB,CAAC,cAAc,CAAC;IACrE,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB;;;OAGG;IACH,EAAE,CAAC,EAAE,MAAM,CAAC;IACZ;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,UAAU,mBAAoB,SAAQ,iBAAiB;IACrD,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,UAAU,CAAC,EAAE,OAAO,CAAC;IACrB;;;;;;OAMG;IACH,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,UAAU,mBAAmB;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,QAAQ,GAAG,WAAW,GAAG,YAAY,CAAC;IAC9C,WAAW,EAAE,WAAW,CAAC;IACzB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,qBAAa,QAAS,SAAQ,YAAY,CAAC,cAAc,CAAC;IACjD,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC;IACrB,OAAO,CAAC,kBAAkB,CAAwC;IAClE,OAAO,CAAC,cAAc,CAA6B;IACnD,OAAO,CAAC,gBAAgB,CAAiC;IACzD,OAAO,CAAC,aAAa,CAA4B;IACjD,OAAO,CAAC,MAAM,CAAC,CAAS;IACxB,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,6BAA6B,CAA8B;IACnE,OAAO,CAAC,wBAAwB,CAAkC;IAClE,OAAO,CAAC,qBAAqB,CAAuB;IACpD,OAAO,CAAC,sBAAsB,CAAuB;IACrD,OAAO,CAAC,mBAAmB,CAAkC;IAC7D,OAAO,CAAC,kBAAkB,CAA8B;gBAE5C,MAAM,EAAE,cAAc,GAAG;QAAE,EAAE,EAAE,MAAM,CAAA;KAAE;IAqFnD,OAAO,CAAC,cAAc;IAKtB;;OAEG;YACW,2BAA2B;IA2BzC;;;OAGG;IACH,OAAO,CAAC,eAAe;IAgBvB;;;OAGG;IACH,OAAO,CAAC,iBAAiB;IAiBzB;;;OAGG;IACH,OAAO,CAAC,sBAAsB;IAc9B,OAAO,CAAC,YAAY;IAWpB,OAAO,CAAC,aAAa;IAIrB,eAAe,CAAC,MAAM,CAAC,EAAE,cAAc;IAKjC,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAOvE,KAAK,CAAC,EACV,SAAS,EACT,WAAW,EACX,IAAS,EACT,MAAM,EACN,aAAqB,EACrB,QAAa,EACb,EAAE,EACF,MAAM,GACP,EAAE,mBAAmB,GAAG,OAAO,CAAC,WAAW,EAAE,CAAC;IA+FzC,MAAM,CAAC,EACX,SAAS,EACT,OAAO,EACP,QAAQ,EACR,GAAG,EACH,YAAY,GACb,EAAE,kBAAkB,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,MAAM,EAAE,CAAC;IAsGzD,OAAO,CAAC,MAAM,CAAY;YACZ,gBAAgB;IAU9B,OAAO,CAAC,iBAAiB;YAIX,WAAW;IAmDnB,WAAW,CAAC,EAChB,SAAS,EACT,SAAS,EACT,MAAiB,EACjB,WAAgB,EAChB,UAAiB,EACjB,UAAqB,GACtB,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;IAkIhC,UAAU,CAAC,EAAE,SAAS,EAAE,MAAiB,EAAE,WAAW,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,IAAI,CAAC;YAuBrF,UAAU;YA+HV,sBAAsB;IAoF9B,WAAW,IAAI,OAAO,CAAC,MAAM,EAAE,CAAC;IAoDtC;;;;;OAKG;IACG,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,mBAAmB,GAAG,OAAO,CAAC,YAAY,CAAC;IAgHxE,WAAW,CAAC,EAAE,SAAS,EAAE,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IA6B5D,aAAa,CAAC,EAAE,SAAS,EAAE,EAAE,iBAAiB,GAAG,OAAO,CAAC,IAAI,CAAC;IAyB9D,UAAU;IAchB;;;;;;;;;OASG;IACG,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,kBAAkB,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;IA0IxG;;;;;;OAMG;IACG,YAAY,CAAC,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8BxE;;;;;;OAMG;IACG,aAAa,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,GAAG,EAAE,EAAE,mBAAmB,CAAC,cAAc,CAAC,GAAG,OAAO,CAAC,IAAI,CAAC;CAkHpG"}
|
|
@@ -3,6 +3,10 @@ interface FilterResult {
|
|
|
3
3
|
sql: string;
|
|
4
4
|
values: any[];
|
|
5
5
|
}
|
|
6
|
+
/**
|
|
7
|
+
* Build a filter query for DELETE operations (no minScore/topK parameters)
|
|
8
|
+
*/
|
|
9
|
+
export declare function buildDeleteFilterQuery(filter: PGVectorFilter): FilterResult;
|
|
6
10
|
export declare function buildFilterQuery(filter: PGVectorFilter, minScore: number, topK: number): FilterResult;
|
|
7
11
|
export {};
|
|
8
12
|
//# sourceMappingURL=sql-builder.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"sql-builder.d.ts","sourceRoot":"","sources":["../../src/vector/sql-builder.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;
|
|
1
|
+
{"version":3,"file":"sql-builder.d.ts","sourceRoot":"","sources":["../../src/vector/sql-builder.ts"],"names":[],"mappings":"AAUA,OAAO,KAAK,EAAE,cAAc,EAAE,MAAM,UAAU,CAAC;AAmP/C,UAAU,YAAY;IACpB,GAAG,EAAE,MAAM,CAAC;IACZ,MAAM,EAAE,GAAG,EAAE,CAAC;CACf;AAWD;;GAEG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,cAAc,GAAG,YAAY,CAwG3E;AAED,wBAAgB,gBAAgB,CAAC,MAAM,EAAE,cAAc,EAAE,QAAQ,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,YAAY,CAwGrG"}
|
package/dist/vector/types.d.ts
CHANGED
|
@@ -1,4 +1,14 @@
|
|
|
1
1
|
export type IndexType = 'ivfflat' | 'hnsw' | 'flat';
|
|
2
|
+
/**
|
|
3
|
+
* pgvector storage types for embeddings.
|
|
4
|
+
* - 'vector': Full precision (4 bytes per dimension), max 2000 dimensions for indexes
|
|
5
|
+
* - 'halfvec': Half precision (2 bytes per dimension), max 4000 dimensions for indexes
|
|
6
|
+
*
|
|
7
|
+
* Use 'halfvec' for large dimension models like text-embedding-3-large (3072 dimensions)
|
|
8
|
+
*
|
|
9
|
+
* Note: 'halfvec' requires pgvector >= 0.7.0
|
|
10
|
+
*/
|
|
11
|
+
export type VectorType = 'vector' | 'halfvec';
|
|
2
12
|
interface IVFConfig {
|
|
3
13
|
lists?: number;
|
|
4
14
|
}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/vector/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpD,UAAU,SAAS;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,UAAU;IAClB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB"}
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../src/vector/types.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,SAAS,GAAG,SAAS,GAAG,MAAM,GAAG,MAAM,CAAC;AAEpD;;;;;;;;GAQG;AACH,MAAM,MAAM,UAAU,GAAG,QAAQ,GAAG,SAAS,CAAC;AAE9C,UAAU,SAAS;IACjB,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,UAAU,UAAU;IAClB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,cAAc,CAAC,EAAE,MAAM,CAAC;CACzB;AAED,MAAM,WAAW,WAAW;IAC1B,IAAI,CAAC,EAAE,SAAS,CAAC;IACjB,GAAG,CAAC,EAAE,SAAS,CAAC;IAChB,IAAI,CAAC,EAAE,UAAU,CAAC;CACnB"}
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/pg",
|
|
3
|
-
"version": "1.0.0-beta.
|
|
3
|
+
"version": "1.0.0-beta.11",
|
|
4
4
|
"description": "Postgres provider for Mastra - includes both vector and db storage capabilities",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -22,23 +22,21 @@
|
|
|
22
22
|
"dependencies": {
|
|
23
23
|
"async-mutex": "^0.5.0",
|
|
24
24
|
"pg": "^8.16.3",
|
|
25
|
-
"pg-promise": "^11.15.0",
|
|
26
25
|
"xxhash-wasm": "^1.1.0"
|
|
27
26
|
},
|
|
28
27
|
"devDependencies": {
|
|
29
|
-
"@microsoft/api-extractor": "^7.52.8",
|
|
30
28
|
"@types/node": "22.13.17",
|
|
31
29
|
"@types/pg": "^8.15.6",
|
|
32
|
-
"@vitest/coverage-v8": "4.0.
|
|
33
|
-
"@vitest/ui": "4.0.
|
|
30
|
+
"@vitest/coverage-v8": "4.0.12",
|
|
31
|
+
"@vitest/ui": "4.0.12",
|
|
34
32
|
"eslint": "^9.37.0",
|
|
35
33
|
"tsup": "^8.5.0",
|
|
36
34
|
"typescript": "^5.8.3",
|
|
37
|
-
"vitest": "
|
|
35
|
+
"vitest": "4.0.12",
|
|
36
|
+
"@internal/storage-test-utils": "0.0.49",
|
|
38
37
|
"@internal/lint": "0.0.53",
|
|
39
|
-
"@mastra/core": "1.0.0-beta.3",
|
|
40
38
|
"@internal/types-builder": "0.0.28",
|
|
41
|
-
"@
|
|
39
|
+
"@mastra/core": "1.0.0-beta.19"
|
|
42
40
|
},
|
|
43
41
|
"peerDependencies": {
|
|
44
42
|
"@mastra/core": ">=1.0.0-0 <2.0.0-0"
|
|
@@ -1,119 +0,0 @@
|
|
|
1
|
-
import { StoreOperations } from '@mastra/core/storage';
|
|
2
|
-
import type { StorageColumn, TABLE_NAMES, CreateIndexOptions, IndexInfo, StorageIndexStats } from '@mastra/core/storage';
|
|
3
|
-
import type { IDatabase } from 'pg-promise';
|
|
4
|
-
export type { CreateIndexOptions, IndexInfo, StorageIndexStats };
|
|
5
|
-
export declare class StoreOperationsPG extends StoreOperations {
|
|
6
|
-
client: IDatabase<{}>;
|
|
7
|
-
schemaName?: string;
|
|
8
|
-
private setupSchemaPromise;
|
|
9
|
-
private schemaSetupComplete;
|
|
10
|
-
constructor({ client, schemaName }: {
|
|
11
|
-
client: IDatabase<{}>;
|
|
12
|
-
schemaName?: string;
|
|
13
|
-
});
|
|
14
|
-
hasColumn(table: string, column: string): Promise<boolean>;
|
|
15
|
-
/**
|
|
16
|
-
* Prepares values for insertion, handling JSONB columns by stringifying them
|
|
17
|
-
*/
|
|
18
|
-
private prepareValuesForInsert;
|
|
19
|
-
/**
|
|
20
|
-
* Adds timestamp Z columns to a record if timestamp columns exist
|
|
21
|
-
*/
|
|
22
|
-
private addTimestampZColumns;
|
|
23
|
-
/**
|
|
24
|
-
* Prepares a value for database operations, handling Date objects and JSON serialization
|
|
25
|
-
* This is schema-aware and only stringifies objects for JSONB columns
|
|
26
|
-
*/
|
|
27
|
-
private prepareValue;
|
|
28
|
-
private setupSchema;
|
|
29
|
-
insert({ tableName, record }: {
|
|
30
|
-
tableName: TABLE_NAMES;
|
|
31
|
-
record: Record<string, any>;
|
|
32
|
-
}): Promise<void>;
|
|
33
|
-
clearTable({ tableName }: {
|
|
34
|
-
tableName: TABLE_NAMES;
|
|
35
|
-
}): Promise<void>;
|
|
36
|
-
protected getDefaultValue(type: StorageColumn['type']): string;
|
|
37
|
-
createTable({ tableName, schema, }: {
|
|
38
|
-
tableName: TABLE_NAMES;
|
|
39
|
-
schema: Record<string, StorageColumn>;
|
|
40
|
-
}): Promise<void>;
|
|
41
|
-
/**
|
|
42
|
-
* Set up timestamp triggers for a table to automatically manage createdAt/updatedAt
|
|
43
|
-
*/
|
|
44
|
-
private setupTimestampTriggers;
|
|
45
|
-
/**
|
|
46
|
-
* Alters table schema to add columns if they don't exist
|
|
47
|
-
* @param tableName Name of the table
|
|
48
|
-
* @param schema Schema of the table
|
|
49
|
-
* @param ifNotExists Array of column names to add if they don't exist
|
|
50
|
-
*/
|
|
51
|
-
alterTable({ tableName, schema, ifNotExists, }: {
|
|
52
|
-
tableName: TABLE_NAMES;
|
|
53
|
-
schema: Record<string, StorageColumn>;
|
|
54
|
-
ifNotExists: string[];
|
|
55
|
-
}): Promise<void>;
|
|
56
|
-
load<R>({ tableName, keys }: {
|
|
57
|
-
tableName: TABLE_NAMES;
|
|
58
|
-
keys: Record<string, string>;
|
|
59
|
-
}): Promise<R | null>;
|
|
60
|
-
batchInsert({ tableName, records }: {
|
|
61
|
-
tableName: TABLE_NAMES;
|
|
62
|
-
records: Record<string, any>[];
|
|
63
|
-
}): Promise<void>;
|
|
64
|
-
dropTable({ tableName }: {
|
|
65
|
-
tableName: TABLE_NAMES;
|
|
66
|
-
}): Promise<void>;
|
|
67
|
-
/**
|
|
68
|
-
* Create a new index on a table
|
|
69
|
-
*/
|
|
70
|
-
createIndex(options: CreateIndexOptions): Promise<void>;
|
|
71
|
-
/**
|
|
72
|
-
* Drop an existing index
|
|
73
|
-
*/
|
|
74
|
-
dropIndex(indexName: string): Promise<void>;
|
|
75
|
-
/**
|
|
76
|
-
* List indexes for a specific table or all tables
|
|
77
|
-
*/
|
|
78
|
-
listIndexes(tableName?: string): Promise<IndexInfo[]>;
|
|
79
|
-
/**
|
|
80
|
-
* Returns definitions for automatic performance indexes
|
|
81
|
-
* These composite indexes cover both filtering and sorting in single index
|
|
82
|
-
*/
|
|
83
|
-
protected getAutomaticIndexDefinitions(): CreateIndexOptions[];
|
|
84
|
-
/**
|
|
85
|
-
* Creates automatic indexes for optimal query performance
|
|
86
|
-
* Uses getAutomaticIndexDefinitions() to determine which indexes to create
|
|
87
|
-
*/
|
|
88
|
-
createAutomaticIndexes(): Promise<void>;
|
|
89
|
-
/**
|
|
90
|
-
* Get detailed statistics for a specific index
|
|
91
|
-
*/
|
|
92
|
-
describeIndex(indexName: string): Promise<StorageIndexStats>;
|
|
93
|
-
/**
|
|
94
|
-
* Update a single record in the database
|
|
95
|
-
*/
|
|
96
|
-
update({ tableName, keys, data, }: {
|
|
97
|
-
tableName: TABLE_NAMES;
|
|
98
|
-
keys: Record<string, any>;
|
|
99
|
-
data: Record<string, any>;
|
|
100
|
-
}): Promise<void>;
|
|
101
|
-
/**
|
|
102
|
-
* Update multiple records in a single batch transaction
|
|
103
|
-
*/
|
|
104
|
-
batchUpdate({ tableName, updates, }: {
|
|
105
|
-
tableName: TABLE_NAMES;
|
|
106
|
-
updates: Array<{
|
|
107
|
-
keys: Record<string, any>;
|
|
108
|
-
data: Record<string, any>;
|
|
109
|
-
}>;
|
|
110
|
-
}): Promise<void>;
|
|
111
|
-
/**
|
|
112
|
-
* Delete multiple records by keys
|
|
113
|
-
*/
|
|
114
|
-
batchDelete({ tableName, keys }: {
|
|
115
|
-
tableName: TABLE_NAMES;
|
|
116
|
-
keys: Record<string, any>[];
|
|
117
|
-
}): Promise<void>;
|
|
118
|
-
}
|
|
119
|
-
//# sourceMappingURL=index.d.ts.map
|
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/storage/domains/operations/index.ts"],"names":[],"mappings":"AACA,OAAO,EACL,eAAe,EAQhB,MAAM,sBAAsB,CAAC;AAC9B,OAAO,KAAK,EACV,aAAa,EACb,WAAW,EACX,kBAAkB,EAClB,SAAS,EACT,iBAAiB,EAClB,MAAM,sBAAsB,CAAC;AAE9B,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,YAAY,CAAC;AAI5C,YAAY,EAAE,kBAAkB,EAAE,SAAS,EAAE,iBAAiB,EAAE,CAAC;AAEjE,qBAAa,iBAAkB,SAAQ,eAAe;IAC7C,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;IACtB,UAAU,CAAC,EAAE,MAAM,CAAC;IAC3B,OAAO,CAAC,kBAAkB,CAA8B;IACxD,OAAO,CAAC,mBAAmB,CAAkC;gBAEjD,EAAE,MAAM,EAAE,UAAU,EAAE,EAAE;QAAE,MAAM,EAAE,SAAS,CAAC,EAAE,CAAC,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAA;KAAE;IAM5E,SAAS,CAAC,KAAK,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC;IAYhE;;OAEG;IACH,OAAO,CAAC,sBAAsB;IAe9B;;OAEG;IACH,OAAO,CAAC,oBAAoB;IAY5B;;;OAGG;IACH,OAAO,CAAC,YAAY;YA2BN,WAAW;IAmDnB,MAAM,CAAC,EAAE,SAAS,EAAE,MAAM,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAC;QAAC,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IA4BrG,UAAU,CAAC,EAAE,SAAS,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAoB1E,SAAS,CAAC,eAAe,CAAC,IAAI,EAAE,aAAa,CAAC,MAAM,CAAC,GAAG,MAAM;IAWxD,WAAW,CAAC,EAChB,SAAS,EACT,MAAM,GACP,EAAE;QACD,SAAS,EAAE,WAAW,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;KACvC,GAAG,OAAO,CAAC,IAAI,CAAC;IAgFjB;;OAEG;YACW,sBAAsB;IA6CpC;;;;;OAKG;IACG,UAAU,CAAC,EACf,SAAS,EACT,MAAM,EACN,WAAW,GACZ,EAAE;QACD,SAAS,EAAE,WAAW,CAAC;QACvB,MAAM,EAAE,MAAM,CAAC,MAAM,EAAE,aAAa,CAAC,CAAC;QACtC,WAAW,EAAE,MAAM,EAAE,CAAC;KACvB,GAAG,OAAO,CAAC,IAAI,CAAC;IAwCX,IAAI,CAAC,CAAC,EAAE,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;KAAE,GAAG,OAAO,CAAC,CAAC,GAAG,IAAI,CAAC;IAwCzG,WAAW,CAAC,EAAE,SAAS,EAAE,OAAO,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAC;QAAC,OAAO,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAwB9G,SAAS,CAAC,EAAE,SAAS,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;IAoBzE;;OAEG;IACG,WAAW,CAAC,OAAO,EAAE,kBAAkB,GAAG,OAAO,CAAC,IAAI,CAAC;IA8F7D;;OAEG;IACG,SAAS,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,IAAI,CAAC;IAiCjD;;OAEG;IACG,WAAW,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,SAAS,EAAE,CAAC;IAmF3D;;;OAGG;IACH,SAAS,CAAC,4BAA4B,IAAI,kBAAkB,EAAE;IAmD9D;;;OAGG;IACG,sBAAsB,IAAI,OAAO,CAAC,IAAI,CAAC;IAwB7C;;OAEG;IACG,aAAa,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,iBAAiB,CAAC;IAsElE;;OAEG;IACG,MAAM,CAAC,EACX,SAAS,EACT,IAAI,EACJ,IAAI,GACL,EAAE;QACD,SAAS,EAAE,WAAW,CAAC;QACvB,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;QAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;KAC3B,GAAG,OAAO,CAAC,IAAI,CAAC;IA+CjB;;OAEG;IACG,WAAW,CAAC,EAChB,SAAS,EACT,OAAO,GACR,EAAE;QACD,SAAS,EAAE,WAAW,CAAC;QACvB,OAAO,EAAE,KAAK,CAAC;YACb,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;YAC1B,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,CAAC;SAC3B,CAAC,CAAC;KACJ,GAAG,OAAO,CAAC,IAAI,CAAC;IAwBjB;;OAEG;IACG,WAAW,CAAC,EAAE,SAAS,EAAE,IAAI,EAAE,EAAE;QAAE,SAAS,EAAE,WAAW,CAAC;QAAC,IAAI,EAAE,MAAM,CAAC,MAAM,EAAE,GAAG,CAAC,EAAE,CAAA;KAAE,GAAG,OAAO,CAAC,IAAI,CAAC;CA0C/G"}
|