Skip to content

Audit schema migration: register handler and cast HasDetails varchar->boolean #7669

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.

Sign up for GitHub

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

Open
labkey-martyp wants to merge 2 commits into
base: release26.3-SNAPSHOT
Choose a base branch
from
Open

Audit schema migration: register handler and cast HasDetails varchar->boolean #7669

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce3b6cb
Register audit schema migration handler with HasDetails varchar->bool…
labkey-martyp May 14, 2026
061b0b4
Merge release26.3-SNAPSHOT into 26.3_fb_snprc_pg_data_migration_fixes
labkey-martyp May 14, 2026
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
61 changes: 61 additions & 0 deletions audit/src/org/labkey/audit/AuditModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
import org.jetbrains.annotations.NotNull;
import org.labkey.api.audit.AuditLogService;
import org.labkey.api.audit.provider.SiteSettingsAuditProvider;
import org.labkey.api.data.ColumnInfo;
import org.labkey.api.data.JdbcType;
import org.labkey.api.data.SQLFragment;
import org.labkey.api.data.TableInfo;
import org.labkey.api.data.WrappedColumn;
import org.labkey.api.migration.DatabaseMigrationService;
import org.labkey.api.migration.MigrationTableHandler;
import org.labkey.api.module.DefaultModule;
import org.labkey.api.module.ModuleContext;
import org.labkey.api.view.WebPartFactory;
Expand All @@ -27,6 +34,7 @@
import java.util.Collection;
import java.util.Collections;
import java.util.Set;
import java.util.TreeSet;

public class AuditModule extends DefaultModule
{
Expand Down Expand Up @@ -89,4 +97,57 @@ public Set<String> getProvisionedSchemaNames()
{
return Collections.singleton(AuditSchema.SCHEMA_NAME);
}

private final Set<String> _registeredMigrationTables = new TreeSet<>(String.CASE_INSENSITIVE_ORDER);

@Override
public void registerMigrationHandlers(@NotNull DatabaseMigrationService service)
{
service.registerSchemaContributor(AuditSchema.SCHEMA_NAME, schema ->
schema.getTableNames().stream()
.map(schema::getTable)
.filter(table -> table != null && _registeredMigrationTables.add(table.getSelectName()))
.forEach(table -> service.registerTableHandler(new MigrationTableHandler()
{
@Override
public TableInfo getTableInfo()
{
return table;
}

@Override
public ColumnInfo handleColumn(ColumnInfo col)
{
if ("hasdetails".equalsIgnoreCase(col.getName()))
return new HasDetailsCastColumn(col);
return col;
}
})));
}

// Some legacy source databases store the DatasetAuditDomain "HasDetails" column as varchar
// while the target was provisioned as boolean. CAST to BIT in the source SELECT and report
// BOOLEAN as the JdbcType so the migration's INSERT parameter binds cleanly into the
// target's boolean column (otherwise the parameter inherits the source column's VARCHAR
// type and PG rejects the bound value).
private static final class HasDetailsCastColumn extends WrappedColumn
{
private HasDetailsCastColumn(ColumnInfo col)
{
super(col, col.getName());
}

@Override
@NotNull
public JdbcType getJdbcType()
{
return JdbcType.BOOLEAN;
}

@Override
public SQLFragment getValueSql(String tableAlias)
{
return new SQLFragment("CAST(").append(super.getValueSql(tableAlias)).append(" AS BIT)");
}
}
}