Skip to content

Commit

Permalink
improve README and documentation (#8)
Browse files Browse the repository at this point in the history
  • Loading branch information
Leoyoungxh authored Oct 18, 2023
1 parent b4dee2b commit 0436709
Show file tree
Hide file tree
Showing 24 changed files with 58 additions and 392 deletions.
19 changes: 19 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
English | [中文](README.zh_CN.md)

# tRPC-Go Database Plugin

In the daily development process, developers often need to access various storage systems such as MySQL, Redis, Kafka, etc., for database operations. While using open-source SDKs can fulfill the requirements for accessing databases, developers are responsible for handling naming routing, monitoring, and configuration themselves.

Considering that tRPC-Go provides a variety of plugins for naming routing, monitoring, and configuration management, it is possible to wrap open-source SDKs to reuse tRPC-Go's capabilities and reduce redundant code. tRPC-Go offers encapsulation for some open-source SDKs, allowing you to directly leverage tRPC-Go's features for naming routing, monitoring, and more.

| Database | Description |
| :-------: | :---------- |
| bigcache | Wraps the open-source local caching database [Bigcache](https://github.com/allegro/bigcache) |
| clickhouse | Wraps the open-source database [Clickhouse SDK](https://github.com/ClickHouse/clickhouse-go) |
| cos | Wraps Tencent Cloud Object Storage [COS SDK](https://github.com/tencentyun/cos-go-sdk-v5) |
| goredis | Wraps the in-memory database [Redis SDK](https://github.com/redis/go-redis) |
| gorm | Wraps the Golang ORM library [GORM](https://github.com/go-gorm/gorm) |
| hbase | Wraps the open-source database [HBase SDK](https://github.com/tsuna/gohbase) |
| kafka | Wraps the open-source Kafka message queue SDK [Sarama](https://github.com/IBM/sarama) |
| mysql | Wraps the open-source database [MySQL Driver](https://github.com/go-sql-driver/mysql) |
| timer | Local/distributed timer functionality |
19 changes: 19 additions & 0 deletions README.zh_CN.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
[English](README.md) | 中文

# tRPC-Go Database 插件

在日常的开发过程中,开发者经常会访问 MySQL、Redis、Kafka 等存储进行数据库的读写。直接使用开源的 SDK 虽然可以满足访问数据库的需求,但是用户需要自己负责路由寻址、监控上报、配置的开发。

考虑到 tRPC-Go 提供了多种多样的路由寻址、监控上报、配置管理的插件,我们可以封装一下开源的 SDK,复用 tRPC-Go 插件的能力,减少重复代码。tRPC-Go 提供了部分开源 SDK 的封装,可以直接复用 tRPC-Go 的路由寻址、监控上报等功能。

| 数据库 | 描述 |
| :----: | :---- |
| bigcache | 封装开源本地缓存数据库 [Bigcache](https://github.com/allegro/bigcache) |
| clickhouse | 封装开源数据库 [Clickhouse SDK](https://github.com/ClickHouse/clickhouse-go) |
| cos | 封装腾讯云对象存储 [COS SDK](https://github.com/tencentyun/cos-go-sdk-v5) |
| goredis | 封装内存数据库 [Redis SDK](https://github.com/redis/go-redis) |
| gorm | 封装 Golang ORM 库 [GORM](https://github.com/go-gorm/gorm) |
| hbase | 封装开源数据库 [HBase SDK](https://github.com/tsuna/gohbase) |
| kafka | 封装开源消息队列 Kafka SDK [Sarama](https://github.com/IBM/sarama) |
| mysql | 封装开源数据库 [Mysql Driver](https://github.com/go-sql-driver/mysql) |
| timer | 本地/分布式定时器 |
2 changes: 2 additions & 0 deletions bigcache/README_ZH.md → bigcache/README.zh_CN.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
[English](README.md) | 中文

# tRPC-Go bigcache 插件

封装社区的 [bigcache](https://github.com/allegro/bigcache) ,配合 trpc 使用。
Expand Down
30 changes: 0 additions & 30 deletions bigcache/compare_test/README.md

This file was deleted.

27 changes: 0 additions & 27 deletions bigcache/compare_test/README_ZH.md

This file was deleted.

12 changes: 0 additions & 12 deletions bigcache/compare_test/go.mod

This file was deleted.

135 changes: 0 additions & 135 deletions bigcache/compare_test/go.sum

This file was deleted.

Loading

0 comments on commit 0436709

Please sign in to comment.