-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
* add mongodb * revert cover.out * update LICENSE and fix variable name * update comments
- Loading branch information
Showing
26 changed files
with
6,333 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| name: Mongodb Pull Request Check | ||
| on: | ||
| pull_request: | ||
| paths: | ||
| - 'mongodb/**' | ||
| - '.github/workflows/mongodb.yml' | ||
| push: | ||
| paths: | ||
| - 'mongodb/**' | ||
| - '.github/workflows/mongodb.yml' | ||
| workflow_dispatch: | ||
| permissions: | ||
| contents: read | ||
| jobs: | ||
| build: | ||
| name: build | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| - uses: actions/setup-go@v4 | ||
| with: | ||
| go-version: 1.19 | ||
| - name: Build | ||
| run: cd mongodb && go build -v ./... | ||
| - name: Test | ||
| run: cd mongodb && go test -v -coverprofile=coverage.out -gcflags=all=-l -run Unit ./... | ||
| - name: Upload coverage reports to Codecov | ||
| uses: codecov/codecov-action@v3 | ||
| with: | ||
| files: ./mongodb/coverage.out | ||
| flags: mongodb | ||
| env: | ||
| CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| # Change Log |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,97 @@ | ||
| English | [中文](README.zh_CN.md) | ||
|
|
||
| # tRPC-Go mongodb plugin | ||
| [](http://devops.oa.com/ms/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-d7b163d3830a429e976bf77e2409c6d3/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject) | ||
|
|
||
| Base on community [mongo](https://go.mongodb.org/mongo-driver/mongo), used with trpc. | ||
|
|
||
| ## mongodb client | ||
| ```yaml | ||
| client: # Backend configuration for client calls. | ||
| service: # Configuration for the backend. | ||
| - name: trpc.mongodb.xxx.xxx | ||
| target: mongodb://user:passwd@vip:port # mongodb standard uri：mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]] | ||
| timeout: 800 # The maximum processing time of the current request. | ||
| - name: trpc.mongodb.xxx.xxx1 | ||
| target: mongodb+polaris://user:passwd@polaris_name # mongodb+polaris means that the host in the mongodb uri will perform Polaris analysis. | ||
| timeout: 800 # The maximum processing time of the current request. | ||
| ``` | ||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "go.mongodb.org/mongo-driver/bson" | ||
| "go.mongodb.org/mongo-driver/mongo" | ||
| "go.mongodb.org/mongo-driver/mongo/options" | ||
| "trpc.group/trpc-go/trpc-database/mongodb" | ||
| "trpc.group/trpc-go/trpc-go/log" | ||
| ) | ||
|
|
||
| // BattleFlow is battle information. | ||
| type BattleInfo struct { | ||
| Id string `bson:"_id,omitempty"` | ||
| Ctime uint32 `bson:"ctime,omitempty" json:"ctime,omitempty"` | ||
| } | ||
|
|
||
| func (s *server) SayHello(ctx context.Context, req *pb.ReqBody, rsp *pb.RspBody) (err error) { | ||
| proxy := mongodb.NewClientProxy("trpc.mongodb.xxx.xxx") // Your custom service name，used for monitoring, reporting and mapping configuration. | ||
|
|
||
| // mongodb insert | ||
| _, err = proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key2", "value": "v2"}) | ||
|
|
||
| // mongodb ReplaceOne | ||
| opts := options.Replace().SetUpsert(true) | ||
| filter := bson.D{{"_id", "key1"}} | ||
| _, err := proxy.ReplaceOne(ctx, "database", "table", filter, &BattleInfo{}, opts) | ||
| if err != nil { | ||
| log.Errorf("err=%v, data=%v", err, *battleInfo) | ||
| return err | ||
| } | ||
|
|
||
| // mongodb FindOne | ||
| rst := proxy.FindOne(ctx, "database", "table", bson.D{{"_id", "key1"}}) | ||
| battleInfo = &BattleInfo{} | ||
| err = rst.Decode(battleInfo) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // mongodb transaction | ||
| err = proxy.Transaction(ctx, func(sc mongo.SessionContext) error { | ||
| // The same proxy instance needs to be used during transaction execution. | ||
| _, tErr := proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key1", "value": "v1"}) | ||
| if tErr != nil { | ||
| return tErr | ||
| } | ||
| _, tErr = proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key2", "value": "v2"}) | ||
| if tErr != nil { | ||
| return tErr | ||
| } | ||
| return nil | ||
| }, nil) | ||
|
|
||
| // mongodb RunCommand | ||
| cmdDB := bson.D{} | ||
| cmdDB = append(cmdDB, bson.E{Key: "enableSharding", Value: "dbName"}) | ||
| err = proxy.RunCommand(ctx, "admin", cmdDB).Err() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cmdColl := bson.D{} | ||
| cmdColl = append(cmdColl, bson.E{Key: "shardCollection", Value: "dbName.collectionName"}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "key", Value: bson.D{{"openId", "hashed"}}}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "unique", Value: false}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "numInitialChunks", Value: 10}) | ||
| err = proxy.RunCommand(ctx, "admin", cmdColl).Err() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // Business logic. | ||
| } | ||
| ``` | ||
| ## Frequently Asked Questions (FAQs) | ||
| - Q1: How to configure ClientOptions: | ||
| - A1: When creating a Transport, you can use WithOptionInterceptor to configure ClientOptions. You can refer to options_test.go for more information. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,94 @@ | ||
| # tRPC-Go mongodb 插件 | ||
| [](http://devops.oa.com/ms/process/api-html/user/builds/projects/pcgtrpcproject/pipelines/p-d7b163d3830a429e976bf77e2409c6d3/latestFinished?X-DEVOPS-PROJECT-ID=pcgtrpcproject) | ||
|
|
||
| 封装社区的 [mongo](https://go.mongodb.org/mongo-driver/mongo) ，配合 trpc 使用。 | ||
|
|
||
| ## mongodb client | ||
| ```yaml | ||
| client: #客户端调用的后端配置 | ||
| service: #针对后端的配置 | ||
| - name: trpc.mongodb.xxx.xxx | ||
| target: mongodb://user:passwd@vip:port #mongodb 标准uri：mongodb://[username:password@]host1[:port1][,host2[:port2],...[,hostN[:portN]]][/[database][?options]] | ||
| timeout: 800 #当前这个请求最长处理时间 | ||
| - name: trpc.mongodb.xxx.xxx1 | ||
| target: mongodb+polaris://user:passwd@polaris_name # mongodb+polaris表示mongodb uri中的host会进行北极星解析 | ||
| timeout: 800 # 当前这个请求最长处理时间 | ||
| ``` | ||
| ```go | ||
| package main | ||
|
|
||
| import ( | ||
| "time" | ||
| "context" | ||
|
|
||
| "trpc.group/trpc-go/trpc-database/mongodb" | ||
| "trpc.group/trpc-go/trpc-go/client" | ||
| ) | ||
|
|
||
| // BattleFlow 对局信息 | ||
| type BattleInfo struct { | ||
| Id string `bson:"_id,omitempty" ` | ||
| Ctime uint32 `bson:"ctime,omitempty" json:"ctime,omitempty"` | ||
| } | ||
|
|
||
| func (s *server) SayHello(ctx context.Context, req *pb.ReqBody, rsp *pb.RspBody) (err error) { | ||
| proxy := mongodb.NewClientProxy("trpc.mongodb.xxx.xxx") // service name自己随便填，主要用于监控上报和寻址配置项 | ||
|
|
||
| // mongodb insert | ||
| _, err = proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key2", "value": "v2"}) | ||
|
|
||
| // mongodb ReplaceOne | ||
| opts := options.Replace().SetUpsert(true) | ||
| filter := bson.D{{"_id", "key1"}} | ||
| _, err := proxy.ReplaceOne(ctx, "database", "table", filter, &BattleInfo{}, opts) | ||
| if err != nil { | ||
| log.Errorf("err=%v, data=%v", err, *battleInfo) | ||
| return err | ||
| } | ||
|
|
||
| // mongodb FindOne | ||
| rst := proxy.FindOne(ctx, "database", "table", bson.D{{"_id", "key1"}}) | ||
| battleInfo = &BattleInfo{} | ||
| err = rst.Decode(battleInfo) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| // mongodb transaction | ||
| err = proxy.Transaction(ctx, func(sc mongo.SessionContext) error { | ||
| //事务执行过程中需要使用同一proxy实例执行 | ||
| _, tErr := proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key1", "value": "v1"}) | ||
| if tErr != nil { | ||
| return tErr | ||
| } | ||
| _, tErr = proxy.InsertOne(sc, "database", "table", bson.M{"_id": "key2", "value": "v2"}) | ||
| if tErr != nil { | ||
| return tErr | ||
| } | ||
| return nil | ||
| }, nil) | ||
|
|
||
| // mongodb RunCommand | ||
| cmdDB := bson.D{} | ||
| cmdDB = append(cmdDB, bson.E{Key: "enableSharding", Value: "dbName"}) | ||
| err = proxy.RunCommand(ctx, "admin", cmdDB).Err() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| cmdColl := bson.D{} | ||
| cmdColl = append(cmdColl, bson.E{Key: "shardCollection", Value: "dbName.collectionName"}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "key", Value: bson.D{{"openId", "hashed"}}}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "unique", Value: false}) | ||
| cmdColl = append(cmdColl, bson.E{Key: "numInitialChunks", Value: 10}) | ||
| err = proxy.RunCommand(ctx, "admin", cmdColl).Err() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| // 业务逻辑 | ||
| } | ||
| ``` | ||
| ## 常见问题 | ||
|
|
||
| - Q1: 如何配置 ClientOptions | ||
| - A1: 创建Transport时可以使用WithOptionInterceptor对ClientOptions进行配置，可以参考options_test.go |
Oops, something went wrong.