# Synapse
**Repository Path**: rudis/synapse
## Basic Information
- **Project Name**: Synapse
- **Description**: ⚡Synapse 一 个 轻 量 级 向 量 数 据 库
- **Primary Language**: Unknown
- **License**: GPL-3.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No
## Statistics
- **Stars**: 5
- **Forks**: 0
- **Created**: 2025-05-23
- **Last Updated**: 2025-05-27
## Categories & Tags
**Categories**: Uncategorized
**Tags**: None
## README
## 项目介绍
Synapse 是基于 Rust 构建的新一代向量数据库系统,专为 AI 时代的高维数据存储与检索场景设计。通过充分利用 Rust 的零成本抽象和内存安全特性,系统在保证高性能的同时实现了企业级可靠性,单节点可支持百万级 QPS 的向量相似度检索。
## 快速入门
```
___ _ _ ____ ____ ____ ___ ____
/___) | | | _ \ / _ | _ \ /___)/ _ )
|___ | |_| | | | ( ( | | | | |___ ( (/ /
(___/ \__ |_| |_|\_||_| ||_/(___/ \____)
(____/ |_|
Synapse 0.0.1
Introduce: A high-performance vector database
Bind: 1992 PID: 20536
[2025-05-23T01:28:18Z INFO synapse_server::server] Server initialized
[2025-05-23T01:28:18Z INFO synapse_server::server] Ready to accept connections
```
### 普通安装
根据系统环境要求,下载匹配的 Synapse 版本
通过系统常规命令启动 Synapse 服务
```sh
// windows 常规启动
start synapse-server.exe
// windows 指定参数启动
start synapse-server.exe --port 1992
```
## 常用命令
AUTH 命令
客户端发送密码进行身份验证, 为服务端预设的字符串(如 123456)。
```
127.0.0.1:1992> AUTH
OK
```
SELECT 命令
切换当前连接的数据库, 为目标数据库的整数编号(如 0、16)。
```
127.0.0.1:1992> SELECT
OK
```
CREATE_COLLECTION 命令
创建向量集合, 为集合名称(字符串), 为向量维度的整数值(如 3 表示三维向量)。
```
127.0.0.1:1992> CREATE_COLLECTION
OK
```
DELETE_COLLECTION 命令
删除指定名称的集合, 为已存在的集合名称(字符串)。
```
127.0.0.1:1992> DELETE_COLLECTION
(integer) 1
```
INSERT 命令
向集合插入向量数据, 目标集合名称。 向量项的唯一标识符(字符串)。 向量数值列表(多个浮点数,如 0.3 0.4 0.5)。METADATA(可选) 附加键值对元数据(如 category=electronics brand=sony)。
```
127.0.0.1:1992> INSERT [METADATA ...]
Ok
```
DELETE 命令
删除集合中的指定项, 为集合名称, 为待删除项的标识符。
```
127.0.0.1:1992> DELETE
OK
```
SEARCH 命令
在集合中搜索相似向量,: 目标集合名称。 查询向量(多个浮点数)。FILTER(可选)元数据过滤条件(如 brand=sony)。k(可选) 返回结果的最大数量(整数,如 k 3 表示返回前 3 项)。
```
127.0.0.1:1992> SEARCH [FILTER ] [k ]
```
Client tools: [Synapse-cli](https://gitee.com/rudis/synapse/tree/master/resources)
## 开源共建
Spnapse 项目遵循 [GNU GENERAL PUBLIC LICENSE](https://github.com/sleeprite/synapse/blob/master/LICENSE) 开源协议,感谢这些优秀的 [Contributors](https://github.com/sleeprite/synapse/graphs/contributors)。