query

README

query

import "github.com/coralproject/shelf/internal/xenia/query"

• Overview
• Index
• Subdirectories

Overview

Package query provides the service layer for building apps using query functionality.

Index

• Constants
• Variables
• func Delete(context interface{}, db *db.DB, name string) error
• func EnsureIndexes(context interface{}, db *db.DB, set *Set) error
• func GetAll(context interface{}, db *db.DB, tags []string) ([]Set, error)
• func GetNames(context interface{}, db *db.DB) ([]string, error)
• func Upsert(context interface{}, db *db.DB, set *Set) error
• type Index
• type Param
• type Query
  • func (q *Query) Validate() error
• type Result
• type Set
  • func GetByName(context interface{}, db *db.DB, name string) (*Set, error)
  • func GetLastHistoryByName(context interface{}, db *db.DB, name string) (*Set, error)
  • func (s *Set) PrepareForInsert()
  • func (s *Set) PrepareForUse()
  • func (s *Set) Validate() error

Package files

model.go prepare.go query.go

Constants

const (
    Collection        = "query_sets"
    CollectionHistory = "query_sets_history"
)

Contains the name of Mongo collections.

const (
    TypePipeline = "pipeline"
)

Set of query types we expect to receive.

Variables

var (
    ErrNotFound = errors.New("Set Not found")
)

Set of error variables.

func Delete

func Delete(context interface{}, db *db.DB, name string) error

Delete is used to remove an existing Set document.

func EnsureIndexes

func EnsureIndexes(context interface{}, db *db.DB, set *Set) error

EnsureIndexes perform index create commands against Mongo for the indexes specied in each query for the set. It will attempt to ensure all indexes regardless if one fails. Then reports all failures.

func GetAll

func GetAll(context interface{}, db *db.DB, tags []string) ([]Set, error)

GetAll retrieves a list of sets.

func GetNames

func GetNames(context interface{}, db *db.DB) ([]string, error)

GetNames retrieves a list of query names.

func Upsert

func Upsert(context interface{}, db *db.DB, set *Set) error

Upsert is used to create or update an existing Set document.

type Index

type Index struct {
    Key        []string `bson:"key" json:"key"`                                   // Index key fields; prefix name with dash (-) for descending order
    Unique     bool     `bson:"unique,omitempty" json:"unique,omitempty"`         // Prevent two documents from having the same index key
    DropDups   bool     `bson:"drop_dups,omitempty" json:"drop_dups,omitempty"`   // Drop documents with the same index key as a previously indexed one
    Background bool     `bson:"background,omitempty" json:"background,omitempty"` // Build index in background and return immediately
    Sparse     bool     `bson:"sparse,omitempty" json:"sparse,omitempty"`         // Only index documents containing the Key fields
}

Index contains metadata for creating indexes in Mongo.

type Param

type Param struct {
    Name      string `bson:"name" json:"name"`             // Name of the parameter.
    Desc      string `bson:"desc" json:"desc"`             // Description about the parameter.
    Default   string `bson:"default" json:"default"`       // Default value for the parameter.
    RegexName string `bson:"regex_name" json:"regex_name"` // Regular expression name.
}

Param contains meta-data about a required parameter for the query.

type Query

type Query struct {
    Name        string                   `bson:"name" json:"name" validate:"required,min=3"`                                 // Unique name per query document.
    Description string                   `bson:"desc,omitempty" json:"desc,omitempty"`                                       // Description of this specific query.
    Type        string                   `bson:"type" json:"type" validate:"required,min=8"`                                 // TypePipeline, TypeTemplate
    Collection  string                   `bson:"collection,omitempty" json:"collection,omitempty" validate:"required,min=3"` // Name of the collection to use for processing the query.
    Timeout     string                   `bson:"timeout,omitempty" json:"timeout,omitempty"`                                 // Provides a timeout for the query if it does not return.
    Commands    []map[string]interface{} `bson:"commands" json:"commands"`                                                   // Commands to process for the query.
    Indexes     []Index                  `bson:"indexes" json:"indexes"`                                                     // Set of indexes required to optimize the execution of the query.
    Continue    bool                     `bson:"continue,omitempty" json:"continue,omitempty"`                               // Indicates that on failure to process the next query.
    Return      bool                     `bson:"return" json:"return"`                                                       // Return the results back to the user with Name as the key.
}

