dotnet / docs

This repository contains .NET Documentation.
https://learn.microsoft.com/dotnet
Creative Commons Attribution 4.0 International
4.22k stars 5.87k forks source link

Orleans: AdoNet Setup: Migrations scripts are missing from instructions #38870

Open yoDon opened 8 months ago

yoDon commented 8 months ago

Type of issue

Missing information

Description

The docs need to instruct the user to also execute the appropriate SQL Migration script from orleans/src/AdoNet/Orleans.Clustering.AdoNet/Migrations/

As currently written, AdoNet MySql silo persistence will fail on await host.RunAsync() with

System.ArgumentException: Not all required queries found. 
  Missing are: CleanupDefunctSiloEntriesKey
  at Orleans.Clustering.AdoNet.Storage.DbStoredQueries..ctor(Dictionary`2 queries) in
  /_/src/AdoNet/Shared/Storage/DbStoredQueries.cs:line 39

because the database does not have the CleanupDefunctSiloEntriesKey function defined in the oddly named MySQL-Clustering-3.7.0.sql file (the name of the file has "Clustering" in it when I suspect the filename should actually have the word "Migrations" in it not "Clustering")

Please note there are pairs of files with the same name in different folders in the project, one set that is oddly not grouped under a sub-folder (they are just in the Orleans.Clustering.AdoNet folder), the other set that is under Orleans.Clustering.AdoNet/Migrations. Both sets are have the same filenames (describing them as Clustering scripts) but they have different contents. This naming error(?) may be why the docs are missing the second set. I suspect that the Migrations folder files should be named as Migrations files, and the ungrouped Clustering files should be moved into a Clustering folder, but the docs issue can be resolved simply by referencing the files in the Migrations folder in the docs page.

Page URL

https://learn.microsoft.com/en-us/dotnet/orleans/host/configuration-guide/adonet-configuration

Content source URL

https://github.com/dotnet/docs/blob/main/docs/orleans/host/configuration-guide/adonet-configuration.md

Document Version Independent Id

043150e5-4a08-659e-be27-4ea604fad303

Article author

@IEvangelist

Metadata

IEvangelist commented 8 months ago

Hi @yoDon - is this something you would be interested in making a PR to update?

yoDon commented 8 months ago

Good nudge - at the time I submitted this I didn't feel like I understood things well enough to do so. At this point I'm much more comfortable updating these docs. Will aim for next couple days.

IEvangelist commented 2 months ago

Seems related to #36292