The highest tagged major version is
Documentation
¶
Overview ¶
Package codegen helps autogenerate tables for CloudQuery source plugins from Go structs (of relevant SDKs).
Index ¶
- Variables
- func DefaultNameTransformer(field reflect.StructField) (string, error)
- func DefaultResolverTransformer(_ reflect.StructField, path string) (string, error)
- func DefaultTypeTransformer(v reflect.StructField) (schema.ValueType, error)
- type ColumnDefinition
- type ColumnDefinitions
- type NameTransformer
- type ResolverTransformer
- type ResourceDefinition
- type TableDefinition
- type TableOption
- func WithExtraColumns(columns ColumnDefinitions) TableOption
- func WithLogger(logger zerolog.Logger) TableOption
- func WithNameTransformer(transformer NameTransformer) TableOption
- func WithPKColumns(columnNames ...string) TableOption
- func WithResolverTransformer(transformer ResolverTransformer) TableOption
- func WithSkipFields(fields []string) TableOption
- func WithTypeTransformer(transformer TypeTransformer) TableOption
- func WithUnwrapAllEmbeddedStructs() TableOption
- func WithUnwrapStructFields(fields []string) TableOption
- type TypeTransformer
Constants ¶
This section is empty.
Variables ¶
var TemplatesFS embed.FS
Functions ¶
func DefaultNameTransformer ¶ added in v0.7.13
func DefaultNameTransformer(field reflect.StructField) (string, error)
func DefaultResolverTransformer ¶ added in v0.8.1
func DefaultResolverTransformer(_ reflect.StructField, path string) (string, error)
func DefaultTypeTransformer ¶ added in v0.7.12
func DefaultTypeTransformer(v reflect.StructField) (schema.ValueType, error)
Types ¶
type ColumnDefinition ¶
type ColumnDefinitions ¶
type ColumnDefinitions []ColumnDefinition
func (ColumnDefinitions) GetByName ¶
func (c ColumnDefinitions) GetByName(name string) *ColumnDefinition
type NameTransformer ¶ added in v0.7.12
type NameTransformer func(reflect.StructField) (string, error)
type ResolverTransformer ¶ added in v0.8.1
type ResolverTransformer func(field reflect.StructField, path string) (string, error)
type ResourceDefinition ¶
type ResourceDefinition struct {
Name string
Table *TableDefinition
}
type TableDefinition ¶
type TableDefinition struct {
Name string
Columns ColumnDefinitions
Description string
Relations []string
Resolver string
IgnoreError string
Multiplex string
PostResourceResolver string
PreResourceResolver string
// contains filtered or unexported fields
}
func NewTableFromStruct ¶
func NewTableFromStruct(name string, obj any, opts ...TableOption) (*TableDefinition, error)
NewTableFromStruct creates a new TableDefinition from a struct by inspecting its fields
func (*TableDefinition) Check ¶ added in v1.2.0
func (t *TableDefinition) Check() error
Check that the resulting TableDefinition is correct (e.g., no overlapping column names).
func (*TableDefinition) GenerateTemplate ¶
func (t *TableDefinition) GenerateTemplate(wr io.Writer) error
type TableOption ¶ added in v0.8.0
type TableOption func(*TableDefinition)
func WithExtraColumns ¶
func WithExtraColumns(columns ColumnDefinitions) TableOption
WithExtraColumns allows passing additional ColumnDefinitions
func WithLogger ¶ added in v0.7.12
func WithLogger(logger zerolog.Logger) TableOption
WithLogger allows passing custom logger
func WithNameTransformer ¶
func WithNameTransformer(transformer NameTransformer) TableOption
WithNameTransformer overrides how column name will be determined. DefaultNameTransformer is used as the default.
func WithPKColumns ¶ added in v1.3.0
func WithPKColumns(columnNames ...string) TableOption
WithPKColumns allows to specify what columns should be considered PKs without need for WithExtraColumns + WithSkipFields
func WithResolverTransformer ¶ added in v0.8.1
func WithResolverTransformer(transformer ResolverTransformer) TableOption
WithResolverTransformer sets a function that can override the resolver for a field. DefaultResolverTransformer is used as the default. If the transformer provided returns error, gen will fail. To fallback onto the default resolver return "", nil.
func WithSkipFields ¶
func WithSkipFields(fields []string) TableOption
WithSkipFields allows to specify what struct fields should be skipped.
func WithTypeTransformer ¶ added in v0.7.12
func WithTypeTransformer(transformer TypeTransformer) TableOption
WithTypeTransformer sets a function that can override the schema type for specific fields. Return `schema.TypeInvalid` to fall back to default behavior. DefaultTypeTransformer is used as the default.
func WithUnwrapAllEmbeddedStructs ¶ added in v0.6.1
func WithUnwrapAllEmbeddedStructs() TableOption
WithUnwrapAllEmbeddedStructs instructs codegen to unwrap all embedded fields (1 level deep only)
func WithUnwrapStructFields ¶ added in v0.8.0
func WithUnwrapStructFields(fields []string) TableOption
WithUnwrapStructFields allows to unwrap specific struct fields (1 level deep only)
type TypeTransformer ¶ added in v0.7.12
type TypeTransformer func(reflect.StructField) (schema.ValueType, error)
Source Files