create

Documentation

Index

• Constants
• type Component
  • func (g *Component) GetInfo() module.ComponentInfo
  • func (g *Component) Handle(ctx context.Context, output module.Handler, port string, msg interface{}) error
  • func (g *Component) Instance() module.Component
  • func (g *Component) Ports() []module.Port
• type Context
• type Document
• type Error
• type Request
• type Response
• type Result
• type Settings

Constants

const (
	ComponentName = "firestore_get_docs"
	RequestPort   = "request"
	ResponsePort  = "response"
	ErrorPort     = "error"
)

Types

type Component

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

func (*Component) GetInfo

func (g *Component) GetInfo() module.ComponentInfo

func (*Component) Handle

func (g *Component) Handle(ctx context.Context, output module.Handler, port string, msg interface{}) error

func (*Component) Instance

func (g *Component) Instance() module.Component

func (*Component) Ports

func (g *Component) Ports() []module.Port

type Context

type Context any

type Document

type Document map[string]interface{}

type Error

type Error struct {
	Context Context `json:"context"`
	Error   string  `json:"error"`
}

type Request

type Request struct {
	Context    Context          `json:"context,omitempty" title:"Context" configurable:"true"`
	Config     etc.ClientConfig `json:"config" title:"Config"  required:"true" description:"Client Config"`
	Collection string           `json:"collection" title:"Collection" required:"true"`
	Wheres     []utils.Where    `json:"wheres,omitempty" title:"Where"`
	Limit      int              `json:"limit,omitempty" title:"Limit"`
	Document   Document         `json:"document,omitempty" configurable:"true" title:"Document example"`
}

type Response

type Response struct {
	Context Context  `json:"context" title:"Context"`
	Results []Result `json:"results" title:"Document"`
	Count   int      `json:"count" title:"Count" description:"Number of documents found"`
}

type Result

type Result struct {
	Document Document `json:"document"`
	RefID    string   `json:"refID"`
	RefPath  string   `json:"refPath"`
}

type Settings

type Settings struct {
	EnableErrorPort bool `` /* 137-byte string literal not displayed */
}