api

Documentation

Index

• type API
  • func Setup(ctx context.Context, cfg *config.Config, r *mux.Router, rdsStore RDSAreaStore) (*API, error)
• type RDSAreaStore

Types

type API

type API struct {
	Router  *mux.Router
	GeoData map[string]models.AreasDataResults
	// contains filtered or unexported fields
}

API provides a struct to wrap the api around

func Setup

func Setup(ctx context.Context, cfg *config.Config, r *mux.Router, rdsStore RDSAreaStore) (*API, error)

Setup function sets up the api and returns an api

type RDSAreaStore

type RDSAreaStore interface {
	Init(ctx context.Context, cfg *config.Config) error
	Close()
	GetRelationships(areaCode, relationshipParameter string) ([]*models.AreaBasicData, error)
	ValidateArea(code string) error
	GetArea(ctx context.Context, areaId string) (*models.AreasDataResults, error)
	BuildTables(ctx context.Context, executionList []string) error
	Ping(ctx context.Context) error
	UpsertArea(ctx context.Context, area models.AreaParams) (bool, error)
	GetAncestors(areaID string) ([]models.AreasAncestors, error)
}

RDSAreaStore represents all the required methods from aurora DB