readers

package

v0.0.0-...-81dd437 Latest Latest Go to latest Published: Apr 19, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

README ¶

Readers

Readers provide an implementation of various message readers. Message readers are services that consume normalized (in SenML format) Mainflux messages from data storage and opens HTTP API for message consumption.

For an in-depth explanation of the usage of reader, as well as thorough understanding of Mainflux, please check out the official documentation.

Documentation ¶

Index ¶

Constants
Variables
func ParseValueComparator(query map[string]interface{}) string
type Message
type MessageRepository
type MessagesPage
type PageMetadata

Constants ¶

View Source

const (
	// EqualKey represents the equal comparison operator key.
	EqualKey = "eq"
	// LowerThanKey represents the lower-than comparison operator key.
	LowerThanKey = "lt"
	// LowerThanEqualKey represents the lower-than-or-equal comparison operator key.
	LowerThanEqualKey = "le"
	// GreaterThanKey represents the greater-than-or-equal comparison operator key.
	GreaterThanKey = "gt"
	// GreaterThanEqualKey represents the greater-than-or-equal comparison operator key.
	GreaterThanEqualKey = "ge"
)

Variables ¶

View Source

var ErrReadMessages = errors.New("failed to read messages from database")

ErrReadMessages indicates failure occurred while reading messages from database.

Functions ¶

func ParseValueComparator ¶

func ParseValueComparator(query map[string]interface{}) string

ParseValueComparator convert comparison operator keys into mathematic anotation

Types ¶

type Message ¶

type Message interface{}

Message represents any message format.

type MessageRepository ¶

type MessageRepository interface {
	// ListChannelMessages skips given number of messages for given channel and returns next
	// limited number of messages.
	ListChannelMessages(chanID string, pm PageMetadata) (MessagesPage, error)

	// ListAllMessages retrieves all messages from database.
	ListAllMessages(rpm PageMetadata) (MessagesPage, error)

	// Restore restores message database from a backup.
	Restore(ctx context.Context, messages ...senml.Message) error

	// Backup retrieves all messages from database.
	Backup(rpm PageMetadata) (MessagesPage, error)
}

MessageRepository specifies message reader API.

type MessagesPage ¶

type MessagesPage struct {
	PageMetadata
	Total    uint64
	Messages []Message
}

MessagesPage contains page related metadata as well as list of messages that belong to this page.

type PageMetadata ¶

type PageMetadata struct {
	Offset      uint64  `json:"offset"`
	Limit       uint64  `json:"limit"`
	Subtopic    string  `json:"subtopic,omitempty"`
	Publisher   string  `json:"publisher,omitempty"`
	Protocol    string  `json:"protocol,omitempty"`
	Name        string  `json:"name,omitempty"`
	Value       float64 `json:"v,omitempty"`
	Comparator  string  `json:"comparator,omitempty"`
	BoolValue   bool    `json:"vb,omitempty"`
	StringValue string  `json:"vs,omitempty"`
	DataValue   string  `json:"vd,omitempty"`
	From        float64 `json:"from,omitempty"`
	To          float64 `json:"to,omitempty"`
	Format      string  `json:"format,omitempty"`
}

PageMetadata represents the parameters used to create database queries

Source Files ¶

View all Source files

messages.go

Directories ¶

Path	Synopsis
api
influxdb Package influxdb contains the domain concept definitions needed to support Mainflux InfluxDB reader service functionality.	Package influxdb contains the domain concept definitions needed to support Mainflux InfluxDB reader service functionality.
mocks
mongodb Package mongodb contains the domain concept definitions needed to support Mainflux MondoDB reader service functionality.	Package mongodb contains the domain concept definitions needed to support Mainflux MondoDB reader service functionality.
postgres Package postgres contains repository implementations using Postgres as the underlying database.	Package postgres contains repository implementations using Postgres as the underlying database.
timescale Package timescale contains repository implementations using Timescale as the underlying database.	Package timescale contains repository implementations using Timescale as the underlying database.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL