sqltoolsservice/src/Microsoft.SqlTools.ServiceLayer/Scripting/Contracts/ScriptingOptions.cs

//
// Copyright (c) Microsoft. All rights reserved.
// Licensed under the MIT license. See LICENSE file in the project root for full license information.
//

namespace Microsoft.SqlTools.ServiceLayer.Scripting.Contracts
{
    /// <summary>
    /// Defines the scripting options.
    /// </summary>
    public class ScriptOptions
    {
        /// <summary>
        /// Generate ANSI padding statements
        /// </summary>
        public virtual bool? ScriptAnsiPadding { get; set; } = false;

        /// <summary>
        /// Append the generated script to a file
        /// </summary>
        public virtual bool? AppendToFile { get; set; } = false;

        /// <summary>
        /// Continue to script if an error occurs. Otherwise, stop.
        /// </summary>
        /// <remarks>
        /// The default is true.
        /// </remarks>
        public virtual bool? ContinueScriptingOnError { get; set; } = true;

        /// <summary>
        /// Convert user-defined data types to base types.
        /// </summary>
        public virtual bool? ConvertUDDTToBaseType { get; set; } = false;

        /// <summary>
        /// Generate script for dependent objects for each object scripted.
        /// </summary>
        /// <remarks>
        /// The default is false.
        /// </remarks>
        public virtual bool? GenerateScriptForDependentObjects { get; set; } = false;

        /// <summary>
        /// Include descriptive headers for each object generated.
        /// </summary>
        /// <remarks>
        /// The default is true.
        /// </remarks>
        public virtual bool? IncludeDescriptiveHeaders { get; set; } = true;

        /// <summary>
        /// Check that an object with the given name exists before dropping or altering or that an object with the given name does not exist before creating.
        /// </summary>
        public virtual bool? IncludeIfNotExists { get; set; } = false;

        /// <summary>
        /// Script options to set vardecimal storage format.
        /// </summary>
        public virtual bool? IncludeVarDecimal { get; set; } = true;

        /// <summary>
        /// Include system generated constraint names to enforce declarative referential integrity.
        /// </summary>
        public virtual bool? ScriptDriIncludeSystemNames { get; set; } = false;

        /// <summary>
        /// Include statements in the script that are not supported on the specified SQL Server database engine type.
        /// </summary>
        public virtual bool? IncludeUnsupportedStatements { get; set; } = true;

        /// <summary>
        /// Prefix object names with the object schema.
        /// </summary>
        /// <remarks>
        /// The default is true.
        /// </remarks>
        public virtual bool? SchemaQualify { get; set; } = true;

        /// <summary>
        /// Script options to set bindings option.
        /// </summary>
        public virtual bool? Bindings { get; set; } = false;

        /// <summary>
        /// Script the objects that use collation.
        /// </summary>
        public virtual bool? Collation { get; set; } = false;

        /// <summary>
        /// Script the default values.
        /// </summary>
        /// <remarks>
        /// The default is true.
        /// </remarks>
        public virtual bool? Default { get; set; } = true;

        /// <summary>
        /// Script Object CREATE/DROP statements.  
        /// Possible values: 
        ///   ScriptCreate
        ///   ScriptDrop
        ///   ScriptCreateDrop
        /// </summary>
        /// <remarks>
        /// The default is ScriptCreate.
        /// </remarks>
        public virtual string ScriptCreateDrop { get; set; } = "ScriptCreate";

        /// <summary>
        /// Script the Extended Properties for each object scripted.
        /// </summary>
        /// <remarks>
        /// The default is true.
        /// </remarks>
        public virtual bool? ScriptExtendedProperties { get; set; } = true;

        /// <summary>
        /// Script only features compatible with the specified version of SQL Server.  Possible values:
        ///   Script90Compat
        ///   Script100Compat
        ///   Script105Compat
        ///   Script110Compat
        ///   Script120Compat
        ///   Script130Compat
        ///   Script140Compat  
        ///   Script150Compat  
        /// </summary>
        /// <remarks>
        /// The default is Script140Compat.
        /// </remarks>
        public virtual string ScriptCompatibilityOption { get; set; } = "Script140Compat";

