27198235588

Committed 09 Jun 2026 09:53AM UTC coverage: 57.016% (+0.05%) from 56.971%

Build # 27198235588

Build Type

Pull #2343

github

Committed by

JFriel

Commit Message

update codeql

Pull Request Pull Request #2343: Task/rdmp 376 extraction structural changes

Coverage Stats

11582 of 21847 branches covered (53.01%)

Branch coverage included in aggregate %.

31 of 60 new or added lines in 3 files covered. (51.67%)

152 existing lines in 5 files now uncovered.

32702 of 55823 relevant lines covered (58.58%)

18085.82 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

62.58

/Rdmp.Core/DataExport/DataExtraction/Pipeline/Destinations/ExecuteFullExtractionToDatabaseMSSql.cs

// Copyright (c) The University of Dundee 2018-2024
// This file is part of the Research Data Management Platform (RDMP).
// RDMP is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
// RDMP is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
// You should have received a copy of the GNU General Public License along with RDMP. If not, see <https://www.gnu.org/licenses/>.

using Amazon.Auth.AccessControlPolicy;
using FAnsi.Discovery;
using NPOI.SS.Formula.Functions;
using Rdmp.Core.CommandExecution;
using Rdmp.Core.Curation.Data;
using Rdmp.Core.DataExport.Data;
using Rdmp.Core.DataExport.DataExtraction.Commands;
using Rdmp.Core.DataExport.DataExtraction.UserPicks;
using Rdmp.Core.DataExport.DataRelease.Pipeline;
using Rdmp.Core.DataExport.DataRelease.Potential;
using Rdmp.Core.DataFlowPipeline;
using Rdmp.Core.DataLoad.Engine.Job.Scheduling;
using Rdmp.Core.DataLoad.Engine.Pipeline.Destinations;
using Rdmp.Core.DataLoad.Triggers;
using Rdmp.Core.DataLoad.Triggers.Exceptions;
using Rdmp.Core.DataLoad.Triggers.Implementations;
using Rdmp.Core.MapsDirectlyToDatabaseTable;
using Rdmp.Core.QueryBuilding;
using Rdmp.Core.Repositories;
using Rdmp.Core.ReusableLibraryCode;
using Rdmp.Core.ReusableLibraryCode.Checks;
using Rdmp.Core.ReusableLibraryCode.DataAccess;
using Rdmp.Core.ReusableLibraryCode.Progress;
using System;
using System.Data;
using System.Diagnostics;
using System.IO;
using System.Linq;
using System.Text.RegularExpressions;
using YamlDotNet.Core;

namespace Rdmp.Core.DataExport.DataExtraction.Pipeline.Destinations;

/// <summary>
/// Alternate extraction pipeline destination in which the DataTable containing the extracted dataset is written to an Sql Server database
/// </summary>
public class ExecuteFullExtractionToDatabaseMSSql : ExtractionDestination
{
    [DemandsInitialization(
        "External server to create the extraction into, a new database will be created for the project based on the naming pattern provided",
        Mandatory = true)]
    public IExternalDatabaseServer TargetDatabaseServer { get; set; }

