schema

Documentation

Index

• func GetPgTypeFromType(v ValueType) string
• func ParentIdResolver(_ context.Context, _ ClientMeta, r *Resource, c Column) error
• func ValidateTable(t *Table) error
• type ClientMeta
• type Column
  • func GetDefaultSDKColumns() []Column
  • func (c Column) ValidateType(v interface{}) error
• type ColumnCreationOptions
• type ColumnResolver
  • func ParentFieldResolver(name string) ColumnResolver
  • func PathResolver(path string) ColumnResolver
• type Database
• type ExecutionData
  • func NewExecutionData(db Database, logger hclog.Logger, table *Table, disableDelete bool, ...) ExecutionData
  • func (e ExecutionData) ResolveTable(ctx context.Context, meta ClientMeta, parent *Resource) (uint64, error)
  • func (e ExecutionData) WithTable(t *Table) ExecutionData
• type IgnoreErrorFunc
• type LengthTableValidator
  • func (tv LengthTableValidator) Validate(t *Table) error
• type PgDatabase
  • func NewPgDatabase(ctx context.Context, dsn string) (*PgDatabase, error)
  • func (p PgDatabase) Delete(ctx context.Context, t *Table, args []interface{}) error
  • func (p PgDatabase) Exec(ctx context.Context, query string, args ...interface{}) error
  • func (p PgDatabase) Insert(ctx context.Context, t *Table, resources []*Resource) error
  • func (p PgDatabase) Query(ctx context.Context, query string, args ...interface{}) (pgx.Rows, error)
  • func (p PgDatabase) QueryOne(ctx context.Context, query string, args ...interface{}) pgx.Row
• type Resource
  • func NewResourceData(t *Table, parent *Resource, item interface{}, ...) *Resource
  • func (r *Resource) GenerateCQId() error
  • func (r *Resource) Get(key string) interface{}
  • func (r *Resource) Id() uuid.UUID
  • func (r *Resource) Set(key string, value interface{}) error
  • func (r *Resource) Values() ([]interface{}, error)
• type RowResolver
• type Table
  • func (t Table) Column(name string) *Column
  • func (t Table) ColumnNames() []string
  • func (t Table) PrimaryKeys() []string
• type TableCreationOptions
• type TableResolver
• type TableValidator
• type ValueType
  • func ValueTypeFromString(s string) ValueType
  • func (v ValueType) String() string

Functions

func GetPgTypeFromType

func GetPgTypeFromType(v ValueType) string

func ParentIdResolver

func ParentIdResolver(_ context.Context, _ ClientMeta, r *Resource, c Column) error

ParentIdResolver resolves the cq_id from the parent if you want to reference the parent's primary keys use ParentFieldResolver as required.

func ValidateTable

func ValidateTable(t *Table) error

Types

type ClientMeta

type ClientMeta interface {
	Logger() hclog.Logger
}

type Column

type Column struct {
	// Name of column
	Name string
	// Value Type of column i.e String, UUID etc'
	Type ValueType
	// Description about column, this description is added as a comment in the database
	Description string
	// Default value if the resolver/default getting gets a nil value
	Default interface{}
	// Column Resolver allows to set you own data based on resolving this can be an API call or setting multiple embedded values etc'
	Resolver ColumnResolver
	// Creation options allow to modify how column is defined when table is created
	CreationOptions ColumnCreationOptions
}

Column definition for Table

func GetDefaultSDKColumns

func GetDefaultSDKColumns() []Column

GetDefaultSDKColumns Default columns of the SDK, these columns are added to each table by default

func (Column) ValidateType

func (c Column) ValidateType(v interface{}) error

type ColumnCreationOptions

type ColumnCreationOptions struct {
	Nullable bool
	Unique   bool
}

ColumnCreationOptions allow to modify how column is defined when table is created

type ColumnResolver

type ColumnResolver func(ctx context.Context, meta ClientMeta, resource *Resource, c Column) error

ColumnResolver is called for each row received in TableResolver's data fetch. execution holds all relevant information regarding execution as well as the Column bieng called. resource holds the current row we are resolving the column for.

func ParentFieldResolver

func ParentFieldResolver(name string) ColumnResolver

ParentFieldResolver resolves a field from the parent

func PathResolver

func PathResolver(path string) ColumnResolver

PathResolver resolves a field in the Resource.Item

Examples: PathResolver("Field") PathResolver("InnerStruct.Field") PathResolver("InnerStruct.InnerInnerStruct.Field")

type Database

type Database interface {
	Insert(ctx context.Context, t *Table, instance []*Resource) error
	Exec(ctx context.Context, query string, args ...interface{}) error
	Delete(ctx context.Context, t *Table, args []interface{}) error
	Query(ctx context.Context, query string, args ...interface{}) (pgx.Rows, error)
}

type ExecutionData

type ExecutionData struct {
	// Table this execution is associated with
	Table *Table
	// Database connection to insert data into
	Db Database
	// Logger associated with this execution
	Logger hclog.Logger
	// contains filtered or unexported fields
}

ExecutionData marks all the related execution info passed to TableResolver and ColumnResolver giving access to the Runner's meta

func NewExecutionData

func NewExecutionData(db Database, logger hclog.Logger, table *Table, disableDelete bool, extraFields map[string]interface{}) ExecutionData

