Share via


SqlScriptGeneratorOptions Class

Definition

Controls the options for Sql Script Generation

public class SqlScriptGeneratorOptions
type SqlScriptGeneratorOptions = class
Public Class SqlScriptGeneratorOptions
Inheritance
SqlScriptGeneratorOptions

Constructors

SqlScriptGeneratorOptions()

Properties

AlignClauseBodies

Gets or sets a boolean indicating if the bodies of FROM, WHERE, GROUP BY, etc. clauses should be aligned

AlignColumnDefinitionFields

Gets or sets a boolean indicating if column definition fields (column name, data type, constraints) should be aligned into alignment columns.

AlignSetClauseItem

Gets or sets a boolean indicating if SET clause items in an UPDATE statement should be aligned

AllowExternalLanguagePaths

Gets or sets a boolean indicating if file paths can be used for external language content

AllowExternalLibraryPaths

Gets or sets a boolean indicating if file paths can be used for external library content

AsKeywordOnOwnLine

Gets or sets a boolean indicating if the AS keyword should be written on its own line

IncludeSemicolons

Gets or sets a boolean indicating if a semi colon should be included after each statement

IndentationSize

Gets or sets the number of spaces to use when indenting text

IndentSetClause

Gets or sets a boolean indicating if the SET clause for an UPDATE statement should be indented

IndentViewBody

Gets or sets a boolean indicating if the view statement body should be indented.

KeywordCasing

Gets or sets the keyword casing option to use during script generation

MultilineInsertSourcesList

Gets or sets a boolean indicating if the INSERT column sources list should be spread across multiple lines

MultilineInsertTargetsList

Gets or sets a boolean indicating if the INSERT column targets list should be spread across multiple lines

MultilineSelectElementsList

Gets or sets a boolean indicating if select elements should be listed as a multi-line list

MultilineSetClauseItems

Gets or sets a boolean indicating if SET clause items should be listed on multiple lines

MultilineViewColumnsList

Gets or sets a boolean indicating if view statement columns should be listed as a multi-line list

MultilineWherePredicatesList

Gets or sets a boolean indicating if WHERE predicates (expressions separated by AND, and OR) should be written on multiple lines

NewLineBeforeCloseParenthesisInMultilineList

Gets or sets a boolean indicating if a newline should be placed before an close parenthesis when writing a multi-line list in parenthesis

NewLineBeforeFromClause

Gets or sets a boolean indicating if there should be a newline before the FROM clause in a SELECT statement

NewLineBeforeGroupByClause

Gets or sets a boolean indicating if there should be a newline before the GROUP BY clause in a SELECT statement

NewLineBeforeHavingClause

Gets or sets a boolean indicating if there should be a newline before the HAVING clause in a SELECT statement

NewLineBeforeJoinClause

Gets or sets a boolean indicating if there should be a newline before the JOIN clause in a SELECT statement

NewLineBeforeOffsetClause

Gets or sets a boolean indicating if there should be a newline before the OFFSET clause

NewLineBeforeOpenParenthesisInMultilineList

Gets or sets a boolean indicating if a newline should be placed before an open parenthesis when writing a multi-line list in parenthesis

NewLineBeforeOrderByClause

Gets or sets a boolean indicating if there should be a newline before the ORDER BY clause in a SELECT statement

NewLineBeforeOutputClause

Gets or sets a boolean indicating if there should be a newline before the OUTPUT clause

NewLineBeforeWhereClause

Gets or sets a boolean indicating if there should be a newline before the WHERE clause in a SELECT statement

NewLineBeforeWindowClause

Gets or sets a boolean indicating if there should be a newline before the WINDOW clause in a SELECT statement

SqlEngineType

Gets or sets the Sql engine type (All|Engine|Azure) to generate script for

SqlVersion

Gets or sets the Sql version to generate script for

Methods

Reset()

Resets the options to their default value.

Applies to