Query contains the configuration details for a query.

func (*Query) Validate

func (q *Query) Validate() error

Validate checks the query value for consistency.

type Result

type Result struct {
    Results interface{} `json:"results"`
}

Result contains the result of an query set execution. This had more fields in the past that have been removed. We can't change this out without breaking the API.

type Set

type Set struct {
    Name        string  `bson:"name" json:"name" validate:"required,min=3"` // Name of the query set.
    Description string  `bson:"desc" json:"desc"`                           // Description of the query set.
    PreScript   string  `bson:"pre_script" json:"pre_script"`               // Name of a script document to prepend.
    PstScript   string  `bson:"pst_script" json:"pst_script"`               // Name of a script document to append.
    Params      []Param `bson:"params" json:"params"`                       // Collection of parameters.
    Queries     []Query `bson:"queries" json:"queries"`                     // Collection of queries.
    Enabled     bool    `bson:"enabled" json:"enabled"`                     // If the query set is enabled to run.
    Explain     bool    `bson:"explain" json:"explain"`                     // If we want the explain output.
}

Set contains the configuration details for a rule set.

func GetByName

func GetByName(context interface{}, db *db.DB, name string) (*Set, error)

GetByName retrieves the document for the specified Set.

func GetLastHistoryByName

func GetLastHistoryByName(context interface{}, db *db.DB, name string) (*Set, error)

GetLastHistoryByName gets the last written Set within the history.

func (*Set) PrepareForInsert

func (s *Set) PrepareForInsert()

PrepareForInsert replaces the documents for insertion.

func (*Set) PrepareForUse

func (s *Set) PrepareForUse()

PrepareForUse replaces the documents back to their orginal form.

func (*Set) Validate

func (s *Set) Validate() error

Validate checks the set value for consistency.

---

Generated by godoc2md

Documentation

Overview

Package query provides the service layer for building apps using query functionality.

Index

• Constants
• Variables
• func Delete(context interface{}, db *db.DB, name string) error
• func EnsureIndexes(context interface{}, db *db.DB, set *Set) error
• func GetNames(context interface{}, db *db.DB) ([]string, error)
• func Upsert(context interface{}, db *db.DB, set *Set) error
• type Index
• type Param
• type Query
  • func (q *Query) Validate() error
• type Result
• type Set
  • func GetAll(context interface{}, db *db.DB, tags []string) ([]Set, error)
  • func GetByName(context interface{}, db *db.DB, name string) (*Set, error)
  • func GetLastHistoryByName(context interface{}, db *db.DB, name string) (*Set, error)
  • func (s *Set) PrepareForInsert()
  • func (s *Set) PrepareForUse()
  • func (s *Set) Validate() error

Constants

const (
	Collection        = "query_sets"
	CollectionHistory = "query_sets_history"
)

Contains the name of Mongo collections.

const (
	TypePipeline = "pipeline"
)

Set of query types we expect to receive.

Variables

var (
	ErrNotFound = errors.New("Set Not found")
)

Set of error variables.

Functions

func Delete

func Delete(context interface{}, db *db.DB, name string) error

Delete is used to remove an existing Set document.

func EnsureIndexes

func EnsureIndexes(context interface{}, db *db.DB, set *Set) error

EnsureIndexes perform index create commands against Mongo for the indexes specied in each query for the set. It will attempt to ensure all indexes regardless if one fails. Then reports all failures.

func GetNames

func GetNames(context interface{}, db *db.DB) ([]string, error)

GetNames retrieves a list of query names.

func Upsert

func Upsert(context interface{}, db *db.DB, set *Set) error

Upsert is used to create or update an existing Set document.

Types

type Index

