gorm_seeder

README

Simple Gorm seeder

Description

Simple Gorm seeder package

Download

go get -u github.com/kachit/gorm-seeder

Usage

package main

import (
    "fmt"
    "github.com/kachit/gorm-seeder"
    "gorm.io/driver/postgres"
    "gorm.io/gorm"
    "time"
)

//Init model
type User struct {
    Id          uint64 `json:"id" gorm:"primaryKey"`
    Name        string `json:"name"`
    Email        string `json:"email"`
    Password       string `json:"password"`
    CreatedAt  time.Time      `json:"created_at"`
}

func (u *User) BeforeCreate(tx *gorm.DB) (err error) {
    u.CreatedAt = time.Now().UTC()
    return
}

// TableName overrides
func (User) TableName() string {
    return "users"
}

//Create new seeder instance of gorm_seeder.SeederInterface
type UsersSeeder struct {
    gorm_seeder.SeederAbstract
}

func NewUsersSeeder(cfg gorm_seeder.SeederConfiguration) UsersSeeder {
    return UsersSeeder{gorm_seeder.NewSeederAbstract(cfg)}
}

//Implement Seed method
func (s *UsersSeeder) Seed(db *gorm.DB) error {
    var users []User
    for i := 0; i < s.Configuration.Rows; i++ {
        indexStr := fmt.Sprint(i)
        user := User{
            Name: "Name LastName" + indexStr,
            Email: "foo" + indexStr + "@bar.gov",
            Password: "password-hash-string" + indexStr,
        }
        users = append(users, user)
    }
    return db.CreateInBatches(users, s.Configuration.Rows).Error
}

//Implement Clear method
func (s *UsersSeeder) Clear(db *gorm.DB) error {
    entity := User{}
    return s.SeederAbstract.Delete(db, entity.TableName())
}

func main(){
    //Init DB connection
    db, _ := gorm.Open(postgres.New(postgres.Config{
        DSN: "DSN connection string",
    }))

    //Build seeders stack
    usersSeeder := NewUsersSeeder(gorm_seeder.SeederConfiguration{Rows: 10})
    seedersStack := gorm_seeder.NewSeedersStack(db)
    seedersStack.AddSeeder(&usersSeeder)

    //Apply seed
    err := seedersStack.Seed()
    fmt.Println(err)

    //Apply clear
    err = seedersStack.Clear()
    fmt.Println(err)
}

Documentation

Index

• type SeederAbstract
  • func NewSeederAbstract(cfg SeederConfiguration) SeederAbstract
  • func (sa *SeederAbstract) Delete(db *gorm.DB, table string) error
  • func (sa *SeederAbstract) Truncate(db *gorm.DB, table string) error
• type SeederConfiguration
• type SeederInterface
• type SeedersStack
  • func NewSeedersStack(db *gorm.DB) *SeedersStack
  • func (ss *SeedersStack) AddSeeder(seeder SeederInterface) *SeedersStack
  • func (ss *SeedersStack) Clear() error
  • func (ss *SeedersStack) Seed() error

Types

type SeederAbstract

type SeederAbstract struct {
	Configuration SeederConfiguration
}

SeederAbstract struct

func NewSeederAbstract

func NewSeederAbstract(cfg SeederConfiguration) SeederAbstract

NewSeederAbstract function

func (*SeederAbstract) Delete

func (sa *SeederAbstract) Delete(db *gorm.DB, table string) error

Delete method

func (*SeederAbstract) Truncate

func (sa *SeederAbstract) Truncate(db *gorm.DB, table string) error

Truncate method

type SeederConfiguration

type SeederConfiguration struct {
	Rows int
}

SeederConfiguration struct

type SeederInterface

type SeederInterface interface {
	Seed(db *gorm.DB) error
	Clear(db *gorm.DB) error
}

SeederInterface interface

type SeedersStack

type SeedersStack struct {
	// contains filtered or unexported fields
}

SeedersStack struct

func NewSeedersStack

func NewSeedersStack(db *gorm.DB) *SeedersStack

NewSeedersStack function

func (*SeedersStack) AddSeeder

func (ss *SeedersStack) AddSeeder(seeder SeederInterface) *SeedersStack

AddSeeder method

func (*SeedersStack) Clear

func (ss *SeedersStack) Clear() error

Clear method

func (*SeedersStack) Seed

func (ss *SeedersStack) Seed() error

Seed method