mixin

Documentation

Overview

Package mixin defines reusable groups of schema declarations, including application-side and database-side primary-key generators.

Index

• Constants
• Variables
• func NanoID(size int, alphabet string) schema.Mixin

Constants

const DefaultNanoIDAlphabet = "_-0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"

DefaultNanoIDAlphabet is the URL-safe alphabet used by NanoID's default configuration.

Variables

var SoftDelete = schema.Mixin{Fields: schema.Fields{
	field.Time("deleted_at").Optional().Annotate(softDeleteAnnotation{}),
}}

SoftDelete supplies a nullable deleted_at field and reserved annotation.

var Timestamps = schema.Mixin{Fields: schema.Fields{
	field.Time("created_at").SQLDefault("now()").Immutable(),
	field.Time("updated_at").SQLDefault("now()"),
}}

Timestamps supplies created_at and updated_at fields.

var ULID = schema.Mixin{Fields: schema.Fields{
	field.ID().Default(schema.Func(newULID)),
}}

ULID supplies a text primary key with a per-row ULID default.

var UUIDv7 = schema.Mixin{Fields: schema.Fields{
	declaration.NewPrimaryField(schema.FieldUUID, reflect.TypeFor[uuid.UUID]()).Default(schema.FuncErr(uuid.NewV7)),
}}

UUIDv7 supplies a UUID primary key with a per-row UUIDv7 default.

Functions

func NanoID

func NanoID(size int, alphabet string) schema.Mixin

NanoID supplies a text primary key whose value is generated by PostgreSQL. The function defaults are declared as part of the desired migration object, so callers may also invoke nanoid(size, alphabet, additionalBytesFactor) directly when they need a non-default value.