Agent skill
orchardcore-data-migrations
Skill for creating data migrations in Orchard Core. Covers content type migrations, YesSql index table creation, schema alterations, data seeding, and migration versioning patterns.
Install this agent skill to your Project
npx add-skill https://github.com/majiayu000/claude-skill-registry/tree/main/skills/other/other/orchardcore-data-migrations
Metadata
Additional technical details for this skill
- author
- CrestApps Team
- version
- 1.0
SKILL.md
Orchard Core Data Migrations - Prompt Templates
Create Data Migrations
You are an Orchard Core expert. Generate data migration code for Orchard Core modules.
Guidelines
- Data migrations inherit from
DataMigration. - Migrations define content types, parts, fields, and database indexes.
- Use
CreateAsync()for initial migration,UpdateFrom1Async(),UpdateFrom2Async()for incremental updates. - Register migrations in
Startup.csusingservices.AddScoped<IDataMigration, Migrations>(). IContentDefinitionManageris used to define content types and parts.SchemaBuilderis used to create and alter YesSql index tables.- Always seal classes.
Basic Migration with Content Type
using OrchardCore.ContentManagement.Metadata;
using OrchardCore.ContentManagement.Metadata.Settings;
using OrchardCore.Data.Migration;
public sealed class Migrations : DataMigration
{
private readonly IContentDefinitionManager _contentDefinitionManager;
public Migrations(IContentDefinitionManager contentDefinitionManager)
{
_contentDefinitionManager = contentDefinitionManager;
}
public async Task<int> CreateAsync()
{
await _contentDefinitionManager.AlterTypeDefinitionAsync("{{ContentType}}", type => type
.DisplayedAs("{{DisplayName}}")
.Creatable()
.Listable()
.Draftable()
.Versionable()
.WithPart("TitlePart", part => part.WithPosition("0"))
.WithPart("AutoroutePart", part => part
.WithPosition("1")
.WithSettings(new AutoroutePartSettings
{
AllowCustomPath = true,
Pattern = "{{ ContentItem | display_text | slugify }}"
})
)
.WithPart("HtmlBodyPart", part => part
.WithPosition("2")
.WithEditor("Wysiwyg")
)
.WithPart("{{ContentType}}Part", part => part.WithPosition("3"))
);
return 1;
}
}
Migration with Custom Content Part and Fields
public sealed class Migrations : DataMigration
{
private readonly IContentDefinitionManager _contentDefinitionManager;
public Migrations(IContentDefinitionManager contentDefinitionManager)
{
_contentDefinitionManager = contentDefinitionManager;
}
public async Task<int> CreateAsync()
{
// Define the custom part with fields
await _contentDefinitionManager.AlterPartDefinitionAsync("{{PartName}}", part => part
.WithField("{{FieldName}}", field => field
.OfType("TextField")
.WithDisplayName("{{FieldDisplayName}}")
.WithPosition("0")
.WithSettings(new TextFieldSettings
{
Required = true,
Hint = "{{FieldHint}}"
})
)
.WithField("Description", field => field
.OfType("TextField")
.WithDisplayName("Description")
.WithPosition("1")
.WithEditor("TextArea")
)
.WithField("Image", field => field
.OfType("MediaField")
.WithDisplayName("Image")
.WithPosition("2")
)
);
// Define the content type with the custom part
await _contentDefinitionManager.AlterTypeDefinitionAsync("{{ContentType}}", type => type
.DisplayedAs("{{DisplayName}}")
.Creatable()
.Listable()
.WithPart("TitlePart", part => part.WithPosition("0"))
.WithPart("{{PartName}}", part => part.WithPosition("1"))
);
return 1;
}
}
Migration with YesSql Index Table
using OrchardCore.Data.Migration;
using YesSql.Sql;
public sealed class Migrations : DataMigration
{
public async Task<int> CreateAsync()
{
await SchemaBuilder.CreateMapIndexTableAsync<{{IndexName}}>(table => table
.Column<string>(nameof({{IndexName}}.ContentItemId), col => col.WithLength(26))
.Column<string>(nameof({{IndexName}}.{{PropertyName}}), col => col.WithLength(256))
.Column<bool>(nameof({{IndexName}}.Published))
.Column<DateTime>(nameof({{IndexName}}.CreatedUtc))
);
await SchemaBuilder.AlterIndexTableAsync<{{IndexName}}>(table => table
.CreateIndex(
"IDX_{{IndexName}}_{{PropertyName}}",
nameof({{IndexName}}.{{PropertyName}}),
nameof({{IndexName}}.Published)
)
);
return 1;
}
}
Incremental Migration (UpdateFrom)
public sealed class Migrations : DataMigration
{
private readonly IContentDefinitionManager _contentDefinitionManager;
public Migrations(IContentDefinitionManager contentDefinitionManager)
{
_contentDefinitionManager = contentDefinitionManager;
}
public async Task<int> CreateAsync()
{
// Initial migration
await _contentDefinitionManager.AlterTypeDefinitionAsync("{{ContentType}}", type => type
.DisplayedAs("{{DisplayName}}")
.Creatable()
.Listable()
.WithPart("TitlePart")
);
return 1;
}
public async Task<int> UpdateFrom1Async()
{
// Add a new field in version 2
await _contentDefinitionManager.AlterPartDefinitionAsync("{{ContentType}}", part => part
.WithField("Category", field => field
.OfType("TextField")
.WithDisplayName("Category")
.WithPosition("2")
)
);
return 2;
}
public async Task<int> UpdateFrom2Async()
{
// Add an index table in version 3
await SchemaBuilder.CreateMapIndexTableAsync<{{ContentType}}Index>(table => table
.Column<string>("ContentItemId", col => col.WithLength(26))
.Column<string>("Category", col => col.WithLength(256))
.Column<bool>("Published")
);
return 3;
}
}
Registering Migrations and Indexes
using OrchardCore.Data.Migration;
using YesSql.Indexes;
public sealed class Startup : StartupBase
{
public override void ConfigureServices(IServiceCollection services)
{
services.AddScoped<IDataMigration, Migrations>();
services.AddIndexProvider<{{IndexName}}Provider>();
}
}
Uninstall Migration
Handle cleanup when a feature is disabled:
public sealed class Migrations : DataMigration
{
public async Task UninstallAsync()
{
await SchemaBuilder.DropMapIndexTableAsync<{{IndexName}}>();
}
}
Recommended Agent Skills
Expand your agent's capabilities with these related and highly-rated skills.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
majiayu000/claude-skill-registry
agent-ops-spec
Manage specification documents in .agent/specs/. Use when user provides requirements, acceptance criteria, or feature descriptions that need to be tracked and validated against implementation.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-testing
Test strategy, execution, and coverage analysis. Use when designing tests, running test suites, or analyzing test results beyond baseline checks.
majiayu000/claude-skill-registry
agent-ops-state
Maintain .agent state files. Use at session start, after meaningful steps, and before concluding: read/update constitution/memory/focus/issues/baseline consistently.
Didn't find tool you were looking for?