SchemaSmith Documentation

AppSettings - SQL Server (Community)

Configure defaults, paths, and connections via appsettings.json for repeatable runs.

Development Cycle

Overview

appsettings.json centralizes runtime configuration for SchemaQuench on SQL Server Community. For the shared configuration loading order (file, environment variables, CLI switches) and the SmithySettings_ environment variable prefix, see Configuration Loading and Environment Variables.

Community Edition exposes a focused set of configuration options. For the full Enterprise settings (threading, patching controls, checkpointing), see the SQL Server Enterprise AppSettings page.

Properties

Setting Value
SchemaPackagePathThe path to the root of the product repository/package. SchemaQuench requires the repository to be placed in a location where the files can be loaded by the executable. The location will contain the Product.json and the folders for templates and other files. This can be a folder or a zip file containing the package contents.
Target:ServerThe server to connect to.
Target:UserThe sql user to authenticate as. Leave blank for windows authentication.
Target:PasswordThe sql user password. Leave blank for windows authentication.
WhatIfONLYDefaults to false. When true a what if run is done that shows the changes that are detected and what would be applied if allowed to. This run may not be accurate if there are dependencies upon other actions that have not been applied.