datastore

Documentation

Index

• Constants
• type Tenant
• type TenantAsSelectOption
• type TenantComment
• type TenantListFilter
• type TenantListResult
• type TenantStorer
  • func NewDatastore(appCfg *c.Conf, loggerp *slog.Logger, client *mongo.Client) TenantStorer
• type TenantStorerImpl
  • func (impl TenantStorerImpl) Create(ctx context.Context, u *Tenant) error
  • func (impl TenantStorerImpl) DeleteByID(ctx context.Context, id primitive.ObjectID) error
  • func (impl TenantStorerImpl) GetByID(ctx context.Context, id primitive.ObjectID) (*Tenant, error)
  • func (impl TenantStorerImpl) GetByPublicID(ctx context.Context, oldID uint64) (*Tenant, error)
  • func (impl TenantStorerImpl) GetBySchemaName(ctx context.Context, schemaName string) (*Tenant, error)
  • func (impl TenantStorerImpl) GetLatest(ctx context.Context) (*Tenant, error)
  • func (impl TenantStorerImpl) ListAsSelectOptionByFilter(ctx context.Context, f *TenantListFilter) ([]*TenantAsSelectOption, error)
  • func (impl TenantStorerImpl) ListByFilter(ctx context.Context, f *TenantListFilter) (*TenantListResult, error)
  • func (impl TenantStorerImpl) UpdateByID(ctx context.Context, m *Tenant) error

Constants

const (
	TenantPendingStatus  = 1
	TenantActiveStatus   = 2
	TenantErrorStatus    = 3
	TenantArchivedStatus = 4
	RootType             = 1
	RetailerType         = 2
)

Types

type Tenant

type Tenant struct {
	ID                      primitive.ObjectID `bson:"_id" json:"id"`
	Uuid                    string             `bson:"uuid" json:"uuid"`
	SchemaName              string             `bson:"schema_name" json:"schema_name"`
	AlternateName           string             `bson:"alternate_name" json:"alternate_name"`
	Description             string             `bson:"description" json:"description"`
	Name                    string             `bson:"name" json:"name"`
	Url                     string             `bson:"url" json:"url"`
	Status                  int8               `bson:"status" json:"status"`
	Timezone                string             `bson:"timestamp" json:"timestamp"`
	CreatedAt               time.Time          `bson:"created_at" json:"created_at"`
	CreatedByUserID         primitive.ObjectID `bson:"created_by_user_id" json:"created_by_user_id,omitempty"`
	CreatedByUserName       string             `bson:"created_by_user_name" json:"created_by_user_name"`
	CreatedFromIPAddress    string             `bson:"created_from_ip_address" json:"created_from_ip_address"`
	ModifiedAt              time.Time          `bson:"modified_at" json:"modified_at"`
	ModifiedByUserID        primitive.ObjectID `bson:"modified_by_user_id" json:"modified_by_user_id,omitempty"`
	ModifiedByUserName      string             `bson:"modified_by_user_name" json:"modified_by_user_name"`
	ModifiedFromIPAddress   string             `bson:"modified_from_ip_address" json:"modified_from_ip_address"`
	AddressCountry          string             `bson:"address_country" json:"address_country"`
	AddressRegion           string             `bson:"address_region" json:"address_region"`
	AddressLocality         string             `bson:"address_locality" json:"address_locality"`
	PostOfficeBoxNumber     string             `bson:"post_office_box_number" json:"post_office_box_number"`
	PostalCode              string             `bson:"postal_code" json:"postal_code"`
	StreetAddress           string             `bson:"street_address" json:"street_address"`
	StreetAddressExtra      string             `bson:"street_address_extra" json:"street_address_extra"`
	Elevation               float64            `bson:"elevation" json:"elevation"`
	Latitude                float64            `bson:"latitude" json:"latitude"`
	Longitude               float64            `bson:"longitude" json:"longitude"`
	AreaServed              string             `bson:"area_served" json:"area_served"`
	AvailableLanguage       string             `bson:"available_language" json:"available_language"`
	ContactType             string             `bson:"contact_type" json:"contact_type"`
	Email                   string             `bson:"email" json:"email"`
	FaxNumber               string             `bson:"fax_number" json:"fax_number"`
	Telephone               string             `bson:"telephone" json:"telephone"`
	TelephoneType           int8               `bson:"telephone_type" json:"telephone_type"`
	TelephoneExtension      string             `bson:"telephone_extension" json:"telephone_extension"`
	OtherTelephone          string             `bson:"other_telephone" json:"other_telephone"`
	OtherTelephoneExtension string             `bson:"other_telephone_extension" json:"other_telephone_extension"`
	OtherTelephoneType      int8               `bson:"other_telephone_type" json:"other_telephone_type"`
	PublicID                uint64             `bson:"public_id" json:"public_id"`
	Comments                []*TenantComment   `bson:"comments" json:"comments"`
}