        /// <summary>
        /// Script only features compatible with the specified SQL Server database engine type.
        /// Possible Values:
        ///   SingleInstance
        ///   SqlAzure
        /// </summary>
        public virtual string TargetDatabaseEngineType { get; set; } = "SingleInstance";

        /// <summary>
        /// Script only features compatible with the specified SQL Server database engine edition.
        /// Possible Values:
        ///   SqlServerPersonalEdition
        ///   SqlServerStandardEdition 
        ///   SqlServerEnterpriseEdition 
        ///   SqlServerExpressEdition
        ///   SqlAzureDatabaseEdition
        ///   SqlDatawarehouseEdition
        ///   SqlServerStretchEdition 
        ///   SqlManagedInstanceEdition 
        /// </summary>
        public virtual string TargetDatabaseEngineEdition { get; set; } = "SqlServerEnterpriseEdition";

        /// <summary>
        /// Script all logins available on the server. Passwords will not be scripted.
        /// </summary>
        public virtual bool? ScriptLogins { get; set; } = false;

        /// <summary>
        /// Generate object-level permissions.
        /// </summary>
        public virtual bool? ScriptObjectLevelPermissions { get; set; } = false;

        /// <summary>
        /// Script owner for the objects.
        /// </summary>
        public virtual bool? ScriptOwner { get; set; } = false;

        /// <summary>
        /// Script statistics, and optionally include histograms, for each selected table or view.
        /// Possible values:
        ///   ScriptStatsNone
        ///   ScriptStatsDDL
        ///   ScriptStatsAll
        /// </summary>
        /// <remarks>
        /// The default value is ScriptStatsNone.
        /// </remarks>
        public virtual string ScriptStatistics { get; set; } = "ScriptStatsNone";

        /// <summary>
        /// Generate USE DATABASE statement.
        /// </summary>
        public virtual bool? ScriptUseDatabase { get; set; } = true;

        /// <summary>
        /// Generate script that contains schema only or schema and data.
        /// Possible Values:
        ///   SchemaAndData
        ///   DataOnly
        ///   SchemaOnly
        /// </summary>
        /// <remarks>
        /// The default value is SchemaOnly.
        /// </remarks>
        public virtual string TypeOfDataToScript { get; set; } = "SchemaOnly";

        /// <summary>
        /// Scripts the change tracking information.
        /// </summary>
        public virtual bool? ScriptChangeTracking { get; set; } = false;

        /// <summary>
        /// Script the check constraints for each table or view scripted.
        /// </summary>
        /// <remarks>
        /// The default value is true.
        /// </remarks>
        public virtual bool? ScriptCheckConstraints { get; set; } = true;

        /// <summary>
        /// Scripts the data compression information.
        /// </summary>
        public virtual bool? ScriptDataCompressionOptions { get; set; } = false;

        /// <summary>
        /// Script the foreign keys for each table scripted.
        /// </summary>
        /// <remarks>
        /// The default value is true.
        /// </remarks>
        public virtual bool? ScriptForeignKeys { get; set; } = true;

        /// <summary>
        /// Script the full-text indexes for each table or indexed view scripted.
        /// </summary>
        public virtual bool? ScriptFullTextIndexes { get; set; } = true;

        /// <summary>
        /// Script the indexes (including XML and clustered indexes) for each table or indexed view scripted.
        /// </summary>
        /// <remarks>
        /// The default value is true.
        /// </remarks>
        public virtual bool? ScriptIndexes { get; set; } = true;

        /// <summary>
        /// Script the primary keys for each table or view scripted
        /// </summary>
        /// <remarks>
        /// The default value is true.
        /// </remarks>
        public virtual bool? ScriptPrimaryKeys { get; set; } = true;

        /// <summary>
        /// Script the triggers for each table or view scripted
        /// </summary>
        public virtual bool? ScriptTriggers { get; set; } = true;

        /// <summary>
        /// Script the unique keys for each table or view scripted.
        /// </summary>
        /// <remarks>
        /// The default value is true.
        /// </remarks>
        public virtual bool? UniqueKeys { get; set; } = true;
            
    }
}