generator

Documentation

Index

• Variables
• type Application
  • func (a *Application) ID(id string) string
• type Config
  • func (c *Config) Application(name string) *Application
• type Generator
  • func NewGenerator(name, kind string, db *mssqlx.DBs, client client.Client) (Generator, error)
• type KSUID
  • func (k *KSUID) Generate(ctx context.Context) (string, error)
• type PG
  • func (p *PG) Generate(ctx context.Context) (string, error)
• type Redis
  • func (r *Redis) Generate(ctx context.Context) (string, error)
• type Snowflake
  • func (s *Snowflake) Generate(ctx context.Context) (string, error)
• type ULID
  • func (k *ULID) Generate(ctx context.Context) (string, error)
• type UUID
  • func (g *UUID) Generate(ctx context.Context) (string, error)

Variables

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

ErrNotFound for generator.

Types

type Application

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

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"`
}

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) (string, error)
}

Generator to generate an identifier.

func NewGenerator

func NewGenerator(name, kind string, db *mssqlx.DBs, client client.Client) (Generator, error)

NewGenerator from kind.

type KSUID

type KSUID struct{}

KSUID generator.

func (*KSUID) Generate

func (k *KSUID) Generate(ctx context.Context) (string, error)

Generate a KSUID.

type PG

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

PG generator.

func (*PG) Generate

func (p *PG) Generate(ctx context.Context) (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) (string, error)

Generate an ID using INCR.

type Snowflake

type Snowflake struct{}

Snowflake generator.

func (*Snowflake) Generate

func (s *Snowflake) Generate(ctx context.Context) (string, error)

Generate a id with snowflake.

type ULID

type ULID struct{}

ULID generator.

func (*ULID) Generate

func (k *ULID) Generate(ctx context.Context) (string, error)

Generate a ULID.

type UUID

type UUID struct{}

UUID generator.

func (*UUID) Generate

func (g *UUID) Generate(ctx context.Context) (string, error)

Generate a UUID.