type TenantAsSelectOption

type TenantAsSelectOption struct {
	Value primitive.ObjectID `bson:"_id" json:"value"` // Extract from the database `_id` field and output through API as `value`.
	Label string             `bson:"name" json:"label"`
}

type TenantComment

type TenantComment struct {
	ID               primitive.ObjectID `bson:"_id" json:"id"`
	TenantID         primitive.ObjectID `bson:"tenant_id" json:"tenant_id"`
	CreatedAt        time.Time          `bson:"created_at,omitempty" json:"created_at,omitempty"`
	CreatedByUserID  primitive.ObjectID `bson:"created_by_user_id" json:"created_by_user_id"`
	CreatedByName    string             `bson:"created_by_name" json:"created_by_name"`
	ModifiedAt       time.Time          `bson:"modified_at,omitempty" json:"modified_at,omitempty"`
	ModifiedByUserID primitive.ObjectID `bson:"modified_by_user_id" json:"modified_by_user_id"`
	ModifiedByName   string             `bson:"modified_by_name" json:"modified_by_name"`
	Content          string             `bson:"content" json:"content"`
	PublicID         uint64             `bson:"public_id" json:"public_id"`
}

type TenantListFilter

type TenantListFilter struct {
	// Pagination related.
	Cursor    primitive.ObjectID
	PageSize  int64
	SortField string
	SortOrder int8 // 1=ascending | -1=descending

	// Filter related.
	TenantID        primitive.ObjectID
	UserID          primitive.ObjectID
	UserRole        int8
	Status          int8
	ExcludeArchived bool
	SearchText      string
	CreatedAtGTE    time.Time
}

type TenantListResult

type TenantListResult struct {
	Results     []*Tenant          `json:"results"`
	NextCursor  primitive.ObjectID `json:"next_cursor"`
	HasNextPage bool               `json:"has_next_page"`
}

type TenantStorer

type TenantStorer interface {
	Create(ctx context.Context, m *Tenant) error
	GetByID(ctx context.Context, id primitive.ObjectID) (*Tenant, error)
	GetByPublicID(ctx context.Context, oldID uint64) (*Tenant, error)
	GetBySchemaName(ctx context.Context, schemaName string) (*Tenant, error)
	GetLatest(ctx context.Context) (*Tenant, error)
	UpdateByID(ctx context.Context, m *Tenant) error
	ListByFilter(ctx context.Context, m *TenantListFilter) (*TenantListResult, error)
	ListAsSelectOptionByFilter(ctx context.Context, f *TenantListFilter) ([]*TenantAsSelectOption, error)
	DeleteByID(ctx context.Context, id primitive.ObjectID) error
}

TenantStorer Interface for tenant.

func NewDatastore

func NewDatastore(appCfg *c.Conf, loggerp *slog.Logger, client *mongo.Client) TenantStorer

type TenantStorerImpl

type TenantStorerImpl struct {
	Logger     *slog.Logger
	DbClient   *mongo.Client
	Collection *mongo.Collection
}

func (TenantStorerImpl) Create

func (impl TenantStorerImpl) Create(ctx context.Context, u *Tenant) error

func (TenantStorerImpl) DeleteByID

func (impl TenantStorerImpl) DeleteByID(ctx context.Context, id primitive.ObjectID) error

func (TenantStorerImpl) GetByID

func (impl TenantStorerImpl) GetByID(ctx context.Context, id primitive.ObjectID) (*Tenant, error)

func (TenantStorerImpl) GetByPublicID

func (impl TenantStorerImpl) GetByPublicID(ctx context.Context, oldID uint64) (*Tenant, error)

func (TenantStorerImpl) GetBySchemaName

func (impl TenantStorerImpl) GetBySchemaName(ctx context.Context, schemaName string) (*Tenant, error)

func (TenantStorerImpl) GetLatest

func (impl TenantStorerImpl) GetLatest(ctx context.Context) (*Tenant, error)

func (TenantStorerImpl) ListAsSelectOptionByFilter

func (impl TenantStorerImpl) ListAsSelectOptionByFilter(ctx context.Context, f *TenantListFilter) ([]*TenantAsSelectOption, error)

func (TenantStorerImpl) ListByFilter

func (impl TenantStorerImpl) ListByFilter(ctx context.Context, f *TenantListFilter) (*TenantListResult, error)

func (TenantStorerImpl) UpdateByID

func (impl TenantStorerImpl) UpdateByID(ctx context.Context, m *Tenant) error