search

akkadotnet / akka.net

Canonical actor model implementation for .NET with local + distributed actors in C# and F#.
http://getakka.net
Other
4.71k stars 1.04k forks source link

Document types of supported queries and semantics #5723

Open SeanKilleen opened 2 years ago

SeanKilleen commented 2 years ago

Please describe what you are trying to understand

I've got an application using Persistence to SQL Server. I am attempting to project events into a more query-friendly SQL Server structure.

What did these pages not make clear?

On the Persistence Query page, the docs state:

Each read journal must explicitly document which types of queries it supports. Refer to your journal's plugins documentation for details on which queries and semantics it supports.

As far as I can tell, that means I should check this repo. However, this repo does not appear to say anything about the types of queries and semantics it supports, or any documentation of persistent views.

How can we do it better?

Usage documentation for this plugin around creating a persistent query or materialized view, perhaps with an example, would be phenomenal. I assume many like me may be encountering these topics for the first time and may require a little more hand-holding in terms of achieving an objective.

ismaelhamed commented 2 years ago

Yes. This is the missing doc: https://doc.akka.io/docs/akka/current/persistence-query-leveldb.html

But since all SqlCommon plugins are basically a port of the LevelDb plugin in the JVM, maybe this documentation should be added to the Akka.NET repo instead.

Aaronontheweb commented 2 years ago

On mobile now but I'll transfer this issue to the central repo. We should definitely cover this in more detail.

Aaronontheweb commented 2 years ago

Moved this over. Part of the 1.5 roadmap is making CQRS a more central theme of Akka.NET and Akka.Persistence.Query is the driver for that, so we'll do our best to reflect that.