modelfromproto

Documentation

Index

• type Alias
  • func ChangeColumn(column *Column) Alias
  • func ChangeName(name string) Alias
• type CollapsedOptions
  • func NewCollapsedOptions(opts []Option) CollapsedOptions
• type Column
• type CreationOptions
• type File
  • func ResourceFileFromProto(service, resource, pathToProto string, opts ...Option) (*File, error)
• type OneOfer
• type Option
  • func WithAlias(path string, alias Alias) Option
  • func WithIgnored(ignoredFields ...string) Option
  • func WithProtoPaths(paths ...string) Option
• type Table
• type TableBuilder
  • func (tb *TableBuilder) Build() (*Table, error)
  • func (tb *TableBuilder) WithMessageFromProto(messageName, pathToProto string, paths ...string) error
• type UnimplementedAlias
  • func (u UnimplementedAlias) ApplyToColumn(*Column)
  • func (u UnimplementedAlias) ApplyToTable(*Table)

Types

type Alias

type Alias interface {
	ApplyToColumn(column *Column)
	ApplyToTable(table *Table)
}

func ChangeColumn

func ChangeColumn(column *Column) Alias

func ChangeName

func ChangeName(name string) Alias

type CollapsedOptions

type CollapsedOptions struct {
	Paths         []string
	IgnoredFields map[string]struct{}
	Aliases       map[string]Alias
}

func NewCollapsedOptions

func NewCollapsedOptions(opts []Option) CollapsedOptions

type Column

type Column struct {
	Name            string
	Description     string
	Type            string
	Resolver        string
	CreationOptions *CreationOptions
}

type CreationOptions

type CreationOptions struct {
	Nullable string
	Unique   string
}

type File

type File struct {
	Table     *Table
	Relations []*Table
}

func ResourceFileFromProto

func ResourceFileFromProto(service, resource, pathToProto string, opts ...Option) (*File, error)

type OneOfer

type OneOfer interface {
	GetOneOf() *desc.OneOfDescriptor
}

type Option

type Option interface {
	Apply(co *CollapsedOptions)
}

func WithAlias

func WithAlias(path string, alias Alias) Option

func WithIgnored

func WithIgnored(ignoredFields ...string) Option

func WithProtoPaths

func WithProtoPaths(paths ...string) Option

type Table

type Table struct {
	// Should be in camel case
	Service      string
	Resource     string
	AbsolutePath []string
	RelativePath []string

	Multiplex string

	Columns   []*Column
	Relations []*Table

	Alias string
}

type TableBuilder

type TableBuilder struct {
	Service      string
	Resource     string
	AbsolutePath string
	RelativePath string
	Multiplex    string

	MessageDesc *desc.MessageDescriptor

	IgnoredFields map[string]struct{}
	Aliases       map[string]Alias

	Field  *expandedField
	Parent *TableBuilder
}

func (*TableBuilder) Build

func (tb *TableBuilder) Build() (*Table, error)

func (*TableBuilder) WithMessageFromProto

func (tb *TableBuilder) WithMessageFromProto(messageName, pathToProto string, paths ...string) error

type UnimplementedAlias

type UnimplementedAlias struct{}

func (UnimplementedAlias) ApplyToColumn

func (u UnimplementedAlias) ApplyToColumn(*Column)

func (UnimplementedAlias) ApplyToTable

func (u UnimplementedAlias) ApplyToTable(*Table)