Sample: Rename Projects

In this example, the source project named Test is renamed to Production on the destination.

Python
C#

Mapping Class

from tableau_migration import(
    IProject,
    ContentMappingBase,
    ContentMappingContext)


class ProjectRenameMapping(ContentMappingBase[IProject]):
    def map(self, ctx: ContentMappingContext[IProject]) -> ContentMappingContext[IProject]:
        if not ctx.content_item.name.casefold() == "Test".casefold():
            return ctx
        
        new_location = ctx.content_item.location.rename("Production")
        
        ctx = ctx.map_to(new_location)
        
        return ctx

Registration

plan_builder.mappings.add(ProjectRenameMapping)

See hook registration for more details.

Mapping Class

public class ProjectRenameMapping : ContentMappingBase<IProject>
{
    public ProjectRenameMapping(ISharedResourcesLocalizer localizer, ILogger<IContentMapping<IProject>> logger) : base(localizer, logger)
    { }

    public override async Task<ContentMappingContext<IProject>?> MapAsync(ContentMappingContext<IProject> ctx, CancellationToken cancel)
    {
        if (!String.Equals("Test", ctx.ContentItem.Name, StringComparison.OrdinalIgnoreCase))
        {
            return ctx;
        }

        var newLocation = ctx.ContentItem.Location.Rename("Production");

        ctx = ctx.MapTo(newLocation);

        return await ctx.ToTask();
    }
}

Registration

Learn more.

_planBuilder.Mappings.Add<ProjectRenameMapping, IProject>();

Dependency Injection

Learn more.

services.AddScoped<ProjectRenameMapping>();