Settings XML File

Introduction

SQL Enlight Setting XML file can be used with the command line tool and build tasks to override some of the settings that are not available as parameters to the tool or task.

Settings File Structure

The settings XML file contains four sections under the main ApplicationSettings element, but in the scope of the command line tool and build tasks usage, only the AnalysisSettings are relevant.

  <ApplicationSettings>
    <AnalysisSettings>...</AnalysisSettings>
    ...
  </ApplicationSettings/>

AnalysisSettings

  <ApplicationSettings>
    <AnalysisSettings>
      <!-- Configurations that have significance for the command line tool or build tasks analsyis -->
      <DisableConnectionContext>false</DisableConnectionContext>
      <LoadFullContext>false</LoadFullContext>
      <DisableScriptValidationOnServer>true</DisableScriptValidationOnServer>
      <!--
        0:- ParseOnly = 0, 1: Noexec
      -->
      <OnServerScriptValidationType>0</OnServerScriptValidationType>
      <TemplateFile>C:\Users\Username\AppData\Roaming\Ubitsoft\SQL Enlight\1.9\Templates\Analysis\AnalysisTemplate.xml</TemplateFile>
      <ShowAnalysisRuleDisabledErrorOnNoSqlConnection>false</ShowAnalysisRuleDisabledErrorOnNoSqlConnection>
      <DisableSyntaxErrorsInAnalysisResults>false</DisableSyntaxErrorsInAnalysisResults>


      <!-- The following settings have no effect in command line tool or build tasks analsyis -->
      <DisableConnectionContextCaching>false</DisableConnectionContextCaching>
      <DefaultAnalysisConnectionString>Data Source=TESTSQL\SQL2014;Initial Catalog=AdventureWorks;Integrated Security=True</DefaultAnalysisConnectionString>
      <EnableInstantCodeAnalysis>true</EnableInstantCodeAnalysis>
      <InstantCodeAnalysisScriptMaxSize>5120</InstantCodeAnalysisScriptMaxSize>
      <RequireConfirmStandardRulesUpgrade>true</RequireConfirmStandardRulesUpgrade>
      <PendingVersionTemplateUpgrade>false</PendingVersionTemplateUpgrade>
      <ShowToolbarInVisualStudioAndSsms>true</ShowToolbarInVisualStudioAndSsms>
      <DisableDiskCache>false</DisableDiskCache>
      <CachePath>C:\Users\Username\AppData\Roaming\Yubitsoft\SQL Enlight\2.0\Cache</CachePath>
    </AnalysisSettings>
  </ApplicationSettings/>

SQL Enlight Settings file

The settings file of the current user can be found at this path:

%APPDATA%\Yubitsoft\SQL Enlight\2.0\settings.xmlIt can be used a source for crating a custom settings XML file, which to be used with the command line tool or build tasks.