ql

Documentation

Index

• Variables
• func ParseQuery(query string) (map[string]any, error)
• type QLManager
  • func (q *QLManager) Init(fname string) error
  • func (q *QLManager) Keys(srv string) []string
  • func (q *QLManager) QueryKeyAllowed(key string, service string) bool
  • func (q *QLManager) ServiceQueries(query string) (map[string]map[string]any, error)
  • func (q *QLManager) Services() []string
• type QLRecord
  • func QLRecords(qlKey string) ([]QLRecord, error)
  • func (q *QLRecord) Details(show string) string
  • func (q *QLRecord) FillEmpty()
  • func (q *QLRecord) String() string
• type SchemaKeys
• type ServiceMap

Variables

var Separator = ":"

Separator defines FOXDEN query separator

var Verbose int

Verbose defines verbosity level for this module

Functions

func ParseQuery

func ParseQuery(query string) (map[string]any, error)

ParseQuery function provides basic parser for user queries and return results in bson dictionary

Types

type QLManager

type QLManager struct {
	Map     ServiceMap
	Records []QLRecord
}

QLManager represents QL manager

func (*QLManager) Init

func (q *QLManager) Init(fname string) error

Init function loads service map from given file name

func (*QLManager) Keys

func (q *QLManager) Keys(srv string) []string

Keys provides list of keys associated with FOXDEN service name

func (*QLManager) QueryKeyAllowed

func (q *QLManager) QueryKeyAllowed(key string, service string) bool

Determines if a key from a user query is allowed for querying the given service. A user query key is considered "allowed" if it is an exact match for one of the service's allowed query keys OR if the user query key has a prefix equal to one of the allowed service query keys followed by a ".". The latter matching condition allows for queries on nested fields with dot notation.

func (*QLManager) ServiceQueries

func (q *QLManager) ServiceQueries(query string) (map[string]map[string]any, error)

ServiceQueries parses given query string into list of service queries

func (*QLManager) Services

func (q *QLManager) Services() []string

Services returns list of services known to QL manager

type QLRecord

type QLRecord struct {
	Key         string `json:"key"`
	Description string `json:"description,omitempty"`
	Service     string `json:"service"`
	Units       string `json:"units,omitempty"`
	Schema      string `json:"schema,omitempty"`
	DataType    string `json:"type"`
	DBType      string `json:"db,omitempty"`
}

QLRecord defines structure of QL key

func QLRecords

func QLRecords(qlKey string) ([]QLRecord, error)

QLRecords return list of ql keys

func (*QLRecord) Details

func (q *QLRecord) Details(show string) string

Details function provides record representation

func (*QLRecord) FillEmpty

func (q *QLRecord) FillEmpty()

FillEmpty assign N/A to empty attributes

func (*QLRecord) String

func (q *QLRecord) String() string

String returns string representation of ql key

type SchemaKeys

type SchemaKeys map[string]string

SchemaKeys represents full collection of schema keys across all schemas

type ServiceMap

type ServiceMap map[string][]string

ServiceMap defines FOXDEN service QL mapping