Share via


SqlScriptGeneratorOptions Class

Represents Transact-SQL script generator options.

Inheritance Hierarchy

System.Object
  Microsoft.Data.Schema.ScriptDom.Sql.SqlScriptGeneratorOptions

Namespace:  Microsoft.Data.Schema.ScriptDom.Sql
Assembly:  Microsoft.Data.Schema.ScriptDom.Sql (in Microsoft.Data.Schema.ScriptDom.Sql.dll)

Syntax

'Declaration
Public Class SqlScriptGeneratorOptions
public class SqlScriptGeneratorOptions
public ref class SqlScriptGeneratorOptions
type SqlScriptGeneratorOptions =  class end
public class SqlScriptGeneratorOptions

The SqlScriptGeneratorOptions type exposes the following members.

Constructors

  Name Description
Public method SqlScriptGeneratorOptions Initializes a new instance of the SqlScriptGeneratorOptions class.

Top

Properties

  Name Description
Public property AlignClauseBodies Gets or sets a Boolean indicating whether the bodies of clauses such as FROM, WHERE, and GROUP BY should be aligned.
Public property AlignColumnDefinitionFields Gets or sets a Boolean indicating whether column definition fields (column name, data type, constraints) should be aligned into alignment columns.
Public property AlignSetClauseItem Gets or sets a Boolean indicating whether SET clause items in an UPDATE statement should be aligned.
Public property AsKeywordOnOwnLine Gets or sets a Boolean indicating whether the AS keyword should be written on its own line.
Public property IncludeSemicolons Gets or sets a Boolean indicating whether a semicolon should be included after each statement.
Public property IndentationSize Gets or sets the number of spaces to use when indenting text.
Public property IndentSetClause Gets or sets a Boolean indicating whether the SET clause for an UPDATE statement should be indented.
Public property IndentViewBody Gets or sets a Boolean indicating whether the view statement body should be indented.
Public property KeywordCasing Gets or sets the keyword casing option to use during script generation.
Public property MultilineInsertSourcesList Gets or sets a Boolean indicating whether the INSERT column sources list should be spread across multiple lines.
Public property MultilineInsertTargetsList Gets or sets a Boolean indicating whether the INSERT column targets list should be spread across multiple lines.
Public property MultilineSelectElementsList Gets or sets a Boolean indicating whether select elements should be listed as a multiline list.
Public property MultilineSetClauseItems Gets or sets a Boolean indicating whether SET clause items should be listed on multiple lines.
Public property MultilineViewColumnsList Gets or sets a Boolean indicating whether view statement columns should be listed as a multiline list.
Public property MultilineWherePredicatesList Gets or sets a Boolean indicating whether WHERE predicates (expressions separated by AND and OR) should be written on multiple lines.
Public property NewLineBeforeCloseParenthesisInMultilineList Gets or sets a Boolean indicating whether a new line should be placed before a close parenthesis when writing a multiline list in parentheses.
Public property NewLineBeforeFromClause Gets or sets a Boolean indicating whether there should be a new line before the FROM clause in a SELECT statement.
Public property NewLineBeforeGroupByClause Gets or sets a Boolean indicating whether there should be a new line before the GROUP BY clause in a SELECT statement.
Public property NewLineBeforeHavingClause Gets or sets a Boolean indicating whether there should be a new line before the HAVING clause in a SELECT statement.
Public property NewLineBeforeJoinClause Gets or sets a Boolean indicating whether there should be a new line before the JOIN clause in a SELECT statement.
Public property NewLineBeforeOpenParenthesisInMultilineList Gets or sets a Boolean indicating whether a new line should be placed before an open parenthesis when writing a multiline list in parentheses.
Public property NewLineBeforeOrderByClause Gets or sets a Boolean indicating whether there should be a new line before the ORDER BY clause in a SELECT statement.
Public property NewLineBeforeOutputClause Gets or sets a Boolean indicating whether there should be a new line before the OUTPUT clause.
Public property NewLineBeforeWhereClause Gets or sets a Boolean indicating whether there should be a new line before the WHERE clause in a SELECT statement.
Public property SqlVersion Gets or sets the SQL version to generate a script for.

Top

Methods

  Name Description
Public method Equals Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as a hash function for a particular type. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method Reset Resets options.
Public method ToString Returns a string that represents the current object. (Inherited from Object.)

Top

Remarks

These options are not honored by the ScriptDom in Visual Studio 2010.

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.Data.Schema.ScriptDom.Sql Namespace