@caleblawson/astra
v0.10.2
Published
Astra DB provider for Mastra - includes vector store capabilities
Readme
@mastra/astra
Vector store implementation for DataStax Astra DB, providing vector similarity search capabilities using Cassandra's vector search functionality.
Installation
npm install @mastra/astraUsage
import { AstraVector } from '@mastra/astra';
const vectorStore = new AstraVector({
token: 'your-astra-token',
endpoint: 'your-astra-endpoint',
keyspace: 'your-keyspace' // optional
});
// Create a new collection
await vectorStore.createIndex({ indexName: 'myCollection', dimension: 1536, metric: 'cosine' });
// Add vectors
const vectors = [[0.1, 0.2, ...], [0.3, 0.4, ...]];
const metadata = [{ text: 'doc1' }, { text: 'doc2' }];
const ids = await vectorStore.upsert({ indexName: 'myCollection', vectors, metadata });
// Query vectors
const results = await vectorStore.query({
indexName: 'myCollection',
queryVector: [0.1, 0.2, ...],
topK: 10, // topK
filter: { text: { $eq: 'doc1' } }, // optional filter
includeVector: false // includeVectors
});Configuration
The Astra DB vector store requires:
token: Your Astra DB tokenendpoint: Your Astra DB endpointkeyspace: (Optional) The keyspace to use
Features
- Vector similarity search with cosine, euclidean, and dot product metrics
- Metadata filtering support
- Batch vector upsert operations
- Collection management (create, list, describe, delete)
- Optional vector inclusion in query results
- Automatic UUID generation for vectors
- Built on top of @datastax/astra-db-ts client
Methods
createIndex({ indexName, dimension, metric? }): Create a new collectionupsert({ indexName, vectors, metadata?, ids }): Add or update vectorsquery({ indexName, queryVector, topK?, filter?, includeVector? }): Search for similar vectorslistIndexes(): List all collectionsdescribeIndex(indexName): Get collection statisticsdeleteIndex(indexName): Delete a collection
