schema

package

v0.0.0-...-fda0ada Latest Latest Go to latest Published: Jan 11, 2026 License: BSD-3-Clause Imports: 15 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/maisem/pkg

Links

Open Source Insights

Documentation ¶

Index ¶

func ExecStatements(ctx context.Context, conn *sql.Conn, statements ...string) error
type Manager
type Migrator
type Schemas
- func (s *Schemas) Len() int

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ExecStatements ¶

func ExecStatements(ctx context.Context, conn *sql.Conn, statements ...string) error

ExecStatements executes a list of SQL statements in order

Types ¶

type Manager ¶

type Manager struct {
	Schemata   *embed.FS
	SchemaName string
	Migrators  map[int]Migrator
}

func (*Manager) AllSchemas ¶

func (m *Manager) AllSchemas() *Schemas

AllSchemas returns a schemas instance containing all embedded schemas.

func (*Manager) Init ¶

func (m *Manager) Init(ctx context.Context, db *sqlite.DB, logf logger.Logf) (err error)

Init initializes the database schema if needed or performs migrations.

func (*Manager) LatestSchema ¶

func (m *Manager) LatestSchema() []byte

LatestSchema returns the schema with the highest version.

func (*Manager) LatestSchemaVersion ¶

func (m *Manager) LatestSchemaVersion() int

LatestSchemaVersion returns the highest schema version that is supported by the manager.

func (*Manager) MinSchemaVersion ¶

func (m *Manager) MinSchemaVersion() int

MinSchemaVersion returns the minimum schema version that is supported by the manager. This is the lowest schema version that has a migrator. If there are no migrators, it returns the latest schema version.

func (*Manager) Schema ¶

func (m *Manager) Schema(version int) string

Schema returns the schema for a specific version.

type Migrator ¶

type Migrator func(ctx context.Context, conn *sql.Conn) error

A schema upgrader function takes a transaction and upgrades the schema from one version to the next.

type Schemas ¶

type Schemas struct {
	Schemas []struct {
		// contains filtered or unexported fields
	}
}

Schemas is a slice of all embedded Schemas, sorted by version.

func (*Schemas) Len ¶

func (s *Schemas) Len() int

Len returns the number of schemas.

Source Files ¶

View all Source files

schema.go

Directories ¶

Path	Synopsis
embed
equality
sqlgen sqlgen is a tool to generate SQL schema from Go struct types.	sqlgen is a tool to generate SQL schema from Go struct types.

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