tidb-lite is a package, we can use this package to create a TiDB server with mocktikv mode in your application or unit test.
-
func NewTiDBServer(options *Options) (*TiDBServer, error)
Create a TiDB Server, can use options to set the path which used to save db's data and this server's port.
-
func GetTiDBServer() (*TiDBServer, error)
Get the exist TiDB Server.
-
func (t *TiDBServer) CreateConn() (*sql.DB, error)
Create a database connection.
-
func (t *TiDBServer) Close()
Close TiDB Server.
-
func (t *TiDBServer) CloseGracefully()
Close TiDB server gracefully.
We can read the code under example.go to know how to use tidb-lite.
In example.go defines a function GetRowCount to calculate the count of a table with condition.
In example_test.go use code below to create a TiDB server and get the database's connection used for unit test.
tidbServer, err := tidblite.NewTiDBServer(tidblite.NewOptions(c.MkDir()))
c.Assert(err, IsNil)
defer tidbServer.Close()
dbConn, err := tidbServer.CreateConn()
c.Assert(err, IsNil)
And then we can use the dbConn to generate test data, and then check function GetRowCount's correctness.
tidb-lite only allows one TiDB instance to run at a time. You need to make sure that the existing TiDB instance is closed before creating a new instance.