# xugu-vector-python-demo

**Repository Path**: XuguDB/xugu-vector-python-demo

## Basic Information

- **Project Name**: xugu-vector-python-demo
- **Description**: xugu python 驱动向量demo
- **Primary Language**: Python
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-03-23
- **Last Updated**: 2026-03-23

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# xugu-vector-python-demo

基于 Python 驱动 `xgcondb` 的虚谷数据库向量类型示例工程，用于演示以下数据类型的建表、插入与查询：

- `VECTOR`
- `HALFVEC`
- `SPARSEVEC`

该示例会自动创建测试表 `test_vector`，写入多组向量数据并查询结果。

## 项目结构

```text
xugu-vector-python-demo/
├─ main.py              # 示例入口：建表、插入、查询
└─ xgcondb/             # 数据库驱动包
```

## 环境要求

- Python 2.7 及以上（建议与 `xgcondb` 支持版本匹配）
- 可访问的虚谷数据库实例
- 已具备目标库的建表、删表、插入、查询权限

> 注意：`main.py` 中默认连接参数为本机示例配置，请根据实际环境修改。

## 快速开始

1. 克隆或下载本项目
2. 根据你的数据库环境修改 `main.py` 中连接参数
3. 运行示例脚本

```bash
python main.py
```

## 默认连接参数（`main.py`）

示例中使用如下连接方式：

```python
self.conn = xgcondb.connect(
    host='127.0.0.1',
    port=5138,
    user='SYSDBA',
    password='SYSDBA',
    database='SYSTEM',
    verbose_mode=4,
    charset='gbk',
    datetype='date'
)
```

你通常需要按实际情况调整：

- `host` / `port`：数据库地址与端口
- `user` / `password`：账号密码
- `database`：数据库名
- `charset`：字符集（如 `utf8`、`gbk`）
- `datetype`：日期类型返回形式（示例为 `date`）

## 示例行为说明

脚本执行流程如下：

1. 检查 `test_vector` 表是否存在，若存在则先删除
2. 创建包含 3 种向量列的新表
3. 执行普通插入（直接 SQL 字面量）
4. 执行参数化插入（分别写入 `VECTOR`、`HALFVEC`、`SPARSEVEC`）
5. 查询并打印全部结果

对应表结构：

```sql
create table test_vector(
    id int primary key,
    c1 vector,
    c2 HALFVEC,
    c3 SPARSEVEC
);
```

## 运行成功后可见的输出（示例）

```text
------插入向量数据------
------以参数插入向量数据------
------以参数插入半向量数据------
------以参数插入稀疏向量数据------
------查询向量数据------
[(...查询结果...)]
```

## 常见问题

- 连接失败：请确认数据库服务可用、端口可达、账号密码正确
- 字符集异常：请检查 `charset` 与数据库端配置是否一致
- 权限不足：请确认当前账号拥有 `DROP/CREATE/INSERT/SELECT` 权限
- 版本不支持：请确认当前 Python 小版本在 `xgcondb` 可用范围内

## 说明

本仓库用于演示向量类型能力，建议在测试库中运行，不建议直接对生产库执行删表操作。