Documentation Index
Fetch the complete documentation index at: /llms.txt
Use this file to discover all available pages before exploring further.
Update documents in the database
updateMetadata(id: string, metadata: T): void
| Parameter | Type | Description |
|---|---|---|
id | string | Document ID |
metadata | T | New metadata object |
db.updateMetadata('users:list', {
id: 'users:list',
toolName: 'list',
owner: 'users',
tags: ['read', 'legacy'],
risk: 'safe',
deprecated: true,
});
| Error | Condition |
|---|---|
VectoriaNotInitializedError | Database not initialized |
DocumentNotFoundError | Document ID doesn’t exist |
async update(
id: string,
updates: { text?: string; metadata?: T },
options?: { forceReembed?: boolean }
): Promise<boolean>
| Parameter | Type | Description |
|---|---|---|
id | string | Document ID |
updates.text | string | New text (optional) |
updates.metadata | T | New metadata (optional) |
options.forceReembed | boolean | Force re-embedding even if text unchanged |
true if the document was re-embedded, false if only metadata was updated.
// Metadata-only update (no re-embed)
const reembedded = await db.update('id', {
metadata: newMetadata,
});
console.log(reembedded); // false
// Text update (triggers re-embed)
const reembedded = await db.update('id', {
text: 'New description',
metadata: newMetadata,
});
console.log(reembedded); // true
// Force re-embed
await db.update('id', {
text: existingText,
metadata: newMetadata,
}, { forceReembed: true });
| Error | Condition |
|---|---|
VectoriaNotInitializedError | Database not initialized |
DocumentNotFoundError | Document ID doesn’t exist |
DocumentValidationError | Empty text or size limit exceeded |
async updateMany(
updates: Array<{ id: string; text?: string; metadata?: T }>,
options?: { forceReembed?: boolean }
): Promise<{ updated: number; reembedded: number }>
{
updated: number; // Total documents updated
reembedded: number; // Documents that required re-embedding
}
const result = await db.updateMany([
{ id: 'doc1', text: 'New text', metadata: meta1 },
{ id: 'doc2', metadata: meta2 }, // Metadata only
]);
console.log(`Updated: ${result.updated}, Re-embedded: ${result.reembedded}`);