@mastra/couchbase 1.0.1-alpha.0 → 1.0.2-alpha.0
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
CHANGED
|
@@ -1,5 +1,23 @@
|
|
|
1
1
|
# @mastra/couchbase
|
|
2
2
|
|
|
3
|
+
## 1.0.2-alpha.0
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- dependencies updates: ([#13837](https://github.com/mastra-ai/mastra/pull/13837))
|
|
8
|
+
- Updated dependency [`couchbase@^4.6.1` ↗︎](https://www.npmjs.com/package/couchbase/v/4.6.1) (from `^4.6.0`, in `dependencies`)
|
|
9
|
+
- Updated dependencies [[`41e48c1`](https://github.com/mastra-ai/mastra/commit/41e48c198eee846478e60c02ec432c19d322a517), [`82469d3`](https://github.com/mastra-ai/mastra/commit/82469d3135d5a49dd8dc8feec0ff398b4e0225a0), [`33e2fd5`](https://github.com/mastra-ai/mastra/commit/33e2fd5088f83666df17401e2da68c943dbc0448), [`7ef6e2c`](https://github.com/mastra-ai/mastra/commit/7ef6e2c61be5a42e26f55d15b5902866fc76634f), [`b12d2a5`](https://github.com/mastra-ai/mastra/commit/b12d2a59a48be0477cabae66eb6cf0fc94a7d40d), [`fa37d39`](https://github.com/mastra-ai/mastra/commit/fa37d39910421feaf8847716292e3d65dd4f30c2), [`b12d2a5`](https://github.com/mastra-ai/mastra/commit/b12d2a59a48be0477cabae66eb6cf0fc94a7d40d), [`71c38bf`](https://github.com/mastra-ai/mastra/commit/71c38bf905905148ecd0e75c07c1f9825d299b76), [`f993c38`](https://github.com/mastra-ai/mastra/commit/f993c3848c97479b813231be872443bedeced6ab), [`f51849a`](https://github.com/mastra-ai/mastra/commit/f51849a568935122b5100b7ee69704e6d680cf7b), [`9bf3a0d`](https://github.com/mastra-ai/mastra/commit/9bf3a0dac602787925f1762f1f0387d7b4a59620), [`cafa045`](https://github.com/mastra-ai/mastra/commit/cafa0453c9de141ad50c09a13894622dffdd9978), [`1fd9ddb`](https://github.com/mastra-ai/mastra/commit/1fd9ddbb3fe83b281b12bd2e27e426ae86288266), [`6135ef4`](https://github.com/mastra-ai/mastra/commit/6135ef4f5288652bf45f616ec590607e4c95f443), [`d9d228c`](https://github.com/mastra-ai/mastra/commit/d9d228c0c6ae82ae6ce3b540a3a56b2b1c2b8d98), [`5576507`](https://github.com/mastra-ai/mastra/commit/55765071e360fb97e443aa0a91ccf7e1cd8d92aa), [`79d69c9`](https://github.com/mastra-ai/mastra/commit/79d69c9d5f842ff1c31352fb6026f04c1f6190f3), [`94f44b8`](https://github.com/mastra-ai/mastra/commit/94f44b827ce57b179e50f4916a84c0fa6e7f3b8c), [`13187db`](https://github.com/mastra-ai/mastra/commit/13187dbac880174232dedc5a501ff6c5d0fe59bc), [`2ae5311`](https://github.com/mastra-ai/mastra/commit/2ae531185fff66a80fa165c0999e3d801900e89d), [`6135ef4`](https://github.com/mastra-ai/mastra/commit/6135ef4f5288652bf45f616ec590607e4c95f443)]:
|
|
10
|
+
- @mastra/core@1.10.0-alpha.0
|
|
11
|
+
|
|
12
|
+
## 1.0.1
|
|
13
|
+
|
|
14
|
+
### Patch Changes
|
|
15
|
+
|
|
16
|
+
- Add a clear runtime error when `queryVector` is omitted for vector stores that require a vector for queries. Previously, omitting `queryVector` would produce confusing SDK-level errors; now each store throws a structured `MastraError` with `ErrorCategory.USER` explaining that metadata-only queries are not supported by that backend. ([#13286](https://github.com/mastra-ai/mastra/pull/13286))
|
|
17
|
+
|
|
18
|
+
- Updated dependencies [[`df170fd`](https://github.com/mastra-ai/mastra/commit/df170fd139b55f845bfd2de8488b16435bd3d0da), [`ae55343`](https://github.com/mastra-ai/mastra/commit/ae5534397fc006fd6eef3e4f80c235bcdc9289ef), [`c290cec`](https://github.com/mastra-ai/mastra/commit/c290cec5bf9107225de42942b56b487107aa9dce), [`f03e794`](https://github.com/mastra-ai/mastra/commit/f03e794630f812b56e95aad54f7b1993dc003add), [`aa4a5ae`](https://github.com/mastra-ai/mastra/commit/aa4a5aedb80d8d6837bab8cbb2e301215d1ba3e9), [`de3f584`](https://github.com/mastra-ai/mastra/commit/de3f58408752a8d80a295275c7f23fc306cf7f4f), [`d3fb010`](https://github.com/mastra-ai/mastra/commit/d3fb010c98f575f1c0614452667396e2653815f6), [`702ee1c`](https://github.com/mastra-ai/mastra/commit/702ee1c41be67cc532b4dbe89bcb62143508f6f0), [`f495051`](https://github.com/mastra-ai/mastra/commit/f495051eb6496a720f637fc85b6d69941c12554c), [`e622f1d`](https://github.com/mastra-ai/mastra/commit/e622f1d3ab346a8e6aca6d1fe2eac99bd961e50b), [`861f111`](https://github.com/mastra-ai/mastra/commit/861f11189211b20ddb70d8df81a6b901fc78d11e), [`00f43e8`](https://github.com/mastra-ai/mastra/commit/00f43e8e97a80c82b27d5bd30494f10a715a1df9), [`1b6f651`](https://github.com/mastra-ai/mastra/commit/1b6f65127d4a0d6c38d0a1055cb84527db529d6b), [`96a1702`](https://github.com/mastra-ai/mastra/commit/96a1702ce362c50dda20c8b4a228b4ad1a36a17a), [`cb9f921`](https://github.com/mastra-ai/mastra/commit/cb9f921320913975657abb1404855d8c510f7ac5), [`114e7c1`](https://github.com/mastra-ai/mastra/commit/114e7c146ac682925f0fb37376c1be70e5d6e6e5), [`1b6f651`](https://github.com/mastra-ai/mastra/commit/1b6f65127d4a0d6c38d0a1055cb84527db529d6b), [`72df4a8`](https://github.com/mastra-ai/mastra/commit/72df4a8f9bf1a20cfd3d9006a4fdb597ad56d10a)]:
|
|
19
|
+
- @mastra/core@1.8.0
|
|
20
|
+
|
|
3
21
|
## 1.0.1-alpha.0
|
|
4
22
|
|
|
5
23
|
### Patch Changes
|
package/LICENSE.md
CHANGED
|
@@ -1,3 +1,18 @@
|
|
|
1
|
+
Portions of this software are licensed as follows:
|
|
2
|
+
|
|
3
|
+
- All content that resides under any directory named "ee/" within this
|
|
4
|
+
repository, including but not limited to:
|
|
5
|
+
- `packages/core/src/auth/ee/`
|
|
6
|
+
- `packages/server/src/server/auth/ee/`
|
|
7
|
+
is licensed under the license defined in `ee/LICENSE`.
|
|
8
|
+
|
|
9
|
+
- All third-party components incorporated into the Mastra Software are
|
|
10
|
+
licensed under the original license provided by the owner of the
|
|
11
|
+
applicable component.
|
|
12
|
+
|
|
13
|
+
- Content outside of the above-mentioned directories or restrictions is
|
|
14
|
+
available under the "Apache License 2.0" as defined below.
|
|
15
|
+
|
|
1
16
|
# Apache License 2.0
|
|
2
17
|
|
|
3
18
|
Copyright (c) 2025 Kepler Software, Inc.
|
package/dist/docs/SKILL.md
CHANGED
|
@@ -3,7 +3,7 @@ name: mastra-couchbase
|
|
|
3
3
|
description: Documentation for @mastra/couchbase. Use when working with @mastra/couchbase APIs, configuration, or implementation.
|
|
4
4
|
metadata:
|
|
5
5
|
package: "@mastra/couchbase"
|
|
6
|
-
version: "1.0.
|
|
6
|
+
version: "1.0.2-alpha.0"
|
|
7
7
|
---
|
|
8
8
|
|
|
9
9
|
## When to use
|
|
@@ -51,21 +51,21 @@ const store = new CouchbaseVector({
|
|
|
51
51
|
|
|
52
52
|
## Constructor Options
|
|
53
53
|
|
|
54
|
-
**id
|
|
54
|
+
**id** (`string`): Unique identifier for this vector store instance
|
|
55
55
|
|
|
56
|
-
**connectionString
|
|
56
|
+
**connectionString** (`string`): Couchbase connection string
|
|
57
57
|
|
|
58
|
-
**username
|
|
58
|
+
**username** (`string`): Couchbase username
|
|
59
59
|
|
|
60
|
-
**password
|
|
60
|
+
**password** (`string`): Couchbase password
|
|
61
61
|
|
|
62
|
-
**bucketName
|
|
62
|
+
**bucketName** (`string`): Name of the Couchbase bucket to use
|
|
63
63
|
|
|
64
|
-
**scopeName
|
|
64
|
+
**scopeName** (`string`): Name of the Couchbase scope to use
|
|
65
65
|
|
|
66
|
-
**collectionName
|
|
66
|
+
**collectionName** (`string`): Name of the Couchbase collection to use
|
|
67
67
|
|
|
68
|
-
**options
|
|
68
|
+
**options** (`CouchbaseClientOptions`): Optional Couchbase client options
|
|
69
69
|
|
|
70
70
|
## Methods
|
|
71
71
|
|
|
@@ -75,11 +75,11 @@ Creates a new vector index in Couchbase.
|
|
|
75
75
|
|
|
76
76
|
> **Note:** Index creation is asynchronous. After calling `createIndex`, allow time (typically 1–5 seconds for small datasets, longer for large ones) before querying. For production, implement polling to check index status rather than using fixed delays.
|
|
77
77
|
|
|
78
|
-
**indexName
|
|
78
|
+
**indexName** (`string`): Name of the index to create
|
|
79
79
|
|
|
80
|
-
**dimension
|
|
80
|
+
**dimension** (`number`): Vector dimension (must match your embedding model)
|
|
81
81
|
|
|
82
|
-
**metric
|
|
82
|
+
**metric** (`'cosine' | 'euclidean' | 'dotproduct'`): Distance metric for similarity search (Default: `cosine`)
|
|
83
83
|
|
|
84
84
|
### upsert()
|
|
85
85
|
|
|
@@ -87,13 +87,13 @@ Adds or updates vectors and their metadata in the collection.
|
|
|
87
87
|
|
|
88
88
|
> **Note:** You can upsert data before or after creating the index. The `upsert` method does not require the index to exist. Couchbase allows multiple Search indexes over the same collection.
|
|
89
89
|
|
|
90
|
-
**indexName
|
|
90
|
+
**indexName** (`string`): Name of the index to insert into
|
|
91
91
|
|
|
92
|
-
**vectors
|
|
92
|
+
**vectors** (`number[][]`): Array of embedding vectors
|
|
93
93
|
|
|
94
|
-
**metadata
|
|
94
|
+
**metadata** (`Record<string, any>[]`): Metadata for each vector
|
|
95
95
|
|
|
96
|
-
**ids
|
|
96
|
+
**ids** (`string[]`): Optional vector IDs (auto-generated if not provided)
|
|
97
97
|
|
|
98
98
|
### query()
|
|
99
99
|
|
|
@@ -101,23 +101,23 @@ Searches for similar vectors.
|
|
|
101
101
|
|
|
102
102
|
> **Warning:** The `filter` and `includeVector` parameters are not currently supported. Filtering must be performed client-side after retrieving results, or by using the Couchbase SDK's Search capabilities directly. To retrieve the vector embedding, fetch the full document by ID using the Couchbase SDK.
|
|
103
103
|
|
|
104
|
-
**indexName
|
|
104
|
+
**indexName** (`string`): Name of the index to search in
|
|
105
105
|
|
|
106
|
-
**queryVector
|
|
106
|
+
**queryVector** (`number[]`): Query vector to find similar vectors for
|
|
107
107
|
|
|
108
|
-
**topK
|
|
108
|
+
**topK** (`number`): Number of results to return (Default: `10`)
|
|
109
109
|
|
|
110
|
-
**filter
|
|
110
|
+
**filter** (`Record<string, any>`): Metadata filters
|
|
111
111
|
|
|
112
|
-
**includeVector
|
|
112
|
+
**includeVector** (`boolean`): Whether to include vector data in results (Default: `false`)
|
|
113
113
|
|
|
114
|
-
**minScore
|
|
114
|
+
**minScore** (`number`): Minimum similarity score threshold (Default: `0`)
|
|
115
115
|
|
|
116
116
|
### describeIndex()
|
|
117
117
|
|
|
118
118
|
Returns information about the index.
|
|
119
119
|
|
|
120
|
-
**indexName
|
|
120
|
+
**indexName** (`string`): Name of the index to describe
|
|
121
121
|
|
|
122
122
|
Returns:
|
|
123
123
|
|
|
@@ -133,7 +133,7 @@ interface IndexStats {
|
|
|
133
133
|
|
|
134
134
|
Deletes an index and all its data.
|
|
135
135
|
|
|
136
|
-
**indexName
|
|
136
|
+
**indexName** (`string`): Name of the index to delete
|
|
137
137
|
|
|
138
138
|
### listIndexes()
|
|
139
139
|
|
|
@@ -145,27 +145,27 @@ Returns: `Promise<string[]>`
|
|
|
145
145
|
|
|
146
146
|
Updates a specific vector entry by its ID with new vector data and/or metadata. **Note:** Filter-based updates are not yet implemented for Couchbase.
|
|
147
147
|
|
|
148
|
-
**indexName
|
|
148
|
+
**indexName** (`string`): Name of the index containing the vector
|
|
149
149
|
|
|
150
|
-
**id
|
|
150
|
+
**id** (`string`): ID of the vector entry to update
|
|
151
151
|
|
|
152
|
-
**update
|
|
152
|
+
**update** (`{ vector?: number[]; metadata?: Record<string, any>; }`): Object containing the vector and/or metadata to update
|
|
153
153
|
|
|
154
154
|
### deleteVector()
|
|
155
155
|
|
|
156
156
|
Deletes a single vector by its ID from the index.
|
|
157
157
|
|
|
158
|
-
**indexName
|
|
158
|
+
**indexName** (`string`): Name of the index containing the vector
|
|
159
159
|
|
|
160
|
-
**id
|
|
160
|
+
**id** (`string`): ID of the vector to delete
|
|
161
161
|
|
|
162
162
|
### deleteVectors()
|
|
163
163
|
|
|
164
164
|
Deletes multiple vectors by their IDs. **Note:** Filter-based deletion is not yet implemented for Couchbase.
|
|
165
165
|
|
|
166
|
-
**indexName
|
|
166
|
+
**indexName** (`string`): Name of the index containing the vectors to delete
|
|
167
167
|
|
|
168
|
-
**ids
|
|
168
|
+
**ids** (`string[]`): Array of vector IDs to delete
|
|
169
169
|
|
|
170
170
|
### disconnect()
|
|
171
171
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@mastra/couchbase",
|
|
3
|
-
"version": "1.0.
|
|
3
|
+
"version": "1.0.2-alpha.0",
|
|
4
4
|
"description": "Couchbase vector store provider for Mastra",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"main": "dist/index.js",
|
|
@@ -19,7 +19,7 @@
|
|
|
19
19
|
"./package.json": "./package.json"
|
|
20
20
|
},
|
|
21
21
|
"dependencies": {
|
|
22
|
-
"couchbase": "^4.6.
|
|
22
|
+
"couchbase": "^4.6.1"
|
|
23
23
|
},
|
|
24
24
|
"devDependencies": {
|
|
25
25
|
"@types/node": "22.19.7",
|
|
@@ -29,10 +29,10 @@
|
|
|
29
29
|
"tsup": "^8.5.1",
|
|
30
30
|
"typescript": "^5.9.3",
|
|
31
31
|
"vitest": "4.0.18",
|
|
32
|
-
"@internal/lint": "0.0.
|
|
33
|
-
"@internal/types-builder": "0.0.
|
|
34
|
-
"@internal/storage-test-utils": "0.0.
|
|
35
|
-
"@mastra/core": "1.
|
|
32
|
+
"@internal/lint": "0.0.65",
|
|
33
|
+
"@internal/types-builder": "0.0.40",
|
|
34
|
+
"@internal/storage-test-utils": "0.0.61",
|
|
35
|
+
"@mastra/core": "1.10.0-alpha.0"
|
|
36
36
|
},
|
|
37
37
|
"peerDependencies": {
|
|
38
38
|
"@mastra/core": ">=1.0.0-0 <2.0.0-0"
|