plugin

type Column struct {
	// column name
	Name string
	// column type
	Type proto.ColumnType
	// column description
	Description string
	// explicitly specify the function which populates this data
	// - this is only needed if any of the default hydrate functions wil NOT return this column
	Hydrate HydrateFunc

	// the default column value
	Default interface{}
	//  a list of transforms to generate the column value
	Transform *transform.ColumnTransforms
	// contains filtered or unexported fields
}

type ErrorPredicate func(error) bool

type GetConfig struct {
	// key or keys which are used to uniquely identify rows - used to determine whether  a query is a 'get' call
	KeyColumns  *KeyColumnSet
	ItemFromKey HydrateFunc
	// the hydrate function which is called first when performing a 'get' call.
	// if this returns 'not found', no further hydrate functions are called
	Hydrate HydrateFunc
	// a function which will return whenther to ignore a given error
	ShouldIgnoreError ErrorPredicate
}

type HydrateCall struct {
	Func HydrateFunc
	// the dependencies expressed using function name
	Depends []string
}

type HydrateData struct {
	Item           interface{}
	HydrateResults map[string]interface{}
}

type HydrateDependencies struct {
	Func    HydrateFunc
	Depends []HydrateFunc
}

type HydrateFunc func(context.Context, *QueryData, *HydrateData) (interface{}, error)

type KeyColumnSet struct {
	Single string
	All    []string
	Any    []string
}

type ListConfig struct {
	KeyColumns *KeyColumnSet
	// the list function, this should stream the list results back using the QueryData object, and return nil
	Hydrate HydrateFunc
	// the parent list function - if we list items with a parent-child relationship, this will list the parent items
	ParentHydrate HydrateFunc
}

type Plugin struct {
	Name             string
	Logger           hclog.Logger
	TableMap         map[string]*Table
	DefaultTransform *transform.ColumnTransforms
	DefaultGetConfig *GetConfig
	// every table must implement these columns
	RequiredColumns []*Column
}

type PluginFunc func(context.Context) *Plugin

type QueryData struct {
	ConnectionManager *connection.Manager
	Table             *Table
	// if this is a get call (or a list call if list key columns are specified)
	// this will be populated with the quals as a map of column name to quals
	KeyColumnQuals map[string]*pb.QualValue
	// is this a get or a list
	FetchType    fetchType
	QueryContext *pb.QueryContext
	// contains filtered or unexported fields
}

type RowData struct {
	Item interface{}
	// contains filtered or unexported fields
}

type ServeOpts struct {
	PluginName string
	PluginFunc PluginFunc
}

type Table struct {
	Name string
	// table description
	Description string
	// column definitions
	Columns          []*Column
	List             *ListConfig
	Get              *GetConfig
	DefaultTransform *transform.ColumnTransforms
	// the parent plugin object
	Plugin *Plugin
	// definitions of dependencies between hydrate functions
	HydrateDependencies []HydrateDependencies
}