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

Apply fill factor when creating tables #33407

Merged
merged 2 commits into from
Mar 27, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
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
15 changes: 8 additions & 7 deletions src/EFCore.Relational/Migrations/MigrationsSqlGenerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -241,8 +241,6 @@ protected virtual void Generate(

PrimaryKeyConstraint(operation, model, builder);

KeyWithOptions(operation, builder);

if (terminate)
{
builder.AppendLine(Dependencies.SqlGenerationHelper.StatementTerminator);
Expand All @@ -269,8 +267,6 @@ protected virtual void Generate(

UniqueConstraint(operation, model, builder);

KeyWithOptions(operation, builder);

builder.AppendLine(Dependencies.SqlGenerationHelper.StatementTerminator);
EndStatement(builder);
}
Expand Down Expand Up @@ -1622,6 +1618,8 @@ protected virtual void PrimaryKeyConstraint(
builder.Append("(")
.Append(ColumnList(operation.Columns))
.Append(")");

KeyTraits(operation, model, builder);
}

/// <summary>
Expand Down Expand Up @@ -1669,6 +1667,8 @@ protected virtual void UniqueConstraint(
builder.Append("(")
.Append(ColumnList(operation.Columns))
.Append(")");

KeyTraits(operation, model, builder);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Am not sure at all, but do we think unique constraints have common options/traits with primary keys? I thought e.g. fill factor is defined at the index level, rather than on the unique constraint (not sure).

Maybe it's better to be safe and make this a SQL Server-only thing rather than a relational thing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't know. @AndriySvyryd approved the original PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SQL Server supports most of the index options at the primary key level, don't know about other databases

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Basically, we don't need KeyTraits, just call IndexOptions here. Only the relevant facets will be present on the operation.

}

/// <summary>
Expand Down Expand Up @@ -1717,12 +1717,13 @@ protected virtual void CheckConstraint(
}

/// <summary>
/// Generates a SQL fragment for extra with options of a key from a
/// <see cref="AddPrimaryKeyOperation" /> or <see cref="AddUniqueConstraintOperation" />.
/// Generates a SQL fragment for traits of an primary key or alternate key from a <see cref="CreateTableOperation" />,
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/// Generates a SQL fragment for traits of an primary key or alternate key from a <see cref="CreateTableOperation" />,
/// Generates a SQL fragment for traits of a primary key or alternate key from a <see cref="CreateTableOperation" />,

/// <see cref="AddPrimaryKeyOperation" />, or <see cref="AddUniqueConstraintOperation" />.
/// </summary>
/// <param name="operation">The operation.</param>
/// <param name="model">The target model which may be <see langword="null" /> if the operations exist without a model.</param>
/// <param name="builder">The command builder to use to add the SQL fragment.</param>
protected virtual void KeyWithOptions(MigrationOperation operation, MigrationCommandListBuilder builder)
protected virtual void KeyTraits(MigrationOperation operation, IModel? model, MigrationCommandListBuilder builder)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For sequence/index I thing we use the word "Options" rather than "Traits"

Copy link
Member Author

@ajcvickers ajcvickers Mar 26, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This copies the pattern used for IndexTraits which is the already existing method right above this one.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note however, we call IndexTraits at different places. I know know if it needs to called at different places--again @AndriySvyryd approved the original PR.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, missed that we had IndexTraits, makes sense I guess (though not sure why we have options in some places and traits in others...)

{
}

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1775,26 +1775,14 @@ protected virtual void Transfer(
}
}

/// <summary>
/// Generates a SQL fragment for extra with options of a key from a
/// <see cref="AddPrimaryKeyOperation" />, or <see cref="AddUniqueConstraintOperation" />.
/// </summary>
/// <param name="operation">The operation.</param>
/// <param name="builder">The command builder to use to add the SQL fragment.</param>
protected override void KeyWithOptions(MigrationOperation operation, MigrationCommandListBuilder builder)
/// <inheritdoc/>
protected override void KeyTraits(MigrationOperation operation, IModel? model, MigrationCommandListBuilder builder)
{
var options = new List<string>();

if (operation[SqlServerAnnotationNames.FillFactor] is int fillFactor)
{
options.Add("FILLFACTOR = " + fillFactor);
}

if (options.Count > 0)
{
builder
.Append(" WITH (")
.Append(string.Join(", ", options))
.Append(" WITH (FILLFACTOR = ")
.Append(fillFactor.ToString())
.Append(")");
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -354,6 +354,42 @@ PERIOD FOR SYSTEM_TIME([PeriodStart], [PeriodEnd])
""");
}

[ConditionalFact]
public virtual async Task Create_table_with_fill_factor()
{
await Test(
_ => { },
builder =>
{
builder.Entity("People").Property<int>("TheKey");
builder.Entity("People").Property<Guid>("TheAlternateKey");
builder.Entity("People").HasKey("TheKey").HasFillFactor(81);
builder.Entity("People").HasAlternateKey("TheAlternateKey").HasFillFactor(82);
},
model =>
{
var table = Assert.Single(model.Tables);

var primaryKey = table.PrimaryKey;
Assert.NotNull(primaryKey);
Assert.Equal(81, primaryKey[SqlServerAnnotationNames.FillFactor]);

var uniqueConstraint = table.UniqueConstraints.FirstOrDefault();
Assert.NotNull(uniqueConstraint);
Assert.Equal(82, uniqueConstraint[SqlServerAnnotationNames.FillFactor]);
});

AssertSql(
"""
CREATE TABLE [People] (
[TheKey] int NOT NULL IDENTITY,
[TheAlternateKey] uniqueidentifier NOT NULL,
CONSTRAINT [PK_People] PRIMARY KEY ([TheKey]) WITH (FILLFACTOR = 81),
CONSTRAINT [AK_People_TheAlternateKey] UNIQUE ([TheAlternateKey]) WITH (FILLFACTOR = 82)
);
""");
}

public override async Task Drop_table()
{
await base.Drop_table();
Expand Down
Loading