Improve documentation for MSSQL #1122
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR significantly expands the Microsoft SQL Server (MSSQL) integration documentation to provide comprehensive guidance for production usage. The update transforms a minimal setup example into a detailed guide covering all aspects of MSSQL integration.
- Adds detailed prerequisites, installation instructions, and configuration examples
- Provides comprehensive coverage of event store, snapshot store, and read model store setup
- Includes production deployment checklist and operational recommendations
|
|
||
| - .NET 8.0 (or the version used by your application) with access to NuGet feeds. | ||
| - SQL Server 2017 or later (on-premises or Azure SQL Database) with permissions to create schemas, tables, indexes, and table types. | ||
| - An understanding of EventFlow event sourcing concepts such as [aggregates](../basics/aggregates.md) and [read stores](read-stores.md). |
There was a problem hiding this comment.
The link to read-stores.md appears to be missing the full relative path. It should likely be ../read-stores.md or the correct path within the documentation structure to ensure proper navigation.
| - An understanding of EventFlow event sourcing concepts such as [aggregates](../basics/aggregates.md) and [read stores](read-stores.md). | |
| - An understanding of EventFlow event sourcing concepts such as [aggregates](../basics/aggregates.md) and [read stores](../basics/read-stores.md). |
| options | ||
| .ConfigureMsSql(MsSqlConfiguration | ||
| .New | ||
| .SetConnectionString(@"Server=.\SQLEXPRESS;Database=MyApp;User Id=sa;Password=Pa55w0rd!")) |
There was a problem hiding this comment.
The example shows a hardcoded password in the connection string. Consider using a placeholder or environment variable reference to demonstrate secure credential handling practices.
| .SetConnectionString(@"Server=.\SQLEXPRESS;Database=MyApp;User Id=sa;Password=Pa55w0rd!")) | |
| .SetConnectionString(@"Server=.\SQLEXPRESS;Database=MyApp;User Id=sa;Password={YOUR_PASSWORD}")) |
|
|
||
| ## Prerequisites | ||
|
|
||
| - .NET 8.0 (or the version used by your application) with access to NuGet feeds. |
There was a problem hiding this comment.
The prerequisite specifies .NET 8.0 but EventFlow may support earlier versions. This should align with the actual minimum supported .NET version for the EventFlow.MsSql package.
| - .NET 8.0 (or the version used by your application) with access to NuGet feeds. | |
| - .NET 6.0 or later (or the version used by your application) with access to NuGet feeds. |
No description provided.