cockroachdb / cockroachdb/sequelize-cockroachdb

Add (native) VECTOR data type support

Open
#158 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
JavaScript
Stars
55
Forks
18
PR merge metrics
No merged PRs in 30d

Description

More recent CockroachDB versions (I think 25+) added the data type VECTOR for storing fixed-length arrays of floating-point numbers, which represent data points in multi-dimensional space. It is often used for vector search in applications with LLMs, e.g. RAG (retrieval augmented generation). See the [docs](https://www.cockroachlabs.com/docs/stable/vector) for more info.

As such, having support for this data type in sequelize-cockroachdb would be quite nice to enable such applications using CockroachDB, Sequelize and NodeJS.

The type VECTOR does not exist currently in sequelize-cockroachdb, also using ARRAY is not possible due to syntax mismatches between handling ARRAY and VECTOR in SQL. The workaround I'm using now (and documenting here for others stumbling upon this problem) is defining the column data type as STRING in the schema (but as VECTOR in the actual database) and then manually converting an array of floats to the format required by CockroachDB using JSON.stringify().

```javascript
//Schema file
...
embedding: {
type: Sequelize.DataTypes.STRING, //Should be VECTOR when supported
allowNull: true
},
...
```

Inserting/updating data in this column can be done like this:

```javascript
// Update data in VECTOR column
let embedding = [-0.03704405203461647, 0.024347146973013878, -0.007968421094119549, ...];
await model.update({ embedding: JSON.stringify(embedding) });
```

Querying works with literals:
```javascript
let queryEmbedding = [-0.03704405203461647, 0.024347146973013878, -0.007968421094119549, ...];
let results = await model.findAll({
where: Sequelize.literal(`embedding <=> '${JSON.stringify(queryEmbedding)}'::vector < 0.5`)
});
```

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.