C#

C# loader guide.

API #

Data #

public ref readonly ProtobufMessage Data()

Get the internal protobuf message data.

Map #

• public MapValueType? Get1(KEY1 k1): Gets the 1st-level map value. Returns null if the key is not found.
• public MapValueType? Get2(KEY1 k1, KEY2 k2): Gets the 2nd-level map value. Returns null if the key is not found.
• …

Get the Nth-level map value. Be aware that only applies to each level message’s first map field.

OrderedMap #

Prerequisite: You need to set metasheet option OrderedMap to true.

See metasheet option: OrderedMap.

• public ref readonly OrderedMapMap GetOrderedMap(): Gets the whole ordered map.
• public OrderedMapValueType? GetOrderedMap1(KEY1 k1): Gets the 1st-level ordered map value. Returns null if the key is not found.
• …

Get the Nth-level ordered map value. Be aware that only applies to each level message’s first map field.

Index #

Prerequisite: You need to set metasheet option Index appropriately.

See metasheet option: Index.

If index name is Chapter, then the accessors are:

• public ref readonly Index_ChapterMap FindChapterMap(): Gets the whole hash map.
• public List<ParentType>? FindChapter(KEY1 k1, KEY2 k2...): Finds values by key. One key may correspond to multiple values, which are returned by a list.
• public ParentType? FindFirstChapter(KEY1 k1, KEY2 k2...): Finds the first value by key, or null if no value found.

If the indexed struct is nested within upper-level map containers, additional APIs are generated for each upper-level map to enable fast scoped lookup. Here N denotes the Nth upper-level map (e.g., 1 for the immediate parent map, 2 for the grandparent map, and so on).

• public Index_ChapterMap? FindChapterMapN(MapKey1Type mapKey1, MapKey2Type mapKey2...): Gets the whole hash map scoped to the specified upper-level map keys.
• public List<ParentType>? FindChapterN(MapKey1Type mapKey1, MapKey2Type mapKey2..., KEY1 k1, KEY2 k2...): Finds values by key within the specified upper-level map. One key may correspond to multiple values, which are returned by a list.
• public ParentType? FindFirstChapterN(MapKey1Type mapKey1, MapKey2Type mapKey2..., KEY1 k1, KEY2 k2...): Finds the first matching value by key within the specified upper-level map, or null if no value found.

OrderedIndex #

Prerequisite: You need to set metasheet option OrderedIndex appropriately.

See metasheet option: OrderedIndex.

If ordered index name is Chapter, then the accessors are:

• public ref readonly OrderedIndex_ChapterMap FindChapterMap(): Gets the whole ordered map.
• public List<ParentType>? FindChapter(KEY1 k1, KEY2 k2...): Finds values by key. One key may correspond to multiple values, which are returned by a list.
• public ParentType? FindFirstChapter(KEY1 k1, KEY2 k2...): Finds the first value by key, or null if no value found.

If the indexed struct is nested within upper-level map containers, additional APIs are generated for each upper-level map to enable fast scoped lookup. Here N denotes the Nth upper-level map (e.g., 1 for the immediate parent map, 2 for the grandparent map, and so on).

• public OrderedIndex_ChapterMap? FindChapterMapN(MapKey1Type mapKey1, MapKey2Type mapKey2...): Gets the whole ordered map scoped to the specified upper-level map keys.
• public List<ParentType>? FindChapterN(MapKey1Type mapKey1, MapKey2Type mapKey2..., KEY1 k1, KEY2 k2...): Finds values by key within the specified upper-level map. One key may correspond to multiple values, which are returned by a list.
• public ParentType? FindFirstChapterN(MapKey1Type mapKey1, MapKey2Type mapKey2..., KEY1 k1, KEY2 k2...): Finds the first matching value by key within the specified upper-level map, or null if no value found.

Custom messager #

If the built-in APIs are not sufficient for your business logic, then you can add a custom messager, where you can write preprocess logic based on loaded config objects.

Example: csharp-tableau-loader/hub/custom

CustomXXXConf.cs:

using Tableau;

public class CustomXXXConf : Messager, IMessagerName
{
    public string Name() => "CustomXXXConf";

    public override bool ProcessAfterLoadAll(Hub hub)
    {
        // TODO: implement here.
        return true;
    }

    // TODO: add custom data fields.
}

Register in your initialization code:

Registry.Register<CustomXXXConf>();

Plugin: protoc-gen-csharp-tableau-loader #

An example to use this protoc plugin: csharp-tableau-loader/gen.sh.

Full example #

See csharp-tableau-loader.