models

Documentation

Index

• Variables
• type Model
  • func New(cfg *conf.Config) *Model
• type Note
• type NoteModel
  • func (m *NoteModel) Create(note *Note) error
  • func (m *NoteModel) CreateTx(note *Note, tx *sql.Tx) error
  • func (m *NoteModel) List(recipeID int64) (*Notes, error)
• type Notes
• type Recipe
• type RecipeImage
• type RecipeImageModel
  • func (m *RecipeImageModel) List(recipeID int64) (*RecipeImages, error)
  • func (m *RecipeImageModel) Save(recipeID int64, name string, data []byte) error
• type RecipeImages
• type RecipeModel
  • func (m *RecipeModel) Create(recipe *Recipe) error
  • func (m *RecipeModel) CreateTx(recipe *Recipe, tx *sql.Tx) error
  • func (m *RecipeModel) Delete(id int64) error
  • func (m *RecipeModel) DeleteTx(id int64, tx *sql.Tx) error
  • func (m *RecipeModel) Find(search string, page int64, count int64) (*Recipes, int64, error)
  • func (m *RecipeModel) List(page int64, count int64) (*Recipes, int64, error)
  • func (m *RecipeModel) Read(id int64) (*Recipe, error)
  • func (m *RecipeModel) SetRating(id int64, rating float64) error
  • func (m *RecipeModel) Update(recipe *Recipe) error
  • func (m *RecipeModel) UpdateTx(recipe *Recipe, tx *sql.Tx) error
• type Recipes
• type TagModel
  • func (m *TagModel) Create(recipeID int64, tag string) error
  • func (m *TagModel) CreateTx(recipeID int64, tag string, tx *sql.Tx) error
  • func (m *TagModel) DeleteAll(recipeID int64) error
  • func (m *TagModel) DeleteAllTx(recipeID int64, tx *sql.Tx) error
  • func (m *TagModel) List(recipeID int64) (*[]string, error)

Variables

var ErrNotFound = errors.New("No record found matching supplied criteria")

ErrNotFound represents the error when a database record cannot be found matching the criteria specified by the caller

Types

type Model

type Model struct {
	Recipes *RecipeModel
	Tags    *TagModel
	Notes   *NoteModel
	Images  *RecipeImageModel
	// contains filtered or unexported fields
}

func New

func New(cfg *conf.Config) *Model

type Note

type Note struct {
	ID         int64
	RecipeID   int64
	Note       string
	CreatedAt  time.Time
	ModifiedAt time.Time
}

Note represents an individual comment (or note) on a recipe

type NoteModel

type NoteModel struct {
	*Model
}

func (*NoteModel) Create

func (m *NoteModel) Create(note *Note) error

Create stores the note in the database as a new record using a dedicated transation that is committed if there are not errors.

func (*NoteModel) CreateTx

func (m *NoteModel) CreateTx(note *Note, tx *sql.Tx) error

CreateTx stores the note in the database as a new record using the specified transaction.

func (*NoteModel) List

func (m *NoteModel) List(recipeID int64) (*Notes, error)

List retrieces all notes associated with the recipe with the specified id.

type Notes

type Notes []Note

Notes represents a collection of Note objects

type Recipe

type Recipe struct {
	ID          int64
	Name        string
	Description string
	Ingredients string
	Directions  string
	AvgRating   float64
	Image       string
	Tags        []string
}

Recipe is the primary model class for recipe storage and retrieval

type RecipeImage

type RecipeImage struct {
	RecipeID     int64
	URL          string
	ThumbnailURL string
}

type RecipeImageModel

type RecipeImageModel struct {
	*Model
}

func (*RecipeImageModel) List

func (m *RecipeImageModel) List(recipeID int64) (*RecipeImages, error)

func (*RecipeImageModel) Save

func (m *RecipeImageModel) Save(recipeID int64, name string, data []byte) error

type RecipeImages

type RecipeImages []RecipeImage

type RecipeModel

type RecipeModel struct {
	*Model
}

func (*RecipeModel) Create

func (m *RecipeModel) Create(recipe *Recipe) error

Create stores the recipe in the database as a new record using a dedicated transation that is committed if there are not errors.

func (*RecipeModel) CreateTx

func (m *RecipeModel) CreateTx(recipe *Recipe, tx *sql.Tx) error

CreateTx stores the recipe in the database as a new record using the specified transaction.

func (*RecipeModel) Delete

func (m *RecipeModel) Delete(id int64) error

func (*RecipeModel) DeleteTx

func (m *RecipeModel) DeleteTx(id int64, tx *sql.Tx) error

func (*RecipeModel) Find

func (m *RecipeModel) Find(search string, page int64, count int64) (*Recipes, int64, error)

func (*RecipeModel) List

func (m *RecipeModel) List(page int64, count int64) (*Recipes, int64, error)

func (*RecipeModel) Read

func (m *RecipeModel) Read(id int64) (*Recipe, error)

Read retrieves the information about the recipe from the database, if found. If no recipe exists with the specified ID, a NoRecordFound error is returned.

func (*RecipeModel) SetRating

func (m *RecipeModel) SetRating(id int64, rating float64) error

func (*RecipeModel) Update

func (m *RecipeModel) Update(recipe *Recipe) error

Update stores the specified recipe in the database by updating the existing record with the sepcified id using a dedicated transation that is committed if there are not errors.

func (*RecipeModel) UpdateTx

func (m *RecipeModel) UpdateTx(recipe *Recipe, tx *sql.Tx) error

UpdateTx stores the specified recipe in the database by updating the existing record with the sepcified id using the specified transaction.

type Recipes

type Recipes []Recipe

Recipes represents a collection of Recipe objects

type TagModel

type TagModel struct {
	*Model
}

func (*TagModel) Create

func (m *TagModel) Create(recipeID int64, tag string) error

func (*TagModel) CreateTx

func (m *TagModel) CreateTx(recipeID int64, tag string, tx *sql.Tx) error

func (*TagModel) DeleteAll

func (m *TagModel) DeleteAll(recipeID int64) error

func (*TagModel) DeleteAllTx

func (m *TagModel) DeleteAllTx(recipeID int64, tx *sql.Tx) error

func (*TagModel) List

func (m *TagModel) List(recipeID int64) (*[]string, error)