repository

README

• Repository is a place where you communicate with the real external data source, like database, cloud service, external service, etc.
• You should keep your repository as simple as possible, don't add too much logic here
• If you have to, you can separate the operations into smaller methods, then do the flow in the service package
• You should always call your repository methods inside the service package
• You may use your src/library functions directly in this package
• Any changes outside this package should not affect your repositories (except changes for business entity)
• If you need config variables, database frameworks, or external clients, pass/inject them as dependency
• You can use your own style as long as it doesn't break the main idea

Documentation

Index

• type Example
  • func NewExampleMySQL(param NewExampleMySQLParam) Example
• type ExampleFindAllParam
• type ExampleFindAllResult
• type NewExampleMySQLParam
• type NewParam
• type Repository
  • func New(param NewParam) *Repository

Types

type Example

type Example interface {
	// FindAll finds all example data.
	FindAll(param ExampleFindAllParam) ExampleFindAllResult
}

func NewExampleMySQL

func NewExampleMySQL(param NewExampleMySQLParam) Example

NewExampleMySQL generates new exampleMySQL that implements Example.

type ExampleFindAllParam

type ExampleFindAllParam struct {
	Ctx context.Context // In case you need a context.
}

type ExampleFindAllResult

type ExampleFindAllResult struct {
	Examples []*entity.Example `json:"examples"`
	Error    error             `json:"error"`
}

type NewExampleMySQLParam

type NewExampleMySQLParam struct {
	DB *sql.DB
}

type NewParam

type NewParam struct {
	MySQLDB *sql.DB
}

type Repository

type Repository struct {
	Example Example
}

func New

func New(param NewParam) *Repository

New generates new repository.