model

package

v0.5.3 Latest Latest Go to latest Published: Jan 29, 2024 License: MPL-2.0 Imports: 20 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

github.com/xorkevin/forge

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
func Execute(log klog.Logger, version string, opts Opts) error
func Generate(ctx context.Context, log klog.Logger, outputfs fs.FS, inputfs fs.FS, ...) (retErr error)
type ExecEnv
type Opts

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	// ErrEnv is returned when validation is run outside of go generate
	ErrEnv errEnv
	// ErrInvalidSchema is returned when parsing an invalid schema file
	ErrInvalidSchema errInvalidSchema
	// ErrInvalidFile is returned when parsing an invalid model file
	ErrInvalidFile errInvalidFile
	// ErrInvalidModel is returned when checking an invalid model
	ErrInvalidModel errInvalidModel
)

Functions ¶

func Execute ¶

func Execute(log klog.Logger, version string, opts Opts) error

Execute runs forge model generation

func Generate ¶ added in v0.3.9

func Generate(ctx context.Context, log klog.Logger, outputfs fs.FS, inputfs fs.FS, version string, opts Opts, env ExecEnv) (retErr error)

Types ¶

type ExecEnv ¶ added in v0.4.0

type ExecEnv struct {
	GoPackage string
}

type Opts ¶ added in v0.3.9

type Opts struct {
	Output            string
	Schema            string
	Include           string
	Ignore            string
	ModelDirective    string
	QueryDirective    string
	ModelTag          string
	PlaceholderPrefix string
}

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
sqldb

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