diff --git a/README.md b/README.md index 919a6a9..8c3bd78 100644 --- a/README.md +++ b/README.md @@ -1,100 +1 @@ -![license](https://img.shields.io/github/license/dtm-labs/dtm) -![Build Status](https://github.com/dtm-labs/dtm/actions/workflows/tests.yml/badge.svg?branch=main) -[![codecov](https://codecov.io/gh/dtm-labs/dtm/branch/main/graph/badge.svg?token=UKKEYQLP3F)](https://codecov.io/gh/dtm-labs/dtm) -[![Go Report Card](https://goreportcard.com/badge/github.com/dtm-labs/dtm)](https://goreportcard.com/report/github.com/dtm-labs/dtm) -[![Go Reference](https://pkg.go.dev/badge/github.com/dtm-labs/dtm.svg)](https://pkg.go.dev/github.com/dtm-labs/dtm) -[![Mentioned in Awesome Go](https://awesome.re/mentioned-badge-flat.svg)](https://github.com/avelino/awesome-go#database) - -English | [简体中文](https://github.com/dtm-labs/dtm/blob/main/helper/README-cn.md) - -# Distributed Transactions Manager - -## What is DTM - -DTM is a distributed transaction framework which provides cross-service eventual data consistency. It provides saga, tcc, xa, 2-phase message strategies for a variety of application scenarios. It also supports multiple languages and multiple store engine to form up a transaction as following: - -function-picture - -## Who's using DTM (partial) - -[Tencent](https://www.tencent.com/) - -[Ivydad](https://ivydad.com) - -[Eglass](https://epeijing.cn) - -## [Cook Book](https://en.dtm.pub) - -## Quick start - -### run dtm - -``` bash -git clone https://github.com/dtm-labs/dtm && cd dtm -go run main.go -``` - -### Start an example -Suppose we want to perform an inter-bank transfer. The operations of transfer out (TransOut) and transfer in (TransIn) are coded in separate micro-services. - -Here is an example to illustrate a solution of dtm to this problem: - -``` bash -git clone https://github.com/dtm-labs/dtmcli-go-sample && cd dtmcli-go-sample -go run main.go -``` - -## Code - -### Use -``` go - // business micro-service address - const qsBusi = "http://localhost:8081/api/busi_saga" - // The address where DtmServer serves DTM, which is a url - DtmServer := "http://localhost:36789/api/dtmsvr" - req := &gin.H{"amount": 30} // micro-service payload - // DtmServer is the address of DTM micro-service - saga := dtmcli.NewSaga(DtmServer, dtmcli.MustGenGid(DtmServer)). - // add a TransOut subtraction,forward operation with url: qsBusi+"/TransOut", reverse compensation operation with url: qsBusi+"/TransOutCom" - Add(qsBusi+"/TransOut", qsBusi+"/TransOutCom", req). - // add a TransIn subtraction, forward operation with url: qsBusi+"/TransIn", reverse compensation operation with url: qsBusi+"/TransInCom" - Add(qsBusi+"/TransIn", qsBusi+"/TransInCom", req) - // submit the created saga transaction,dtm ensures all subtractions either complete or get revoked - err := saga.Submit() -``` - -When the above code runs, we can see in the console that services TransOut, TransIn has been called. - -#### Timing diagram -A timing diagram for a successfully completed SAGA transaction would be as follows: - -saga-success - -#### Rollback upon failure -If any forward operation fails, DTM invokes the corresponding compensating operation of each sub-transaction to roll back, after which the transaction is successfully rolled back. - -Let's purposely fail the forward operation of the second sub-transaction and watch what happens - -``` go -app.POST(qsBusiAPI+"/TransIn", func(c *gin.Context) { - log.Printf("TransIn") - // c.JSON(200, "") - c.JSON(409, "") // Status 409 for Failure. Won't be retried -}) -``` - -The timing diagram for the intended failure is as follows: - -saga-failed - -## More examples - -Refer to [dtm-examples](https://github.com/dtm-labs/dtm-examples) for more examples. - -## Slack - -You can join the [DTM slack channel here](https://join.slack.com/t/dtm-w6k9662/shared_invite/zt-vkrph4k1-eFqEFnMkbmlXqfUo5GWHWw). - -## Give a star! ⭐ - -If you think this project is interesting, or helpful to you, please give a star! +此仓库应常青藤爸爸公司要求,已停止维护。请移步 [https://github.com/dtm-labs/dtf](https://github.com/dtm-labs/dtf)