# provdb-sdk

**Repository Path**: provdb/provdb-sdk

## Basic Information

- **Project Name**: provdb-sdk
- **Description**: No description available
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2021-09-25
- **Last Updated**: 2023-04-27

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Provdb-sdk 使用说明

| provdb版本号 | 文档维护人 | 文档发布时间  |
| ------------ | ---------- | ------------- |
| V1.5.0       | Tony Wang  | 2021年9月26日 |
| V1.8.0       | 朱金宇     | 2021年11月21日 |
| V1.9.0       | 朱金宇     | 2022年1月19日 |
| V1.9.1       | 朱金宇     | 2022年3月8日 |
| V2.0.0       | 朱金宇     | 2022年3月20日 |

## 图操作接口

### 图的定义

Graph.py , Graph类

图的节点列表形如{node_id1:Node1,node_id2:Node2}

### 溯源图的操作方法

Graph.py ，ProvenanceGraphProxy类

具体API使用说明与2.0版本的新增内容，详见`documents/latest/sdk说明&客户端新功能.md`

### 使用流程

1. 使用 provdb-client 定义数据集、数据源
2. 使用 provdb-client 导入实验数据的tsv文件；您也可以使用provdb-sdk/logger目录下的上传脚本完成原始日志的导入和解析
   - 使用 provdb-sdk/logger 脚本之前，请阅读文档：`documents/latest/日志Parser_开发指南.md`
3. 使用 provdb-client 结束导入阶段、拉取数据集；您也可以使用 provdb-client 推送数据集、导入导出neo4j、查看原始日志、溯源算法可视化等
   - 关于更多 provdb-client 的基础使用说明，请阅读文档：`documents/latest/provdb-client.md`
   - 在v1.9版本之后，普通导出/导入neo4j的方式已被废除，如需使用导入/导出neo4j功能，请务必参考`documents/latest/neo4j_优化路径配置.md`进行配置
4. 您可以利用 provdb-sdk 提供的图结构，完成图结构的增删改查、节点与边的合并等操作
   - 关于v1.9对SDK的更新，请阅读文档：`documents/v1.9_溯源图分块存储优化/v1.9 sdk.md`
5. 在使用过程中你可以设计一些自己的函数。如果你愿意分享自己的函数，可以向我们提交pull request。