type Index struct {
	Key        []string `bson:"key" json:"key"`                                   // Index key fields; prefix name with dash (-) for descending order
	Unique     bool     `bson:"unique,omitempty" json:"unique,omitempty"`         // Prevent two documents from having the same index key
	DropDups   bool     `bson:"drop_dups,omitempty" json:"drop_dups,omitempty"`   // Drop documents with the same index key as a previously indexed one
	Background bool     `bson:"background,omitempty" json:"background,omitempty"` // Build index in background and return immediately
	Sparse     bool     `bson:"sparse,omitempty" json:"sparse,omitempty"`         // Only index documents containing the Key fields
}

Index contains metadata for creating indexes in Mongo.

type Param

type Param struct {
	Name      string `bson:"name" json:"name"`             // Name of the parameter.
	Desc      string `bson:"desc" json:"desc"`             // Description about the parameter.
	Default   string `bson:"default" json:"default"`       // Default value for the parameter.
	RegexName string `bson:"regex_name" json:"regex_name"` // Regular expression name.
}

Param contains meta-data about a required parameter for the query.

type Query

type Query struct {
	Name        string                   `bson:"name" json:"name" validate:"required,min=3"`                                 // Unique name per query document.
	Description string                   `bson:"desc,omitempty" json:"desc,omitempty"`                                       // Description of this specific query.
	Type        string                   `bson:"type" json:"type" validate:"required,min=8"`                                 // TypePipeline, TypeTemplate
	Collection  string                   `bson:"collection,omitempty" json:"collection,omitempty" validate:"required,min=3"` // Name of the collection to use for processing the query.
	Timeout     string                   `bson:"timeout,omitempty" json:"timeout,omitempty"`                                 // Provides a timeout for the query if it does not return.
	Commands    []map[string]interface{} `bson:"commands" json:"commands"`                                                   // Commands to process for the query.
	Indexes     []Index                  `bson:"indexes" json:"indexes"`                                                     // Set of indexes required to optimize the execution of the query.
	Continue    bool                     `bson:"continue,omitempty" json:"continue,omitempty"`                               // Indicates that on failure to process the next query.
	Return      bool                     `bson:"return" json:"return"`                                                       // Return the results back to the user with Name as the key.
}

Query contains the configuration details for a query.

func (*Query) Validate

func (q *Query) Validate() error

Validate checks the query value for consistency.

type Result

type Result struct {
	Results interface{} `json:"results"`
}

Result contains the result of an query set execution. This had more fields in the past that have been removed. We can't change this out without breaking the API.

type Set

type Set struct {
	Name        string  `bson:"name" json:"name" validate:"required,min=3"` // Name of the query set.
	Description string  `bson:"desc" json:"desc"`                           // Description of the query set.
	PreScript   string  `bson:"pre_script" json:"pre_script"`               // Name of a script document to prepend.
	PstScript   string  `bson:"pst_script" json:"pst_script"`               // Name of a script document to append.
	Params      []Param `bson:"params" json:"params"`                       // Collection of parameters.
	Queries     []Query `bson:"queries" json:"queries"`                     // Collection of queries.
	Enabled     bool    `bson:"enabled" json:"enabled"`                     // If the query set is enabled to run.
	Explain     bool    `bson:"explain" json:"explain"`                     // If we want the explain output.
}

Set contains the configuration details for a rule set.

func GetAll

func GetAll(context interface{}, db *db.DB, tags []string) ([]Set, error)

GetAll retrieves a list of sets.

func GetByName

func GetByName(context interface{}, db *db.DB, name string) (*Set, error)

GetByName retrieves the document for the specified Set.

func GetLastHistoryByName

func GetLastHistoryByName(context interface{}, db *db.DB, name string) (*Set, error)

GetLastHistoryByName gets the last written Set within the history.

func (*Set) PrepareForInsert

func (s *Set) PrepareForInsert()

PrepareForInsert replaces the documents for insertion.

func (*Set) PrepareForUse

func (s *Set) PrepareForUse()

PrepareForUse replaces the documents back to their orginal form.

func (*Set) Validate

func (s *Set) Validate() error

Validate checks the set value for consistency.