route/vendor/github.com/asdine/storm/examples_test.go

550 lines
9.6 KiB
Go
Raw Normal View History

2017-10-06 15:29:20 +00:00
package storm_test
import (
"fmt"
"io/ioutil"
"log"
"os"
"path/filepath"
"strings"
"time"
"github.com/asdine/storm"
2018-01-03 19:29:07 +00:00
"github.com/asdine/storm/codec/gob"
"github.com/coreos/bbolt"
2017-10-06 15:29:20 +00:00
)
func ExampleDB_Save() {
dir, _ := ioutil.TempDir(os.TempDir(), "storm")
defer os.RemoveAll(dir)
type User struct {
2018-01-03 19:29:07 +00:00
ID int `storm:"id,increment"` // the increment tag will auto-increment integer IDs without existing values.
2017-10-06 15:29:20 +00:00
Group string `storm:"index"`
Email string `storm:"unique"`
Name string
Age int `storm:"index"`
CreatedAt time.Time `storm:"index"`
}
// Open takes an optional list of options as the last argument.
2018-01-03 19:29:07 +00:00
db, _ := storm.Open(filepath.Join(dir, "storm.db"), storm.Codec(gob.Codec))
2017-10-06 15:29:20 +00:00
defer db.Close()
user := User{
Group: "staff",
Email: "john@provider.com",
Name: "John",
Age: 21,
CreatedAt: time.Now(),
}
err := db.Save(&user)
if err != nil {
log.Fatal(err)
}
fmt.Println(user.ID)
user2 := user
user2.ID = 0
// Save will fail because of the unique constraint on Email
err = db.Save(&user2)
fmt.Println(err)
// Output:
// 1
// already exists
}
func ExampleDB_One() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var user User
err := db.One("Email", "john@provider.com", &user)
if err != nil {
log.Fatal(err)
}
// also works on unindexed fields
err = db.One("Name", "John", &user)
if err != nil {
log.Fatal(err)
}
err = db.One("Name", "Jack", &user)
fmt.Println(err)
// Output:
// not found
}
func ExampleDB_Find() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.Find("Group", "staff", &users)
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 3
}
func ExampleDB_All() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.All(&users)
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 3
}
func ExampleDB_AllByIndex() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.AllByIndex("CreatedAt", &users)
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 3
}
func ExampleDB_Range() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.Range("Age", 21, 22, &users)
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 2
}
func ExampleLimit() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.All(&users, storm.Limit(2))
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 2
}
func ExampleSkip() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var users []User
err := db.All(&users, storm.Skip(1))
if err != nil {
log.Fatal(err)
}
fmt.Println("Found", len(users))
// Output:
// Found 2
}
func ExampleUseDB() {
dir, _ := ioutil.TempDir(os.TempDir(), "storm")
defer os.RemoveAll(dir)
bDB, err := bolt.Open(filepath.Join(dir, "bolt.db"), 0600, &bolt.Options{Timeout: 10 * time.Second})
if err != nil {
log.Fatal(err)
}
db, _ := storm.Open("", storm.UseDB(bDB))
defer db.Close()
err = db.Save(&User{ID: 10})
if err != nil {
log.Fatal(err)
}
var user User
err = db.One("ID", 10, &user)
fmt.Println(err)
// Output:
// <nil>
}
func ExampleDB_DeleteStruct() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var user User
err := db.One("ID", 1, &user)
if err != nil {
log.Fatal(err)
}
err = db.DeleteStruct(&user)
fmt.Println(err)
// Output:
// <nil>
}
func ExampleDB_Begin() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
// both start out with a balance of 10000 cents
var account1, account2 Account
tx, err := db.Begin(true)
if err != nil {
log.Fatal(err)
}
defer tx.Rollback()
err = tx.One("ID", 1, &account1)
if err != nil {
log.Fatal(err)
}
err = tx.One("ID", 2, &account2)
if err != nil {
log.Fatal(err)
}
account1.Amount -= 1000
account2.Amount += 1000
err = tx.Save(&account1)
if err != nil {
log.Fatal(err)
}
err = tx.Save(&account2)
if err != nil {
log.Fatal(err)
}
tx.Commit()
var account1Reloaded, account2Reloaded Account
err = db.One("ID", 1, &account1Reloaded)
if err != nil {
log.Fatal(err)
}
err = db.One("ID", 2, &account2Reloaded)
if err != nil {
log.Fatal(err)
}
fmt.Println("Amount in account 1:", account1Reloaded.Amount)
fmt.Println("Amount in account 2:", account2Reloaded.Amount)
// Output:
// Amount in account 1: 9000
// Amount in account 2: 11000
}
func ExampleDB_From() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
// Create some sub buckets to partition the data.
privateNotes := db.From("notes", "private")
workNotes := db.From("notes", "work")
err := privateNotes.Save(&Note{ID: "private1", Text: "This is some private text."})
if err != nil {
log.Fatal(err)
}
err = workNotes.Save(&Note{ID: "work1", Text: "Work related."})
if err != nil {
log.Fatal(err)
}
var privateNote, workNote, personalNote Note
err = privateNotes.One("ID", "work1", &workNote)
// Not found: Wrong bucket.
fmt.Println(err)
err = workNotes.One("ID", "work1", &workNote)
if err != nil {
log.Fatal(err)
}
err = privateNotes.One("ID", "private1", &privateNote)
if err != nil {
log.Fatal(err)
}
fmt.Println(workNote.Text)
fmt.Println(privateNote.Text)
// These can be nested further if needed:
personalNotes := privateNotes.From("personal")
err = personalNotes.Save(&Note{ID: "personal1", Text: "This is some very personal text."})
if err != nil {
log.Fatal(err)
}
err = personalNotes.One("ID", "personal1", &personalNote)
if err != nil {
log.Fatal(err)
}
fmt.Println(personalNote.Text)
// Output:
// not found
// Work related.
// This is some private text.
// This is some very personal text.
}
func ExampleDB_Drop() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
var user User
err := db.One("Email", "john@provider.com", &user)
if err != nil {
log.Fatal(err)
}
err = db.Drop("User")
if err != nil {
log.Fatal(err)
}
// One only works for indexed fields.
err = db.One("Email", "john@provider.com", &user)
fmt.Println(err)
// Output:
// not found
}
func ExampleNode_PrefixScan() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
// The PrefixScan method is available on both DB and Node.
// This example shows the usage on Node.
// The Node notes will be the top-level bucket.
notes := db.From("notes")
// Partition the notes in one bucket per month.
for i := 2014; i <= 2016; i++ {
for j := 1; j <= 12; j++ {
bucket := notes.From(fmt.Sprintf("%d%02d", i, j))
numNotes := 2
// Add some variation.
if j%3 == 0 {
numNotes = 3
}
for k := 0; k < numNotes; k++ {
noteID := fmt.Sprintf("%d-%d", j, k)
if err := bucket.Save(&Note{ID: noteID, Text: fmt.Sprintf("Note %s", noteID)}); err != nil {
log.Fatal(err)
}
}
}
}
// There are now three years worth of notes. Let's look at 2016:
nodes := notes.PrefixScan("2016")
fmt.Println("Note buckets in 2016:", len(nodes))
march := notes.PrefixScan("201603")[0]
// The two below points to the same bucket:
fmt.Println("Bucket", march.Bucket()[1])
fmt.Println("Bucket", nodes[2].Bucket()[1])
count, err := march.Count(&Note{})
if err != nil {
log.Fatal(err)
}
fmt.Println("Notes in March:", count)
// Output:
//Note buckets in 2016: 12
//Bucket 201603
//Bucket 201603
//Notes in March: 3
}
func ExampleNode_RangeScan() {
dir, db := prepareDB()
defer os.RemoveAll(dir)
defer db.Close()
// The RangeScan method is available on both DB and Node.
// This example shows the usage on Node.
// The Node notes will be the top-level bucket.
notes := db.From("notes")
// Partition the notes in one bucket per month.
for i := 2013; i <= 2016; i++ {
for j := 1; j <= 12; j++ {
for k := 0; k < 3; k++ {
// Must left-pad the month so it is sortable.
bucket := notes.From(fmt.Sprintf("%d%02d", i, j))
noteID := fmt.Sprintf("%d-%d", j, k)
if err := bucket.Save(&Note{ID: noteID, Text: fmt.Sprintf("Note %s", noteID)}); err != nil {
log.Fatal(err)
}
}
}
}
// There are now four years worth of notes. Let's look at first half of 2014:
nodes := notes.RangeScan("201401", "201406")
fmt.Println("Note buckets in first half of 2014:", len(nodes))
notesCount, err := nodes[0].Count(&Note{})
if err != nil {
log.Fatal(err)
}
fmt.Println("Notes in bucket:", notesCount)
// Output:
// Note buckets in first half of 2014: 6
// Notes in bucket: 3
}
type User struct {
2018-01-03 19:29:07 +00:00
ID int `storm:"id,increment"`
2017-10-06 15:29:20 +00:00
Group string `storm:"index"`
Email string `storm:"unique"`
Name string
Age int `storm:"index"`
CreatedAt time.Time `storm:"index"`
}
type Account struct {
2018-01-03 19:29:07 +00:00
ID int `storm:"id,increment"`
2017-10-06 15:29:20 +00:00
Amount int64 // amount in cents
}
type Note struct {
ID string `storm:"id"`
Text string
}
func prepareDB() (string, *storm.DB) {
dir, _ := ioutil.TempDir(os.TempDir(), "storm")
2018-01-03 19:29:07 +00:00
db, _ := storm.Open(filepath.Join(dir, "storm.db"))
2017-10-06 15:29:20 +00:00
for i, name := range []string{"John", "Eric", "Dilbert"} {
email := strings.ToLower(name + "@provider.com")
user := User{
Group: "staff",
Email: email,
Name: name,
Age: 21 + i,
CreatedAt: time.Now(),
}
err := db.Save(&user)
if err != nil {
log.Fatal(err)
}
}
for i := int64(0); i < 10; i++ {
account := Account{Amount: 10000}
err := db.Save(&account)
if err != nil {
log.Fatal(err)
}
}
return dir, db
}