Skip to content

Commit 0b7a46d

Browse files
committed
Add a better example to the README, use constanst in the example.
Signed-off-by: Manuel Carmona <manu.carmona90@gmail.com>
1 parent e8b1933 commit 0b7a46d

File tree

2 files changed

+45
-19
lines changed

2 files changed

+45
-19
lines changed

README.md

Lines changed: 42 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -45,26 +45,52 @@ We are continuously adding more functionality to go-mysql-server. We support a s
4545

4646
```go
4747
...
48-
driver := sqle.New()
49-
driver.AddDatabase(createTestDatabase())
50-
51-
auth := mysql.NewAuthServerStatic()
52-
auth.Entries["user"] = []*mysql.AuthServerStaticEntry{{
53-
Password: "pass",
54-
}}
55-
56-
config := server.Config{
57-
Protocol: "tcp",
58-
Address: "localhost:3306",
59-
Auth: auth,
48+
49+
func main() {
50+
driver := sqle.New()
51+
driver.AddDatabase(createTestDatabase())
52+
53+
auth := mysql.NewAuthServerStatic()
54+
auth.Entries["user"] = []*mysql.AuthServerStaticEntry{{
55+
Password: "pass",
56+
}}
57+
58+
config := server.Config{
59+
Protocol: "tcp",
60+
Address: "localhost:3306",
61+
Auth: auth,
62+
}
63+
64+
s, err := server.NewDefaultServer(config, driver)
65+
if err != nil {
66+
panic(err)
67+
}
68+
69+
s.Start()
6070
}
6171

62-
s, err := server.NewDefaultServer(config, driver)
63-
if err != nil {
64-
panic(err)
72+
func createTestDatabase() *mem.Database {
73+
const (
74+
dbName = "test"
75+
tableName = "mytable"
76+
)
77+
78+
db := mem.NewDatabase(dbName).(*mem.Database)
79+
table := mem.NewTable(tableName, sql.Schema{
80+
{Name: "name", Type: sql.Text, Nullable: false, Source: tableName},
81+
{Name: "email", Type: sql.Text, Nullable: false, Source: tableName},
82+
{Name: "phone_numbers", Type: sql.JSON, Nullable: false, Source: tableName},
83+
{Name: "created_at", Type: sql.Timestamp, Nullable: false, Source: tableName},
84+
})
85+
86+
db.AddTable(tableName, table)
87+
table.Insert(sql.NewRow("John Doe", "john@doe.com", []string{"555-555-555"}, time.Now()))
88+
table.Insert(sql.NewRow("John Doe", "johnalt@doe.com", []string{}, time.Now()))
89+
table.Insert(sql.NewRow("Jane Doe", "jane@doe.com", []string{}, time.Now()))
90+
table.Insert(sql.NewRow("Evil Bob", "evilbob@gmail.com", []string{"555-666-555", "666-666-666"}, time.Now()))
91+
return db
6592
}
6693

67-
s.Start()
6894
...
6995
```
7096

_example/main.go

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -52,15 +52,15 @@ func createTestDatabase() *mem.Database {
5252
tableName = "mytable"
5353
)
5454

55-
db := mem.NewDatabase("test").(*mem.Database)
56-
table := mem.NewTable("mytable", sql.Schema{
55+
db := mem.NewDatabase(dbName).(*mem.Database)
56+
table := mem.NewTable(tableName, sql.Schema{
5757
{Name: "name", Type: sql.Text, Nullable: false, Source: tableName},
5858
{Name: "email", Type: sql.Text, Nullable: false, Source: tableName},
5959
{Name: "phone_numbers", Type: sql.JSON, Nullable: false, Source: tableName},
6060
{Name: "created_at", Type: sql.Timestamp, Nullable: false, Source: tableName},
6161
})
6262

63-
db.AddTable("mytable", table)
63+
db.AddTable(tableName, table)
6464
table.Insert(sql.NewRow("John Doe", "john@doe.com", []string{"555-555-555"}, time.Now()))
6565
table.Insert(sql.NewRow("John Doe", "johnalt@doe.com", []string{}, time.Now()))
6666
table.Insert(sql.NewRow("Jane Doe", "jane@doe.com", []string{}, time.Now()))

0 commit comments

Comments
 (0)