Bot.Library.Mongo

MongoDB storage for Lds.Bot.Library.

The engine takes no database dependency at all. It reaches persistence through three ports — IConversationStore, IBotUserStore and IBotSettingsStore — and this package implements them over MongoDB.Driver. Take it if MongoDB is what you have; write your own four registrations if it is not, and the engine neither knows nor cares.

var database = new MongoClient(connectionString).GetDatabase("mydatabase");

builder.Services.AddBotEngine(client, options => { … }, dialogs => …);
builder.Services.AddBotMongoStores(database);          // this package

var app = builder.Build();
await database.EnsureBotIndexesAsync(app.Services.GetRequiredService<BotOptions>());
await app.Services.LoadBotSettingsAsync();

Three collections, in your database on your connection: BotUserInfo, BotConversationState, BotSettings.

Before you upgrade an existing database

Two one-off migrations live in BotMaintenance, and neither runs by itself:

What a store has to promise

Nine contracts the engine relies on and cannot check. They are documented in the core package's readme and they are executable: Bot.Library.Tests/Contracts/ holds one abstract fixture each, phrased against the port interfaces alone. This package subclasses all nine against a real mongod. If you write your own store, subclass them too — it is the cheapest way to find out whether it works.

Two things about the stored shape, both measured rather than reasoned, and both preserved here deliberately: _id is not the same BSON type on all three collections (BotConversationState._id is an ObjectId, the other two are strings), and the class maps set IgnoreExtraElements, without which any document written by another version of this package throws on read.

Full documentation: the core package's readme, §7 Persistence.