    [DemandsInitialization(@"How do you want to name datasets, use the following tokens if you need them:   
         $p - Project Name ('e.g. My Project')
         $n - Project Number (e.g. 234)
         $t - Master Ticket (e.g. 'LINK-1234')
         $r - Request Ticket (e.g. 'LINK-1234')
         $l - Release Ticket (e.g. 'LINK-1234')
         $e - Extraction Configuration Id (e.g. 14)
         ", Mandatory = true, DefaultValue = "Proj_$n_$l")]
    public string DatabaseNamingPattern { get; set; }

    [DemandsInitialization(@"How do you want to name datasets, use the following tokens if you need them:   
         $p - Project Name ('e.g. My Project')
         $n - Project Number (e.g. 234)
         $c - Configuration Name (e.g. 'Cases')
         $d - Dataset name (e.g. 'Prescribing')
         $a - Dataset acronym (e.g. 'Presc') 
         $e - Extraction Configuration Id (e.g. 14)
         You must have either $a or $d
         ", Mandatory = true, DefaultValue = "$c_$d")]
    public string TableNamingPattern { get; set; }

    [DemandsInitialization(
        @"If the extraction fails half way through AND the destination table was created during the extraction then the table will be dropped from the destination rather than being left in a half loaded state ",
        defaultValue: true)]
    public bool DropTableIfLoadFails { get; set; }

    [DemandsInitialization(DataTableUploadDestination.AlterTimeout_Description, DefaultValue = 300)]
    public int AlterTimeout { get; set; }

    [DemandsInitialization("By applying the primary keys after writing the data, it ensures all data is extracted. Disabling this configuration may improve performance but will quickly raise issues with poorly keyed data.", DefaultValue = true)]
    public bool WriteDataBeforeApplyingPrimaryKeys { get; set; }

    [DemandsInitialization(
        "True to copy the column collations from the source database when creating the destination database.  Only works if both the source and destination have the same DatabaseType.  Excludes columns which feature a transform as part of extraction.",
        DefaultValue = false)]
    public bool CopyCollations { get; set; }

    [DemandsInitialization(
        "True to always drop the destination database table(s) from the destination if they already existed",
        DefaultValue = false)]
    public bool AlwaysDropExtractionTables { get; set; }

    [DemandsInitialization(
        "True to apply a distincting operation to the final table when using an ExtractionProgress.  This prevents data duplication from failed batch resumes.",
        DefaultValue = true)]
    public bool MakeFinalTableDistinctWhenBatchResuming { get; set; } = true;


    [DemandsInitialization("If this extraction has already been run, it will append the extraction data into the database. There is no duplication protection with this functionality.")]
    public bool AppendDataIfTableExists { get; set; } = false;

    [DemandsInitialization("If checked, a column names 'extraction_timestamp' will be included in the extraction that denotes the time the record was added to the extraction.")]
    public bool IncludeTimeStamp { get; set; } = false;


    [DemandsInitialization("If checked, indexed will be created using the primary keys specified")]
    public bool IndexTables { get; set; } = true;

    [DemandsInitialization(@"How do you want to name the created index, use the following tokens if you need them:   
         $p - Project Name ('e.g. My Project')
         $n - Project Number (e.g. 234)
         $c - Configuration Name (e.g. 'Cases')
         $d - Dataset name (e.g. 'Prescribing')
         $a - Dataset acronym (e.g. 'Presc') 
         $e - Extraction Configuration Id (e.g. 14)
         You must have either $a or $d
         ", DefaultValue = "Index_$c_$d")]
    public string IndexNamingPattern { get; set; }

    [DemandsInitialization("An optional list of columns to index on e.g \"Column1, Column2\"")]
    public string UserDefinedIndex { get; set; }


    [DemandsInitialization("When writing to an existing database, will update records and store historical versions via a view", DefaultValue = false)]
    public bool UseArchiveTrigger { get; set; }

    private DiscoveredDatabase _destinationDatabase;
    private DataTableUploadDestination _destination;

    private bool _tableDidNotExistAtStartOfLoad;
    private bool _isTableAlreadyNamed;
    private DataTable _toProcess;
    private IBasicActivateItems _activator;

    public ExecuteFullExtractionToDatabaseMSSql() : base(false)
    {
    }

    public override DataTable ProcessPipelineData(DataTable toProcess, IDataLoadEventListener job,
        GracefulCancellationToken cancellationToken)
    {
        _destinationDatabase = GetDestinationDatabase(job);
        return base.ProcessPipelineData(toProcess, job, cancellationToken);
    }

    protected override void Open(DataTable toProcess, IDataLoadEventListener job,
        GracefulCancellationToken cancellationToken)
    {
        _toProcess = toProcess;

        //give the data table the correct name
        if (_toProcess.ExtendedProperties.ContainsKey("ProperlyNamed") &&
            _toProcess.ExtendedProperties["ProperlyNamed"].Equals(true))
            _isTableAlreadyNamed = true;

        _toProcess.TableName = GetTableName();

        _destination = PrepareDestination(job, _toProcess);
        OutputFile = _toProcess.TableName;
    }

    protected override void WriteRows(DataTable toProcess, IDataLoadEventListener job,
        GracefulCancellationToken cancellationToken, Stopwatch stopwatch)
    {
        // empty batches are allowed when using batch/resume
        if (toProcess.Rows.Count == 0 && _request.IsBatchResume) return;

        if (_request.IsBatchResume) _destination.AllowLoadingPopulatedTables = true;

        _destination.ProcessPipelineData(toProcess, job, cancellationToken);

        LinesWritten += toProcess.Rows.Count;
    }


    private bool hasStructuralChanges(DataTable source, DiscoveredTable destination)
    {
        var sourceColumns = source.Columns.Cast<DataColumn>().Select(c => c.ColumnName).ToList();
        var destinationColumns = destination.DiscoverColumns().Select(c => c.GetRuntimeName()).ToList();
        return !sourceColumns.All(destinationColumns.Contains) || !destinationColumns.All(sourceColumns.Contains);
    }


    private DataTableUploadDestination PrepareDestination(IDataLoadEventListener listener, DataTable toProcess)
    {
        //see if the user has entered an extraction server/database
        if (TargetDatabaseServer == null)
            throw new Exception(
                "TargetDatabaseServer (the place you want to extract the project data to) property has not been set!");

        try
        {
            if (!_destinationDatabase.Exists())
                _destinationDatabase.Create();

            if (_request is ExtractGlobalsCommand)
                return null;

            var tblName = _toProcess.TableName;

            //See if table already exists on the server (likely to cause problems including duplication, schema changes in configuration etc)
            var existing = _destinationDatabase.ExpectTable(tblName);
            if (existing.Exists())
            {
                var hasPKs = existing.DiscoverColumns().Any(col => col.IsPrimaryKey);
                TriggerImplementerFactory triggerFactory = new TriggerImplementerFactory(FAnsi.DatabaseType.MicrosoftSQLServer);
                var implementor = triggerFactory.Create(existing);
                bool triggerPresent;
                try
                {
                    triggerPresent = implementor.GetTriggerStatus() == DataLoad.Triggers.TriggerStatus.Enabled;
                }
                catch (TriggerMissingException)
                {
                    triggerPresent = false;
                }
                if (!AlwaysDropExtractionTables)
                {
                    //check the PKs are the same
                    var remotePKs = existing.DiscoverColumns().Where(col => col.IsPrimaryKey).Select(col => col.GetRuntimeName()).ToList();
                    var rdmpPKs = toProcess.PrimaryKey.Cast<DataColumn>().Select(col => col.ColumnName).ToList();
                    if (!remotePKs.All(rdmpPKs.Contains) || remotePKs.Count != rdmpPKs.Count)
                    {
                        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Error,
                            $"""
                        Table {existing.GetFullyQualifiedName()} already exists and has different PKs to the source table.                            
                        Source PKs: {string.Join(", ", rdmpPKs)}
                        Destination PKs: {string.Join(", ", remotePKs)}
                        """));
                        return null;//todo this error could be better
                    }
                    if (hasStructuralChanges(toProcess, existing))
                    {
                        var sourceColumns = toProcess.Columns.Cast<DataColumn>().Select(c => c.ColumnName).ToList();
                        var destinationColumns = existing.DiscoverColumns().Select(c => c.GetRuntimeName()).ToList();

                        if (triggerPresent && destinationColumns.Except(sourceColumns).Where(c => !SpecialFieldNames.IsHicPrefixed(c)).Any())//only mess about with column removal if there is an archive trigger
                        {

                            //move everything into the archive - do this by updating the HIC_validfrom
                            var sql = $"UPDATE {existing.GetFullyQualifiedName()} set {SpecialFieldNames.ValidFrom} = GETDATE()";
                            using var con = _destinationDatabase.Server.GetConnection();
                            con.Open();
                            using var cmd = _destinationDatabase.Server.GetCommand(sql, con);
                            cmd.CommandTimeout = 30000;
                            cmd.ExecuteNonQuery();

                            var removedColumns = destinationColumns.Except(sourceColumns).Where(c => !SpecialFieldNames.IsHicPrefixed(c));
                            foreach (var column in removedColumns.Select(c => existing.DiscoverColumn(c)))
                            {
                                existing.DropColumn(column);
                            }
                            string triggerProblems = "";
                            string triggerOK = "";
                            implementor.DropTrigger(out triggerProblems, out triggerOK);
                            if (triggerProblems != "")
                            {
                                listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Error, triggerProblems));
                            }

                            existing = _destinationDatabase.ExpectTable(tblName);
                            implementor = triggerFactory.Create(existing);
                            try
                            {
                                triggerPresent = implementor.GetTriggerStatus() == DataLoad.Triggers.TriggerStatus.Enabled;
                            }
                            catch (TriggerMissingException)
                            {
                                triggerPresent = false;
                            }
                        }
                    }

                }

                if (_request.IsBatchResume)
                {
                    listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,
                        $"Table {existing.GetFullyQualifiedName()} already exists but it IsBatchResume so no problem."));
                }
                else if (AlwaysDropExtractionTables)
                {
                    listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning,
                        $"Table {existing.GetFullyQualifiedName()} already exists, dropping because setting {nameof(AlwaysDropExtractionTables)} is on"));
                    existing.Drop();

                    listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning,
                        $"Table {existing.GetFullyQualifiedName()} was dropped"));

