models

package

v0.0.6 Latest Latest Go to latest Published: Mar 9, 2023 License: AGPL-3.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

codeberg.org/libreedu/hub

Links

Open Source Insights

Documentation ¶

Overview ¶

The `models` module provides core database types like User.

These structures should stay pretty much the same, so if you need additional fields, just extend the struct and build the object with joins.

Please don't alter tables; add a relationship with an ORM to another table, or use an adjacent table with joins: “select * from users join cldata.users on public.users.id = cldata.users.uid where id = $(uuidgen);“

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrAuthTokenInvalid = errors.New("auth token issued or read from database incorrectly")
	ErrAuthTokenExpired = errors.New("auth token expired or revoked")
)

Unstable; these errors will probably move elsewhere.

Functions ¶

This section is empty.

Types ¶

type AuthToken ¶

type AuthToken struct {
	bun.BaseModel `bun:"table:auth_tokens"`
	Token         string `bun:",pk"`
	UID           string
	User          *User `bun:"-"`
	Revoked       bool
	IssuedAt      time.Time
}

func (AuthToken) Validate ¶

func (at AuthToken) Validate() error

type User ¶

type User struct {
	bun.BaseModel `bun:"table:users"`
	ID            string `json:"id" bun:",pk,type:uuid"`
	Username      string `json:"username"`

	GivenName  string `json:"given_name"`
	FamilyName string `json:"family_name"`
	MiddleName string `json:"middle_name,omitempty"`
	NameSuffix string `json:"name_suffix,omitempty"`
	Email      string `json:"email,omitempty"`

	LastLogin time.Time `json:"last_login"` // omitempty doesn't work for literal null
	CreatedAt time.Time `json:"created_at"`
	UpdatedAt time.Time `json:"updated_at"`
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL