generator

Documentation

Index

• Variables
• type Application
  • func (a *Application) ID(id string) string
• type Config
  • func (c *Config) Application(name string) *Application
• type Generator
• type Generators
  • func NewGenerators(db *mssqlx.DBs, client redis.Client) Generators
  • func (gs Generators) Generator(kind string) (Generator, error)
• type KSUID
  • func (k *KSUID) Generate(_ context.Context, app *Application) (string, error)
• type NanoID
  • func (n *NanoID) Generate(_ context.Context, app *Application) (string, error)
• type PG
  • func (p *PG) Generate(ctx context.Context, app *Application) (string, error)
• type Redis
  • func (r *Redis) Generate(ctx context.Context, app *Application) (string, error)
• type Snowflake
  • func NewSnowflake() *Snowflake
  • func (s *Snowflake) Generate(_ context.Context, app *Application) (string, error)
• type TypeID
  • func (t *TypeID) Generate(_ context.Context, app *Application) (string, error)
• type ULID
  • func (k *ULID) Generate(_ context.Context, app *Application) (string, error)
• type UUID
  • func (g *UUID) Generate(_ context.Context, app *Application) (string, error)
• type XID
  • func (x *XID) Generate(_ context.Context, app *Application) (string, error)

Variables

var ErrNotFound = errors.New("generator not found")

ErrNotFound for generator.

var Module = fx.Options(fx.Provide(NewGenerators))

Module for fx.

Types

type Application

type Application struct {
	Name      string `yaml:"name,omitempty" json:"name,omitempty" toml:"name,omitempty"`
	Kind      string `yaml:"kind,omitempty" json:"kind,omitempty" toml:"kind,omitempty"`
	Prefix    string `yaml:"prefix,omitempty" json:"prefix,omitempty" toml:"prefix,omitempty"`
	Suffix    string `yaml:"suffix,omitempty" json:"suffix,omitempty" toml:"suffix,omitempty"`
	Separator string `yaml:"separator,omitempty" json:"separator,omitempty" toml:"separator,omitempty"`
}

Application fto generate identifiers.

func (*Application) ID

func (a *Application) ID(id string) string

ID for the application.

type Config

type Config struct {
	Applications []*Application `yaml:"applications,omitempty" json:"applications,omitempty" toml:"applications,omitempty"`
}

Config for generator.

func (*Config) Application

func (c *Config) Application(name string) *Application

Application by name.

type Generator

type Generator interface {
	// Generate an identifier.
	Generate(ctx context.Context, app *Application) (string, error)
}

Generator to generate an identifier.

type Generators

type Generators map[string]Generator

Generators of identifiers.

func NewGenerators

func NewGenerators(db *mssqlx.DBs, client redis.Client) Generators

NewGenerators of identifiers.

func (Generators) Generator

func (gs Generators) Generator(kind string) (Generator, error)

Generator from kind.

type KSUID

type KSUID struct{}

KSUID generator.

func (*KSUID) Generate

func (k *KSUID) Generate(_ context.Context, app *Application) (string, error)

Generate a KSUID.

type NanoID

type NanoID struct{}

NanoID generator.

func (*NanoID) Generate

func (n *NanoID) Generate(_ context.Context, app *Application) (string, error)

Generate a NanoID.

type PG

type PG struct {
	// contains filtered or unexported fields
}

PG generator.

func (*PG) Generate

func (p *PG) Generate(ctx context.Context, app *Application) (string, error)

Generate an ID using a sequence.

type Redis

type Redis struct {
	// contains filtered or unexported fields
}

Redis generator.

func (*Redis) Generate

func (r *Redis) Generate(ctx context.Context, app *Application) (string, error)

Generate an ID using INCR.

type Snowflake

type Snowflake struct {
	// contains filtered or unexported fields
}

Snowflake generator.

func NewSnowflake

func NewSnowflake() *Snowflake

NewSnowflake generator.

func (*Snowflake) Generate

func (s *Snowflake) Generate(_ context.Context, app *Application) (string, error)

Generate a id with snowflake.

type TypeID

type TypeID struct{}

TypeID generator.

func (*TypeID) Generate

func (t *TypeID) Generate(_ context.Context, app *Application) (string, error)

Generate a TypeID.

type ULID

type ULID struct{}

ULID generator.

func (*ULID) Generate

func (k *ULID) Generate(_ context.Context, app *Application) (string, error)

Generate a ULID.

type UUID

type UUID struct{}

UUID generator.

func (*UUID) Generate

func (g *UUID) Generate(_ context.Context, app *Application) (string, error)

Generate a UUID.

type XID

type XID struct{}

XID generator.

func (*XID) Generate

func (x *XID) Generate(_ context.Context, app *Application) (string, error)

Generate an XID.