DotVector.Core 1.0.0

.NET 10.0 This package targets .NET 10.0. The package is compatible with this framework or higher. 
dotnet add package DotVector.Core --version 1.0.0
                    


                    

                
NuGet\Install-Package DotVector.Core -Version 1.0.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="DotVector.Core" Version="1.0.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="DotVector.Core" Version="1.0.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="DotVector.Core" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add DotVector.Core --version 1.0.0
                    


                    

                
#r "nuget: DotVector.Core, 1.0.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package DotVector.Core@1.0.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=DotVector.Core&version=1.0.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=DotVector.Core&version=1.0.0
                    


                            Install as a Cake Tool

🚀 DotVector

CI Docs NuGet NuGet Core Docker Pulls License: MIT

面向 .NET 10 的嵌入式原生向量数据库

单目录持久化、进程内运行、零外部依赖，也支持 gRPC 服务器模式与 Docker 部署。

✨ 项目介绍

DotVector 是一个基于 C# / .NET 10 的向量数据库项目，核心引擎可以直接通过 NuGet 引用，在应用进程内运行。

它适合两种典型形态：

  • 嵌入式模式：直接 new VectorDatabase()，本地使用
  • 服务器模式：通过 DotVector 服务端宿主对外提供 gRPC 接口

仓库当前覆盖了数据库引擎、客户端适配、命令行工具、服务端宿主、连接器和示例代码。

项目边界保持清晰：

  • DotVector.Core 是完整的嵌入式数据库引擎，包含 VectorDatabase、LocalDotVectorClient、索引、存储、查询、协议 DTO 和距离计算；一个 VectorDatabase 实例对应一个 .dvec/ 数据库目录。
  • DotVector 是服务端壳，用于在一个进程内托管多个 Core 数据库实例，并对外提供远程访问能力。
  • DotVector.Data 是客户端 SDK 项目，NuGet 包名为 DotVector，包含高层 DotVectorClient、gRPC 客户端、嵌入式工厂和 Microsoft.Extensions.VectorData 适配。
  • DotVector.VectorData 是仓库中保留的独立 VectorData 适配项目，便于后续拆分/兼容演进；当前主要发布门面是 DotVector NuGet 包。
  • connectors/c 与 connectors/python 提供 C ABI、Python gRPC / Native ctypes 两条跨语言接入路径。

🧠 核心实力

维度 能力
向量计算 TensorPrimitives、Vector<T>、Vector512<T>
索引引擎 Flat、HNSW、IVF-Flat、IVF-PQ、Vamana
距离度量 L2、Cosine、InnerProduct、Hamming、DotProduct
量化能力 SQ8、PQ、OPQ、RQ
存储能力 .dvec/ 目录、WAL、Segment、mmap 读取
查询能力 向量检索、标量过滤、payload 持久化
部署能力 嵌入式库、gRPC 服务、Docker 镜像、AOT CLI
生态集成 Microsoft.Extensions.VectorData、C ABI、Python connector、NuGet、Release 产物

⚡ 主要优势

  • 嵌入式优先：没有外部数据库进程，适合应用内直接使用。
  • .NET 原生：围绕 .NET 10 的向量计算能力设计，API 风格统一。
  • 单目录持久化：数据、WAL、Segment 分层清晰，便于恢复和维护。
  • 安全实现：M0 到 M7 坚持 safe-only，不依赖 unsafe。
  • AOT 友好：CLI 和服务端宿主都按 AOT / trim 分析思路设计。
  • 可扩展：从本地嵌入式到远程服务器，接口层保持一致。

📦 NuGet 包与连接器

名称 小标签 下载量 版本号 作用
DotVector.Core Core NuGet Downloads NuGet Version 嵌入式核心引擎，提供向量数据库、索引、存储、查询与距离计算能力。
DotVector Data NuGet Downloads NuGet Version 客户端 SDK 与 Microsoft.Extensions.VectorData 适配层，由 src/DotVector.Data 项目打包，用于本地或远程访问 DotVector。
DotVector.Cli CLI NuGet Downloads NuGet Version 命令行工具，用于连接 DotVector gRPC 服务、管理集合与执行基础操作。
iotsharp/dotvector Server 服务端宿主 Docker 镜像；源码项目为 src/DotVector，不作为 NuGet 包发布。
connectors/c/native Connector NativeAOT 共享库，暴露稳定 C ABI，支持嵌入式与远程句柄。
connectors/python Connector Python gRPC 客户端与 ctypes Native 客户端。

🚀 快速开始

using DotVector.Api;
using DotVector.Model;

using var db = new VectorDatabase();
var collection = db.CreateCollection<string>("articles", dimensions: 4, metric: Metric.Cosine);

collection.Insert(new VectorRecord<string>("doc-1", [0.95f, 0.10f, 0.08f, 0.02f]));

var results = collection.Search([0.92f, 0.12f, 0.07f, 0.03f], topK: 5);

更完整的可运行示例见 examples/csharp/QuickStart。

🐳 服务与发布

  • Docker 镜像：iotsharp/dotvector
  • 服务端入口：dotnet run --project src/DotVector -- --data ./data --port 5180
  • CLI 入口：dotvector ping --endpoint http://localhost:5180
  • GitHub Release：同时附带连接器产物与示例压缩包
  • 文档站：https://iotsharp.net/DotVector/，使用 JekyllNet 构建并发布到 GitHub Pages

发布说明见 docs/release.md。

📦 仓库内容

  • src/：核心库、服务端、数据适配、CLI
  • connectors/：C ABI 与 Python 连接器
  • examples/：示例工程
  • tests/：单元、集成、精度、基准测试
  • docs/：架构、算法、发布说明与产品定位

🧭 后续方向

DotVector 的底层引擎已经覆盖索引、持久化、量化、VectorData 与服务端部署；后续会继续补强开发体验和服务端管理面：

  • Code-First / Attribute 建模
  • 服务端 _system.dvec/ 系统目录
  • 数据库创建、连接、用户和权限管理
  • Vue3 管理台
  • Python / C / C# 多语言快速开始

相关规划已写入 ROADMAP.md 的 M16。

🤝 规范与贡献

欢迎提交 Issue 和 PR，请遵循 Conventional Commits 规范。

English version: README.en.md

Product Compatible and additional computed target framework versions.
.NET net10.0 is compatible.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (2)

Showing the top 2 NuGet packages that depend on DotVector.Core:

Package Downloads
DotVector

DotVector client SDK and Microsoft.Extensions.VectorData adapter.
DotVector.Data

DotVector client SDK and Microsoft.Extensions.VectorData adapter.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.0.0 24 5/8/2026
0.5.0 24 5/8/2026
0.4.0 29 5/8/2026
0.2.0 29 5/8/2026