tbf/TBF/Rig/Output/DataStorage/UniDataStorageWriter/Interfaces/DataWriteRequest.cs

using System.Collections.Generic;

namespace TBF.Rig.Output.DataStorage.UniDataStorageWriter.Interfaces
{
    /// <summary>
    /// Request for write operation.
    /// Contains batch of write items.
    /// </summary>
    public class DataWriteRequest
    {
        public DataWriteRequest()
        {
            InsertItems = new List<InsertWriteItem>();
            UpdateItems = new List<UpdateWriteItem>();
            StoredProcedureParameters = new List<StoredProcedureWriteParameter>();
            Payload = string.Empty;
            OutputFileName = string.Empty;
            Mode = WriteMode.Insert;
        }

        public WriteMode Mode { get; set; }

        public List<InsertWriteItem> InsertItems { get; private set; }

        public List<UpdateWriteItem> UpdateItems { get; private set; }

        /// <summary>
        /// Parameters passed to a stored procedure when Mode is StoredProcedure.
        /// The stored procedure name itself is resolved from WriterCfg.WriteTemplates.
        /// </summary>
        public List<StoredProcedureWriteParameter> StoredProcedureParameters { get; private set; }

        /// <summary>
        /// Optional complete payload generated by a higher-level component.
        /// </summary>
        /// <remarks>
        /// File-oriented payload writers use this field when the complete
        /// serialized document is already available and must be written without
        /// converting it back to individual column/value pairs.
        /// </remarks>
        public string Payload { get; set; }

        /// <summary>
        /// Optional output file name suggested by the caller.
        /// </summary>
        /// <remarks>
        /// The physical output directory is still defined by
        /// <see cref="WriterCfg.DataSource"/>. Writers may generate a safe default
        /// file name when this value is empty.
        /// </remarks>
        public string OutputFileName { get; set; }
    }

    public enum WriteMode
    {
        Insert,
        Update,
        Upsert,
        Append,
        StoredProcedure
    }

    /// <summary>
    /// Generic parameter types supported by the Microsoft SQL stored procedure writer.
    /// </summary>
    public enum StoredProcedureParameterType
    {
        String,
        Xml,
        Int32,
        Int64,
        Decimal,
        Boolean,
        DateTime
    }

    public class InsertWriteItem
    {
        public string ColumnName { get; set; }
        public string Value { get; set; }

        public override string ToString()
        {
            return $"{ColumnName} = {Value}";
        }
    }

    public class UpdateWriteItem
    {
        public string WhereParameterName { get; set; }
        public string WhereValue { get; set; }

        public string SetParameterName { get; set; }
        public string SetValue { get; set; }

        public override string ToString()
        {
            return $"WHERE {WhereParameterName} = {WhereValue} -> SET {SetParameterName} = {SetValue}";
        }
    }

    /// <summary>
    /// One parameter passed to a stored procedure.
    /// Value is object so the writer can preserve the requested SQL data type.
    /// </summary>
    public class StoredProcedureWriteParameter
    {
        public string ParameterName { get; set; }
        public object Value { get; set; }
        public StoredProcedureParameterType ParameterType { get; set; }

        public StoredProcedureWriteParameter()
        {
            ParameterType = StoredProcedureParameterType.String;
        }

        public override string ToString()
        {
            return $"{ParameterName} ({ParameterType}) = {Value}";
        }
    }
}