FsShelter will serialize most data types you might want to use in the definition of the DU case for the topology streams. There are however several things to keep in mind...
FsShelter DSL uses F# lambdas to define grouping expressions. Since this has to be transformed into a list of fields Storm can understand, only a simple projection of properties is supported, so don't expect to be able to call any functions.
Examples of structural nesting supported:
1: 2: 3: 4: 5: 6: 7: 8:
Here is how FsShelter will present the schema to Storm when declaring stream/outputs:
Described: [Item.X, Item.Desc]
Complex: [Item.X, Item.Desc]
And when referenced in the grouping expressions, FsShelter will translate the fields back to these names:
1: 2: 3: 4: 5: 6: 7: 8: 9:
As you can see this flattening of records is done only one layer deep. Also keep in mind that while use of collection types for fields is possible it doesn't provde any meaningful way to express that to Storm. In summary:
- there is no attempt to flatten types other than records
- fields not presented to Storm in the output declaration are transmitted as part of opaque (parent's type) blobs
- there's no way to address a value wrapped in an Option (or any other DU), only entire Option field can be used in a grouping
FsShelter will serialize most schemata exactly as you would imagine, but there are always "interesting" scenarios. Here are some of the implementation details to keep in mind:
- Json serialization is implemented with Newtonsoft.Json, F# types are mostly serializable, but might look odd on the wire (Option is a DU, think about that for a second).
- Binary serializer (Protobuf) uses FsPickler and you might be able to optimize the payload via its APIs accordingly.
- Both serializers support different set of native representations, consequently performance and interopability with non-F# components will vary.
- Both will try to map the field values to Java types before passing the tuple on to Storm and will try to convert back before passing it to an F# component.
Certain features of Storm are available through special streams, like "tick". Since DU case name like that would look very wrong in an F# application, FsShelter checks for
DisplayName attribute that facilitates the mapping, for example:
__tick as the name for the stream, while keeping F# conventions in place for the DU case.
type DisplayNameAttribute =
new : unit -> DisplayNameAttribute + 1 overload
member DisplayName : string
member Equals : obj:obj -> bool
member GetHashCode : unit -> int
member IsDefaultAttribute : unit -> bool
static val Default : DisplayNameAttribute
Full name: System.ComponentModel.DisplayNameAttribute
ComponentModel.DisplayNameAttribute() : unit
ComponentModel.DisplayNameAttribute(displayName: string) : unit