NewExecutionData Create a new execution data

func (ExecutionData) ResolveTable

func (e ExecutionData) ResolveTable(ctx context.Context, meta ClientMeta, parent *Resource) (uint64, error)

func (ExecutionData) WithTable

func (e ExecutionData) WithTable(t *Table) ExecutionData

type IgnoreErrorFunc

type IgnoreErrorFunc func(err error) bool

IgnoreErrorFunc checks if returned error from table resolver should be ignored.

type LengthTableValidator

type LengthTableValidator struct{}

func (LengthTableValidator) Validate

func (tv LengthTableValidator) Validate(t *Table) error

type PgDatabase

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

func NewPgDatabase

func NewPgDatabase(ctx context.Context, dsn string) (*PgDatabase, error)

func (PgDatabase) Delete

func (p PgDatabase) Delete(ctx context.Context, t *Table, args []interface{}) error

func (PgDatabase) Exec

func (p PgDatabase) Exec(ctx context.Context, query string, args ...interface{}) error

Exec allows executions of postgres queries with given args returning error of execution

func (PgDatabase) Insert

func (p PgDatabase) Insert(ctx context.Context, t *Table, resources []*Resource) error

Insert inserts all resources to given table, table and resources are assumed from same table.

func (PgDatabase) Query

func (p PgDatabase) Query(ctx context.Context, query string, args ...interface{}) (pgx.Rows, error)

Query allows execution of postgres queries with given args returning data result

func (PgDatabase) QueryOne

func (p PgDatabase) QueryOne(ctx context.Context, query string, args ...interface{}) pgx.Row

QueryOne allows execution of postgres queries with given args returning data result

type Resource

type Resource struct {
	// Original resource item that wa from prior resolve
	Item interface{}
	// Set if this is an embedded table
	Parent *Resource
	// contains filtered or unexported fields
}

Resource represents a row in it's associated table, it carries a reference to the original item, and automatically generates an Id based on Table's Columns. Resource data can be accessed by the Get and Set methods

func NewResourceData

func NewResourceData(t *Table, parent *Resource, item interface{}, extraFields map[string]interface{}) *Resource

func (*Resource) GenerateCQId

func (r *Resource) GenerateCQId() error

func (*Resource) Get

func (r *Resource) Get(key string) interface{}

func (*Resource) Id

func (r *Resource) Id() uuid.UUID

func (*Resource) Set

func (r *Resource) Set(key string, value interface{}) error

func (*Resource) Values

func (r *Resource) Values() ([]interface{}, error)

type RowResolver

type RowResolver func(ctx context.Context, meta ClientMeta, resource *Resource) error

type Table

type Table struct {
	// Name of table
	Name string
	// table description
	Description string
	// Columns are the set of fields that are part of this table
	Columns []Column
	// Relations are a set of related tables defines
	Relations []*Table
	// Resolver is the main entry point to fetching table data and
	Resolver TableResolver
	// Ignore errors checks if returned error from table resolver should be ignored.
	IgnoreError IgnoreErrorFunc
	// Multiplex returns re-purposed meta clients. The sdk will execute the table with each of them
	Multiplex func(meta ClientMeta) []ClientMeta
	// DeleteFilter returns a list of key/value pairs to add when truncating this table's data from the database.
	DeleteFilter func(meta ClientMeta) []interface{}
	// Post resource resolver is called after all columns have been resolved, and before resource is inserted to database.
	PostResourceResolver RowResolver
	// Options allow to modify how the table is defined when created
	Options TableCreationOptions
}

func (Table) Column

func (t Table) Column(name string) *Column

func (Table) ColumnNames

func (t Table) ColumnNames() []string

ColumnNames returns all collected columns name of table (including all inner embedded columns)

func (Table) PrimaryKeys

func (t Table) PrimaryKeys() []string

type TableCreationOptions

type TableCreationOptions struct {
	// List of columns to set as primary keys, if HashPrimaryKeys is true the column values will be used to generate an Id
	// and a "id" column will be created for the table. If this nil a random unique Id is generated.
	PrimaryKeys []string
}

TableCreationOptions allow to modify how table is created such as defining primary keys, indices, foreign keys and contraints.

type TableResolver

type TableResolver func(ctx context.Context, meta ClientMeta, parent *Resource, res chan interface{}) error

TableResolver is the main entry point when a table fetch is called.

Table resolver has 3 main arguments: - meta(ClientMeta): is the client returned by the plugin.Provider Configure call - parent(Resource): resource is the parent resource in case this table is called via parent table (i.e relation) - res(chan interface{}): is a channel to pass results fetched by the TableResolver

type TableValidator

type TableValidator interface {
	Validate(t *Table) error
}

type ValueType

type ValueType int

const (
	TypeInvalid ValueType = iota
	TypeBool
	TypeSmallInt
	TypeInt
	TypeBigInt
	TypeFloat
	TypeUUID
	TypeString
	TypeByteArray
	TypeStringArray
	TypeIntArray
	TypeTimestamp
	TypeJSON
	TypeUUIDArray
	TypeInet
	TypeInetArray
	TypeCIDR
	TypeCIDRArray
	TypeMacAddr
	TypeMacAddrArray
)

func ValueTypeFromString

func ValueTypeFromString(s string) ValueType

func (ValueType) String

func (v ValueType) String() string