Skip to main content

Include Credential

Determines if the Credential statement is included in the SSDT Project.

When enabled and a Default Credential statement is configured, a DefaultCredential.sql script is written under {Database}\Security\Credentials in the generated project, for each database that contains external table objects. An existing script file is only overwritten when Overwrite External Table Defaults is enabled, so a credential statement updated with real secrets is preserved across builds.

When to Change This Setting​

Keep the default N when database scoped credentials are managed outside the SSDT project. Enable it for external-table (PolyBase-style) staging solutions where the deployment should create the credential used by the external data source.

SettingInteraction
Default CredentialThe SQL statement written to the included script
Include Master KeyThe master key the credential depends on
Include External Data SourceThe external data source that authenticates with the credential
Overwrite External Table DefaultsControls whether an existing script is overwritten

Notes​

  • This setting is part of the SSDT settings category.
  • The default value for this setting is N.