                    // since we dropped it we should treat it as if it was never there to begin with
                    _tableDidNotExistAtStartOfLoad = true;
                }
                else if (UseArchiveTrigger && hasPKs)
                {
                    //check the columns are correct, we might have added some
                    var existingColumns = existing.DiscoverColumns();
                    var existingColumnNames = existingColumns.Select(ec => ec.GetRuntimeName());
                    var toProcessColumnNames = toProcess.Columns.Cast<DataColumn>().Select(col => col.ColumnName);
                    var newColumns = toProcessColumnNames.Where(c => !existingColumnNames.Contains(c));
                    if (newColumns.Any())
                    {
                        var archiveTable = _destinationDatabase.ExpectTable(tblName + "_Archive");
                        if (archiveTable.Exists())
                        {
                            foreach (var column in newColumns)
                            {
                                existing.AddColumn(column, new TypeGuesser.DatabaseTypeRequest(toProcess.Columns[column].DataType), true, 30000);
                                if (archiveTable.DiscoverColumns().All(col => col.GetRuntimeName() != column))
                                {
                                    archiveTable.AddColumn(column, new TypeGuesser.DatabaseTypeRequest(toProcess.Columns[column].DataType), true, 30000);
                                }
                            }
                            if (triggerPresent)
                            {
                                string triggerProblems = "";
                                string triggerOK = "";
                                implementor.DropTrigger(out triggerProblems, out triggerOK);
                                if (triggerProblems != "")
                                {
                                    listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Error, triggerProblems));
                                }

                                existing = _destinationDatabase.ExpectTable(tblName);
                                implementor = triggerFactory.Create(existing);
                                triggerPresent = false;
                            }
                        }
                    }

                    if (!triggerPresent)
                    {
                        implementor.CreateTrigger(ThrowImmediatelyCheckNotifier.Quiet);
                    }

                }
                else
                {
                    listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning,
                        $"A table called {tblName} already exists on server {TargetDatabaseServer}, data load might crash if it is populated and/or has an incompatible schema"));
                }
            }
            else
            {
                _tableDidNotExistAtStartOfLoad = true;
            }
        }
        catch (Exception e)
        {
            //Probably the database didn't exist or the credentials were wrong or something
            listener.OnNotify(this,
                new NotifyEventArgs(ProgressEventType.Error,
                    "Failed to inspect destination for already existing datatables", e));
        }

        _destination = new DataTableUploadDestination(((IExtractDatasetCommand)_request).ExtractableCohort.ExternalCohortTable);

        PrimeDestinationTypesBasedOnCatalogueTypes(listener, toProcess);

        _destination.AllowResizingColumnsAtUploadTime = true;
        _destination.AlterTimeout = AlterTimeout;
        _destination.WriteDataBeforeApplyingPrimaryKeys = WriteDataBeforeApplyingPrimaryKeys;
        _destination.AppendDataIfTableExists = AppendDataIfTableExists;
        _destination.IncludeTimeStamp = IncludeTimeStamp;
        _destination.UseTrigger = AppendDataIfTableExists;
        _destination.IndexTables = IndexTables;
        _destination.UseTrigger = UseArchiveTrigger;
        _destination.IndexTableName = GetIndexName();
        if (UserDefinedIndex is not null)
            _destination.UserDefinedIndexes = UserDefinedIndex.Split(',').Select(i => i.Trim()).ToList();
        _destination.PreInitialize(_activator, _destinationDatabase, listener);


        return _destination;
    }

    private void PrimeDestinationTypesBasedOnCatalogueTypes(IDataLoadEventListener listener, DataTable toProcess)
    {
        //if the extraction is of a Catalogue

        if (_request is not IExtractDatasetCommand datasetCommand)
            return;

        //for every extractable column in the Catalogue
        foreach (var extractionInformation in datasetCommand.ColumnsToExtract.OfType<ExtractableColumn>()
                     .Select(ec =>
                         ec.CatalogueExtractionInformation))
        {
            if (extractionInformation == null)
                continue;

            var catItem = extractionInformation.CatalogueItem;

            //if we do not know the data type or the ei is a transform
            if (catItem == null)
            {
                listener.OnNotify(this,
                    new NotifyEventArgs(ProgressEventType.Warning,
                        $"Did not copy Types for ExtractionInformation {extractionInformation} (ID={extractionInformation.ID}) because it had no associated CatalogueItem"));
                continue;
            }

            if (catItem.ColumnInfo == null)
            {
                listener.OnNotify(this,
                    new NotifyEventArgs(ProgressEventType.Warning,
                        $"Did not copy Types for ExtractionInformation {extractionInformation} (ID={extractionInformation.ID}) because it had no associated ColumnInfo"));
                continue;
            }

            if (extractionInformation.IsProperTransform())
            {
                listener.OnNotify(this,
                    new NotifyEventArgs(ProgressEventType.Warning,
                        $"Did not copy Types for ExtractionInformation {extractionInformation} (ID={extractionInformation.ID}) because it is a Transform"));
                continue;
            }

            var destinationType = GetDestinationDatabaseType(extractionInformation);

            //Tell the destination the datatype of the ColumnInfo that underlies the ExtractionInformation (this might be changed by the ExtractionInformation e.g. as a
            //transform but it is a good starting point.  We don't want to create a varchar(10) column in the destination if the origin dataset (Catalogue) is a varchar(100)
            //since it will just confuse the user.  Bear in mind these data types can be degraded later by the destination
            var columnName = extractionInformation.Alias ?? catItem.ColumnInfo.GetRuntimeName();
            var addedType = _destination.AddExplicitWriteType(columnName, destinationType);
            addedType.IsPrimaryKey = toProcess.PrimaryKey.Any(dc => dc.ColumnName == columnName);

            //if user wants to copy collation types and the destination server is the same type as the origin server
            if (CopyCollations && _destinationDatabase.Server.DatabaseType == catItem.ColumnInfo.TableInfo.DatabaseType)
                addedType.Collation = catItem.ColumnInfo.Collation;

            listener.OnNotify(this,
                new NotifyEventArgs(ProgressEventType.Information,
                    $"Set Type for {columnName} to {destinationType} (IsPrimaryKey={(addedType.IsPrimaryKey ? "true" : "false")}) to match the source table"));
        }


        foreach (var sub in datasetCommand.QueryBuilder.SelectColumns.Select(static sc => sc.IColumn)
                     .OfType<ReleaseIdentifierSubstitution>())
        {
            var columnName = sub.GetRuntimeName();
            var isPk = toProcess.PrimaryKey.Any(dc => dc.ColumnName == columnName);

            var addedType = _destination.AddExplicitWriteType(columnName,
                datasetCommand.ExtractableCohort.GetReleaseIdentifierDataType());
            addedType.IsPrimaryKey = isPk;
            addedType.AllowNulls = !isPk;
        }
    }

    private string GetDestinationDatabaseType(ConcreteColumn col)
    {
        //Make sure we know if we are going between database types
        var fromDbType = _destinationDatabase.Server.DatabaseType;
        var toDbType = col.ColumnInfo.TableInfo.DatabaseType;
        if (fromDbType != toDbType)
        {
            var fromSyntax = col.ColumnInfo.GetQuerySyntaxHelper();
            var toSyntax = _destinationDatabase.Server.GetQuerySyntaxHelper();

            var intermediate = fromSyntax.TypeTranslater.GetDataTypeRequestForSQLDBType(col.ColumnInfo.Data_type);
            return toSyntax.TypeTranslater.GetSQLDBTypeForCSharpType(intermediate);
        }

        return col.ColumnInfo.Data_type;
    }

    private string GetIndexName()
    {
        string indexName = IndexNamingPattern;
        var project = _request.Configuration.Project;
        indexName = indexName.Replace("$p", project.Name);
        indexName = indexName.Replace("$n", project.ProjectNumber.ToString());
        indexName = indexName.Replace("$c", _request.Configuration.Name);
        indexName = indexName.Replace("$e", _request.Configuration.ID.ToString());
        if (_request is ExtractDatasetCommand extractDatasetCommand)
        {
            indexName = indexName.Replace("$d", extractDatasetCommand.DatasetBundle.DataSet.Catalogue.Name);
            indexName = indexName.Replace("$a", extractDatasetCommand.DatasetBundle.DataSet.Catalogue.Acronym);
        }

        if (_request is ExtractGlobalsCommand)
        {
            indexName = indexName.Replace("$d", ExtractionDirectory.GLOBALS_DATA_NAME);
            indexName = indexName.Replace("$a", "G");
        }


        return indexName.Replace(" ", "");
    }

    private string GetTableName(string suffix = null)
    {
        string tblName;
        if (_isTableAlreadyNamed)
        {
            tblName = SanitizeNameForDatabase(_toProcess.TableName);

            if (!string.IsNullOrWhiteSpace(suffix))
                tblName += $"_{suffix}";

            return tblName;
        }

        tblName = TableNamingPattern;
        var project = _request.Configuration.Project;

        tblName = tblName.Replace("$p", project.Name);
        tblName = tblName.Replace("$n", project.ProjectNumber.ToString());
        tblName = tblName.Replace("$c", _request.Configuration.Name);
        tblName = tblName.Replace("$e", _request.Configuration.ID.ToString());

        if (_request is ExtractDatasetCommand extractDatasetCommand)
        {
            tblName = tblName.Replace("$d", extractDatasetCommand.DatasetBundle.DataSet.Catalogue.Name);
            tblName = tblName.Replace("$a", extractDatasetCommand.DatasetBundle.DataSet.Catalogue.Acronym);
        }

        if (_request is ExtractGlobalsCommand)
        {
            tblName = tblName.Replace("$d", ExtractionDirectory.GLOBALS_DATA_NAME);
            tblName = tblName.Replace("$a", "G");
        }

        var cachedGetTableNameAnswer = SanitizeNameForDatabase(tblName);
        if (!string.IsNullOrWhiteSpace(suffix))
            cachedGetTableNameAnswer += $"_{suffix}";

        return cachedGetTableNameAnswer;
    }

    private string SanitizeNameForDatabase(string tblName)
    {
        if (_destinationDatabase == null)
            throw new Exception(
                "Cannot pick a TableName until we know what type of server it is going to, _server is null");

        //get rid of brackets and dots
        tblName = Regex.Replace(tblName, "[.()]", "_");

        var syntax = _destinationDatabase.Server.GetQuerySyntaxHelper();
        syntax.ValidateTableName(tblName);

        //otherwise, fetch and cache answer
        var cachedGetTableNameAnswer = syntax.GetSensibleEntityNameFromString(tblName);

        return string.IsNullOrWhiteSpace(cachedGetTableNameAnswer)
            ? throw new Exception(
                $"TableNamingPattern '{TableNamingPattern}' resulted in an empty string for request '{_request}'")
            : cachedGetTableNameAnswer;
    }

    public override void Dispose(IDataLoadEventListener listener, Exception pipelineFailureExceptionIfAny)
    {
        if (_destination != null)
        {
            _destination.Dispose(listener, pipelineFailureExceptionIfAny);

            //if the extraction failed, the table didn't exist in the destination (i.e. the table was created during the extraction) and we are to DropTableIfLoadFails
            if (pipelineFailureExceptionIfAny != null && _tableDidNotExistAtStartOfLoad && DropTableIfLoadFails)
                if (_destinationDatabase != null)
                {
                    var tbl = _destinationDatabase.ExpectTable(_toProcess.TableName);

                    if (tbl.Exists())
                    {
                        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning,
                            $"DropTableIfLoadFails is true so about to drop table {tbl}"));
                        tbl.Drop();
                        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning, $"Dropped table {tbl}"));
                    }
                }

            if (pipelineFailureExceptionIfAny == null
                && _request.IsBatchResume
                && MakeFinalTableDistinctWhenBatchResuming
                && _destinationDatabase != null
                && _toProcess != null)
            {
                var tbl = _destinationDatabase.ExpectTable(_toProcess.TableName);
                if (tbl.Exists())
                    // if there is no primary key then failed batches may have introduced duplication
                    if (!tbl.DiscoverColumns().Any(p => p.IsPrimaryKey))
                    {
                        listener.OnNotify(this,
                            new NotifyEventArgs(ProgressEventType.Information,
                                $"Making {tbl} distinct in case there are duplicate rows from bad batch resumes"));
                        tbl.MakeDistinct(50000000);
                        listener.OnNotify(this,
                            new NotifyEventArgs(ProgressEventType.Information, $"Finished distincting {tbl}"));
                    }
            }
        }

        TableLoadInfo?.CloseAndArchive();

        // also close off the cumulative extraction result
        if (_request is ExtractDatasetCommand)
        {
            var result = ((IExtractDatasetCommand)_request).CumulativeExtractionResults;
            if (result != null && _toProcess != null)
                result.CompleteAudit(GetType(), GetDestinationDescription(), TableLoadInfo.Inserts,
                    _request.IsBatchResume, pipelineFailureExceptionIfAny != null);
        }
    }

    public override void Abort(IDataLoadEventListener listener)
    {
        _destination?.Abort(listener);
    }

    protected override void PreInitializeImpl(IBasicActivateItems activator, IExtractCommand value, IDataLoadEventListener listener)
    {
        _activator = activator;
    }


    public override string GetDestinationDescription() => GetDestinationDescription("");

    private string GetDestinationDescription(string suffix = "")
    {
        if (_toProcess == null)
            return _request is ExtractGlobalsCommand
                ? "Globals"
                : throw new Exception("Could not describe destination because _toProcess was null");

        var tblName = _toProcess.TableName;
        var dbName = GetDatabaseName();
        return $"{TargetDatabaseServer.ID}|{dbName}|{tblName}";
    }

    public static DestinationType GetDestinationType() => DestinationType.Database;

    public override ReleasePotential GetReleasePotential(IRDMPPlatformRepositoryServiceLocator repositoryLocator,
        ISelectedDataSets selectedDataSet) => new MsSqlExtractionReleasePotential(repositoryLocator, selectedDataSet);

    public override FixedReleaseSource<ReleaseAudit> GetReleaseSource(ICatalogueRepository catalogueRepository) =>
        new MsSqlReleaseSource(catalogueRepository);

    public override GlobalReleasePotential GetGlobalReleasabilityEvaluator(
        IRDMPPlatformRepositoryServiceLocator repositoryLocator, ISupplementalExtractionResults globalResult,
        IMapsDirectlyToDatabaseTable globalToCheck) =>
        new MsSqlGlobalsReleasePotential(repositoryLocator, globalResult, globalToCheck);

    protected override void TryExtractSupportingSQLTableImpl(SupportingSQLTable sqlTable, DirectoryInfo directory,
        IExtractionConfiguration configuration, IDataLoadEventListener listener, out int linesWritten,
        out string destinationDescription)
    {
        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,
            $"About to download SQL for global SupportingSQL {sqlTable.SQL}"));
        using var con = sqlTable.GetServer().GetConnection();
        con.Open();

        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,
            $"Connection opened successfully, about to send SQL command {sqlTable.SQL}"));

        using var dt = new DataTable();
        using (var cmd = DatabaseCommandHelper.GetCommand(sqlTable.SQL, con))
        using (var da = DatabaseCommandHelper.GetDataAdapter(cmd))
        {
            var sw = Stopwatch.StartNew();
            dt.BeginLoadData();
            da.Fill(dt);
            dt.EndLoadData();
        }

        dt.TableName = GetTableName(_destinationDatabase.Server.GetQuerySyntaxHelper()
            .GetSensibleEntityNameFromString(sqlTable.Name));
        linesWritten = dt.Rows.Count;

        var destinationDb = GetDestinationDatabase(listener);
        var tbl = destinationDb.ExpectTable(dt.TableName);

        if (tbl.Exists())
            tbl.Drop();

        destinationDb.CreateTable(dt.TableName, dt);
        destinationDescription = $"{TargetDatabaseServer.ID}|{GetDatabaseName()}|{dt.TableName}";
    }


    protected override void TryExtractLookupTableImpl(BundledLookupTable lookup, DirectoryInfo lookupDir,
        IExtractionConfiguration requestConfiguration, IDataLoadEventListener listener, out int linesWritten,
        out string destinationDescription)
    {
        using var dt = lookup.GetDataTable();

        dt.TableName = GetTableName(_destinationDatabase.Server.GetQuerySyntaxHelper()
            .GetSensibleEntityNameFromString(lookup.TableInfo.Name));

        //describe the destination for the abstract base
        destinationDescription = $"{TargetDatabaseServer.ID}|{GetDatabaseName()}|{dt.TableName}";
        linesWritten = dt.Rows.Count;

        var destinationDb = GetDestinationDatabase(listener);
        var existing = destinationDb.ExpectTable(dt.TableName);

        if (existing.Exists())
        {
            listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Warning,
                $"Dropping existing Lookup table '{existing.GetFullyQualifiedName()}'"));
            existing.Drop();
        }

        destinationDb.CreateTable(dt.TableName, dt);
    }

    private DiscoveredDatabase GetDestinationDatabase(IDataLoadEventListener listener)
    {
        //tell user we are about to inspect it
        listener.OnNotify(this, new NotifyEventArgs(ProgressEventType.Information,
            $"About to open connection to {TargetDatabaseServer}"));

        var databaseName = GetDatabaseName();

        var discoveredServer = DataAccessPortal.ExpectServer(TargetDatabaseServer, DataAccessContext.DataExport, false);

        var db = discoveredServer.ExpectDatabase(databaseName);
        if (!db.Exists())
            db.Create();

        return db;
    }

    private string GetDatabaseName()
    {
        var dbName = DatabaseNamingPattern;

        if (_project.ProjectNumber == null)
            throw new ProjectNumberException($"Project '{_project}' must have a ProjectNumber");

        if (_request == null)
            throw new Exception("No IExtractCommand Request was passed to this component");

        if (_request.Configuration == null)
            throw new Exception($"Request did not specify any Configuration for Project '{_project}'");

        dbName = dbName.Replace("$p", _project.Name)
            .Replace("$n", _project.ProjectNumber.ToString())
            .Replace("$t", _project.MasterTicket)
            .Replace("$r", _request.Configuration.RequestTicket)
            .Replace("$l", _request.Configuration.ReleaseTicket)
            .Replace("$e", _request.Configuration.ID.ToString());
        return dbName;
    }

    public override void Check(ICheckNotifier notifier)
    {
        if (TargetDatabaseServer == null)
        {
            notifier.OnCheckPerformed(new CheckEventArgs(
                "Target database server property has not been set (This component does not know where to extract data to!), " +
                "to fix this you must edit the pipeline and choose an ExternalDatabaseServer to extract to)",
                CheckResult.Fail));
            return;
        }

        if (string.IsNullOrWhiteSpace(TargetDatabaseServer.Server))
        {
            notifier.OnCheckPerformed(new CheckEventArgs("TargetDatabaseServer does not have a .Server specified",
                CheckResult.Fail));
            return;
        }

        if (!string.IsNullOrWhiteSpace(TargetDatabaseServer.Database))
            notifier.OnCheckPerformed(new CheckEventArgs(
                "TargetDatabaseServer has .Database specified but this will be ignored!", CheckResult.Warning));

        if (string.IsNullOrWhiteSpace(TableNamingPattern))
        {
            notifier.OnCheckPerformed(new CheckEventArgs(
                "You must specify TableNamingPattern, this will tell the component how to name tables it generates in the remote destination",
                CheckResult.Fail));
            return;
        }

        if (string.IsNullOrWhiteSpace(DatabaseNamingPattern))
        {
            notifier.OnCheckPerformed(new CheckEventArgs(
                "You must specify DatabaseNamingPattern, this will tell the component what database to create or use in the remote destination",
                CheckResult.Fail));
            return;
        }

        if (!DatabaseNamingPattern.Contains("$p") && !DatabaseNamingPattern.Contains("$n") &&
            !DatabaseNamingPattern.Contains("$t") && !DatabaseNamingPattern.Contains("$r") &&
            !DatabaseNamingPattern.Contains("$l"))
            notifier.OnCheckPerformed(new CheckEventArgs(
                "DatabaseNamingPattern does not contain any token. The tables may be created alongside existing tables and Release would be impossible.",
                CheckResult.Warning));

        if (!TableNamingPattern.Contains("$d") && !TableNamingPattern.Contains("$a"))
            notifier.OnCheckPerformed(new CheckEventArgs(
                "TableNamingPattern must contain either $d or $a, the name/acronym of the dataset being extracted otherwise you will get collisions when you extract multiple tables at once",
                CheckResult.Warning));

        if (_request == ExtractDatasetCommand.EmptyCommand)
        {
            notifier.OnCheckPerformed(new CheckEventArgs(
                "Request is ExtractDatasetCommand.EmptyCommand, will not try to connect to Database",
                CheckResult.Warning));
            return;
        }

        if (TableNamingPattern != null && TableNamingPattern.Contains("$a"))
            if (_request is ExtractDatasetCommand dsRequest && string.IsNullOrWhiteSpace(dsRequest.Catalogue.Acronym))
                notifier.OnCheckPerformed(new CheckEventArgs(
                    $"Catalogue '{dsRequest.Catalogue}' does not have an Acronym but TableNamingPattern contains $a",
                    CheckResult.Fail));



        base.Check(notifier);

        try
        {
            var server = DataAccessPortal.ExpectServer(TargetDatabaseServer, DataAccessContext.DataExport, false);
            var database = _destinationDatabase = server.ExpectDatabase(GetDatabaseName());

            if (UseArchiveTrigger)
            {
                if (_request is ExtractDatasetCommand dsRequest)
                {
                    var existing = _destinationDatabase.ExpectTable(dsRequest.Catalogue.Name);
                    if (existing.Exists())
                    {
                        var hasPKs = existing.DiscoverColumns().Any(col => col.IsPrimaryKey);
                        if (!hasPKs)
                        {
                            notifier.OnCheckPerformed(new CheckEventArgs(
                               $"Catalogue does not have any PKS. Cannot apply the archive trigger",
                               CheckResult.Fail));
                        }
                    }
                }
            }

            if (database.Exists())
            {
                notifier.OnCheckPerformed(
                    new CheckEventArgs(
                        $"Database {database} already exists! if an extraction has already been run you may have errors if you are re-extracting the same tables",
                        CheckResult.Warning));
            }
            else
            {
                notifier.OnCheckPerformed(
                    new CheckEventArgs(
                        $"Database {database} does not exist on server... it will be created at runtime",
                        CheckResult.Success));
                return;
            }

            var tables = database.DiscoverTables(false);

            if (tables.Any())
            {
                string tableName;

                try
                {
                    tableName = GetTableName();
                }
                catch (Exception ex)
                {
                    notifier.OnCheckPerformed(
                        new CheckEventArgs("Could not determine table name", CheckResult.Fail, ex));
                    return;
                }

                // if the expected table exists and we are not doing a batch resume or allowing data appending
                if (tables.Any(t => t.GetRuntimeName().Equals(tableName)) && !_request.IsBatchResume && !AppendDataIfTableExists)
                    notifier.OnCheckPerformed(new CheckEventArgs(ErrorCodes.ExistingExtractionTableInDatabase,
                        tableName, database));
            }
            else
            {
                notifier.OnCheckPerformed(new CheckEventArgs($"Confirmed that database {database} is empty of tables",
                    CheckResult.Success));
            }
        }
        catch (Exception e)
        {
            notifier.OnCheckPerformed(new CheckEventArgs(
                $"Could not connect to TargetDatabaseServer '{TargetDatabaseServer}'", CheckResult.Fail, e));
        }
    }
}

HicServices / RDMP / 27198235588

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous