README
¶
go-bigtx
Simple two phase commits implementation on MongoDB with Golang
Goal
This library tries to implement two phase commits on MongoDB to process multi- account transactions. For example:
Debit Credit
Cash 100
Inventory 80
Profit 20
This transaction applies to 3 accounts and 1 transaction document.
To-do
- Recovery
- Rollback
Reference
The implementation follows the tutorial from MongoDB website.
Legal
This application is developed under MIT license, and can be used for open and proprietary projects.
Copyright (c) 2015 Chaiwat Shuetrakoonpaiboon
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Documentation
¶
Index ¶
- Constants
- func Apply(session *mgo.Session, tx *Transaction) error
- func BeginTransaction(txn string, debit map[string]int64, credit map[string]int64, note string) (string, error)
- func CommitTransaction() error
- func Connect()
- func CreateAccount(acID string, side AccountSide) error
- func Disconnect()
- func IsDuplicatedAcctErr(err error) bool
- func IsUnbalancedErr(err error) bool
- func MarkDone(session *mgo.Session, tx *Transaction) error
- func ReadBalance(account string) (int64, error)
- func Recover() error
- type Account
- type AccountSide
- type Transaction
- type TxState
Constants ¶
const ( TxInitial TxState = "init" TxPending = "pend" TxApplied = "appl" TxDone = "done" TxCanceling = "cing" TxCanceled = "canc" )
Variables ¶
This section is empty.
Functions ¶
func Apply ¶
func Apply(session *mgo.Session, tx *Transaction) error
func BeginTransaction ¶
func CommitTransaction ¶
func CommitTransaction() error
func CreateAccount ¶
func CreateAccount(acID string, side AccountSide) error
func Disconnect ¶
func Disconnect()
func IsDuplicatedAcctErr ¶
func IsUnbalancedErr ¶
func MarkDone ¶
func MarkDone(session *mgo.Session, tx *Transaction) error
func ReadBalance ¶
Types ¶
type AccountSide ¶
type AccountSide string
const ( AccountSideDebit AccountSide = "dbt" AccountSideCredit = "crd" )
Source Files