Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Correct documentation for SequentialGuidValueGenerator #20696

Merged
merged 1 commit into from
Apr 20, 2020
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/EFCore/ValueGeneration/SequentialGuidValueGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,19 @@
namespace Microsoft.EntityFrameworkCore.ValueGeneration
{
/// <summary>
/// Generates sequential <see cref="Guid" /> values using the same algorithm as NEWSEQUENTIALID()
/// in Microsoft SQL Server. This is useful when entities are being saved to a database where sequential
/// GUIDs will provide a performance benefit. The generated values are non-temporary, meaning they will
/// be saved to the database.
/// <para>
/// Generates sequential <see cref="Guid" /> values optimized for use in Microsoft SQL server clustered
/// keys or indexes, yielding better performance than random values. This is the default generator for
/// SQL Server <see cref="Guid" /> columns which are set to be generated on add.
/// </para>
/// <para>
/// See https://docs.microsoft.com/sql/t-sql/functions/newsequentialid-transact-sql.
/// Although this generator achieves the same goals as SQL Server's NEWSEQUENTIALID, the algorithm used
/// to generate the GUIDs is different.
/// </para>
/// <para>
/// The generated values are non-temporary, meaning they will be saved to the database.
/// </para>
/// </summary>
public class SequentialGuidValueGenerator : ValueGenerator<Guid>
{
Expand Down