pod
haystack
Haystack model and client API
mixins
| Def |
Def models a definition dictionary |
|---|---|
| Dict |
Dict is a map of name/value pairs. |
| Grid |
Two dimensional tabular data structure composed of Cols and Rows. |
| HaystackContext |
HaystackContext defines an environment of defs and data |
| Namespace |
Namespace models a symbolic namespace of defs |
classes
| Bin |
Bin is a tag value for a binary file stored on disk rather than in the in-memory record database. |
|---|---|
| Client |
Client manages a network connection to a haystack server. |
| Col |
Column of a Grid |
| Coord |
Geographic coordinate as latitude and longitute in decimal degrees. |
| CsvReader |
Read Haystack data in CSV format. |
| CsvWriter |
Write Haystack data in CSV format. |
| DateSpan |
DateSpan models a span of time between two dates. |
| Etc |
Etc is the utility methods for Haystack. |
| Filter |
Filter models a declarative predicate for selecting dicts. |
| GridBuilder |
GridBuilder is used to build up an immutable |
| HaystackTest |
HaystackTest provides convenience methods for testing common Haystack data structures. |
| HisItem |
HisItem is a timestamp/value pair. |
| JsonReader |
Read Haystack data in JSON format. |
| JsonWriter |
Write Haystack data in JSON format. |
| Kind |
Kind provides a type signature for a Haystack data value |
| Marker |
Marker is the singleton which indicates a marker tag with no value. |
| NA |
NA is the singleton which indicates not available. |
| Number |
Number represents a numeric value and an optional Unit. |
| Ref |
Ref is used to model a record identifier and optional display string. |
| Remove |
Remove is the singleton which indicates a remove operation. |
| Row |
Row of a Grid. |
| Span |
Span models a range of time using an inclusive starting timestamp and exclusive ending timestamp. |
| Symbol |
Symbol is a name to a def in the meta-model namespace |
| TrioReader |
Read Haystack data in Trio format. |
| TrioWriter |
Write Haystack data in Trio format. |
| TypedDict |
TypedDict wraps a dict that maps tags to statically typed fields. |
| XStr |
XStr is an extended string which is a type name and value encoded as a string. |
| ZincReader |
Read Haystack data in Zinc format. |
| ZincWriter |
Write Haystack data in Zinc format. |
enums
| SpanMode |
SpanMode enumerates relative or absolute span modes |
|---|
facets
errs
| CallErr |
CallErr is raised when a server returns an error grid from a client call to a REST operation. |
|---|---|
| DependErr |
DependErr indicates a missing dependency |
| DisabledErr |
DisabledErr indicates access of a disabled resource. |
| DownErr |
DownErr indicates a communications or networking problem |
| FaultErr |
FaultErr indicates a software or configuration problem |
| UnitErr |
UnitErr indicates an operation between two incompatible units |
| UnknownNameErr |
UnknownNameErr is thrown when |
| UnknownRecErr |
UnknownKindErr when a Kind cannot be resolved or parsed |
| ValidateErr |
ValidateErr when a validation fails. |