Класс ScriptOption

Объект ScriptOption представляет параметры создания скриптов SQL Server, которые можно включить в параметры работы со скриптами, задаваемые с помощью объекта ScriptingOptions.

Иерархия наследования

System. . :: . .Object
  Microsoft.SqlServer.Management.Smo..::..ScriptOption

Пространство имен:  Microsoft.SqlServer.Management.Smo
Сборка:  Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)

Синтаксис

'Декларация
Public NotInheritable Class ScriptOption
'Применение
Dim instance As ScriptOption

public sealed class ScriptOption

public ref class ScriptOption sealed

[<SealedAttribute>]
type ScriptOption =  class end

public final class ScriptOption

Тип ScriptOption обеспечивает доступ к следующим элементам.

Свойства

  Имя Описание
Открытое свойствоСтатический элемент AgentAlertJob Возвращает объект, показывающий, включаются ли предупреждения и задания агента SQL Server в скрипт. 
Открытое свойствоСтатический элемент AgentJobId Возвращает объект, показывающий, включаются ли предупреждения и задания агента SQL Server в скрипт. 
Открытое свойствоСтатический элемент AgentNotify Возвращает объект, который показывает, включаются ли уведомления для любых предупреждений агента SQL Server, входящих в скрипт. 
Открытое свойствоСтатический элемент AllowSystemObjects Возвращает объект, который показывает, можно ли вносить в скрипт системные объекты.
Открытое свойствоСтатический элемент AnsiFile Возвращает объект, который показывает, используются ли в скрипте многобайтовые символы и требуется ли кодовая страница 1252 для вычисления значения символов.
Открытое свойствоСтатический элемент AnsiPadding Возвращает или задает объект, который показывает, содержит ли создаваемый скрипт инструкции Transact-SQL SET ANSI-PADDING ON или SET ANSI-PADDING OFF до и после инструкции CREATE TABLE соответственно.
Открытое свойствоСтатический элемент AppendToFile Возвращает объект, который указывает, добавляется ли скрипт в конец выходного файла или перезаписывает его.
Открытое свойствоСтатический элемент Bindings Возвращает объект, который указывает, включаются ли в создаваемый скрипт инструкции привязки sp_binddefault и sp_bindrule. Это свойство относится только к созданию сценариев для таблицы Microsoft SQL Server.
Открытое свойствоСтатический элемент ChangeTracking Возвращает значение свойства ChangeTracking.
Открытое свойствоСтатический элемент ClusteredIndexes Возвращает объект, который указывает, включаются ли в создаваемый скрипт инструкции для определения кластеризованных индексов.
Открытое свойствоСтатический элемент ContinueScriptingOnError Возвращает значение объекта, которое указывает, будет ли операция со скриптами продолжаться после возникновения ошибки.
Открытое свойствоСтатический элемент ConvertUserDefinedDataTypesToBaseType Возвращает значение объекта, которое указывает, преобразуются ли определяемые пользователем типы данных в наиболее подходящие базовые типы данных SQL Server в создаваемом скрипте. 
Открытое свойствоСтатический элемент DdlBodyOnly Возвращает значение объекта, которое указывает, будет ли вноситься в скрипт только текстовое определение для объектов на языке описания данных (DDL), содержащих основной текст, таких как хранимые процедуры и триггеры.
Открытое свойствоСтатический элемент DdlHeaderOnly Возвращает значение объекта, которое указывает, будут ли вноситься в скрипт только данные заголовка для объектов на языке описания данных (DDL), содержащих основной текст, таких как хранимые процедуры и триггеры.
Открытое свойствоСтатический элемент Default Возвращает значение объекта, указывающее, включено ли создание объекта, на который ссылаются, в создаваемый скрипт.
Открытое свойствоСтатический элемент DriAll Возвращает значение объекта, которое указывает, включаются ли объекты DRI в создаваемый скрипт.
Открытое свойствоСтатический элемент DriAllConstraints Возвращает значение объекта, которое указывает, включаются ли все ограничения DRI в создаваемый скрипт.
Открытое свойствоСтатический элемент DriAllKeys Возвращает значение объекта, которое показывает, включаются ли все ключи DRI (DriForeignKey, DriPrimaryKey, DriUniqueKey) в создаваемый скрипт.
Открытое свойствоСтатический элемент DriChecks Возвращает значение объекта, указывающее, будут ли связи зависимостей на уровне столбцов, определяемые проверочными ограничениями с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriClustered Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные в кластеризованных индексах с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriDefaults Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные в значениях по умолчанию с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriForeignKeys Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные во внешних ключах с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriIncludeSystemNames Возвращает значение объекта, указывающее, будут ли создаваемые системой имена ограничений, используемые для принудительного соблюдения декларативной ссылочной целостности, включаться в скрипт.
Открытое свойствоСтатический элемент DriIndexes Возвращает значение объекта, указывающее, будут ли ограничения PRIMARY KEY с уникальным индексом для реализации декларативной ссылочной целостности включаться в создаваемый скрипт.
Открытое свойствоСтатический элемент DriNonClustered Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные в некластеризованных индексах с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriPrimaryKey Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные в первичных ключах с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriUniqueKeys Возвращает значение объекта, указывающее, будут ли связи зависимостей, определенные в уникальных ключах с включенной декларативной ссылочной целостностью, включаться в скрипт.
Открытое свойствоСтатический элемент DriWithNoCheck Возвращает значение объекта, указывающее, будут ли инструкции отсутствия проверки включаться в скрипт.
Открытое свойствоСтатический элемент EnforceScriptingOptions Возвращает значение объекта, которое указывает, применяются ли все параметры создания скриптов для текстовых базовых объектов, таких как SchemaQualify.
Открытое свойствоСтатический элемент ExtendedProperties Возвращает значение объекта, которое указывает, включаются ли расширенные свойства объектов в создаваемый скрипт.
Открытое свойствоСтатический элемент FullTextCatalogs Возвращает значение объекта, которое указывает, включаются ли полнотекстовые каталоги в создаваемый скрипт.
Открытое свойствоСтатический элемент FullTextIndexes Возвращает значение объекта, которое указывает, включаются ли полнотекстовые индексы в создаваемый скрипт.
Открытое свойствоСтатический элемент FullTextStopLists Возвращает значение объекта, которое указывает, включаются ли списки стоп-слов полнотекстового списка в создаваемый скрипт.
Открытое свойствоСтатический элемент IncludeDatabaseContext Возвращает значение объекта, которое указывает, включается ли содержимое базы данных в создаваемый скрипт.
Открытое свойствоСтатический элемент IncludeDatabaseRoleMemberships Возвращает значение свойства IncludeDatabaseRoleMemberships.
Открытое свойствоСтатический элемент IncludeFullTextCatalogRootPath Возвращает значение свойства IncludeFullTextCatalogRootPath.
Открытое свойствоСтатический элемент IncludeHeaders Возвращает объект, который указывает, задается ли для создаваемого скрипта префикс в виде заголовка, содержащего такие сведения, как дата и время создания.
Открытое свойствоСтатический элемент IncludeIfNotExists Возвращает объект, который указывает, нужно ли проверять существование объекта перед его включением в скрипт.
Открытое свойствоСтатический элемент Indexes Возвращает объект, который указывает, включаются ли индексы в создаваемый скрипт.
Открытое свойствоСтатический элемент LoginSid Возвращает или задает логическое значение свойства, указывающее, включаются ли в создаваемый скрипт идентификаторы безопасности для каких-либо имен входа.
Открытое свойствоСтатический элемент NoAssemblies Возвращает объект, который указывает, исключаются ли сборки из создаваемого скрипта.
Открытое свойствоСтатический элемент NoCollation Возвращает значение объекта, которое показывает, включается ли коллекция в создаваемый скрипт, если на сервере работает SQL Server 7.0 или более поздней версии.
Открытое свойствоСтатический элемент NoCommandTerminator Возвращает значение объекта, которое указывает, разделяются ли отдельные инструкции Transact-SQL в создаваемом скрипте.
Открытое свойствоСтатический элемент NoExecuteAs Возвращает значение объекта, которое указывает, включаются ли в скрипт параметры EXECUTE AS для хранимых процедур и определяемых пользователем функций.
Открытое свойствоСтатический элемент NoFileGroup Возвращает значение объекта, которое показывает, включается ли в создаваемый скрипт предложение «ON <файловая_группа>».
Открытое свойствоСтатический элемент NoFileStream Возвращает объект, показывающий, включается ли предложение FILESTREAM_ON в создаваемый скрипт при создании столбцов VarBinaryMax.
Открытое свойствоСтатический элемент NoFileStreamColumn Возвращает объект, показывающий, включается ли предложение FILESTREAM_ON в создаваемый скрипт при создании столбцов VarBinaryMax.
Открытое свойствоСтатический элемент NoIdentities Возвращает значение объекта, которое показывает, включаются ли в создаваемый скрипт начальное значение и шаг приращения для свойства идентификаторов.
Открытое свойствоСтатический элемент NoIndexPartitioningSchemes Возвращает значение объекта, которое указывает, включаются ли схемы секционирования для индексов в создаваемый скрипт.
Открытое свойствоСтатический элемент NoMailProfileAccounts Возвращает значение объекта, указывающее, включаются ли в создаваемый скрипт учетные записи почты, на которые ссылаются профили электронной почты.
Открытое свойствоСтатический элемент NoMailProfilePrincipals Возвращает значение объекта, указывающее, исключаются ли из создаваемого скрипта участники, на которых ссылаются профили электронной почты.
Открытое свойствоСтатический элемент NonClusteredIndexes Возвращает значение объекта, которое указывает, включаются ли некластеризованные индексы в создаваемый скрипт.
Открытое свойствоСтатический элемент NoTablePartitioningSchemes Возвращает значение объекта, которое указывает, включаются ли схемы секционирования для таблиц в создаваемый скрипт.
Открытое свойствоСтатический элемент NoVardecimal Возвращает значение свойства NoVardecimal.
Открытое свойствоСтатический элемент NoViewColumns Возвращает значение объекта, которое указывает, включаются ли указанные столбцы для представления.
Открытое свойствоСтатический элемент NoXmlNamespaces Возвращает значение объекта, которое указывает, включаются ли пространства имен XML в создаваемый скрипт.
Открытое свойствоСтатический элемент OptimizerData Возвращает значение объекта, указывающее, включаются ли в создаваемый скрипт данные оптимизатора скриптов для объектов, на которые ссылаются.
Открытое свойствоСтатический элемент Permissions Возвращает значение объекта, которое указывает, включаются ли все разрешения в создаваемый скрипт.
Открытое свойствоСтатический элемент PrimaryObject Возвращает значение объекта, указывающее, включено ли создание объекта, на который ссылаются, в создаваемый скрипт.
Открытое свойствоСтатический элемент SchemaQualify Возвращает значение объекта, указывающее, содержит ли скрипт объект без схемы.
Открытое свойствоСтатический элемент SchemaQualifyForeignKeysReferences Возвращает значение объекта, которое указывает, включаются ли в создаваемый скрипт таблицы без схемы, которые упоминаются во внешнем ключе.
Открытое свойствоСтатический элемент ScriptBatchTerminator Возвращает значение свойства ScriptBatchTerminator.
Открытое свойствоСтатический элемент ScriptData Возвращает значение свойства ScriptData.
Открытое свойствоСтатический элемент ScriptDataCompression Возвращает значение объекта, указывающее, включено ли создание объекта, на который ссылаются, в создаваемый скрипт.
Открытое свойствоСтатический элемент ScriptOwner Возвращает значение объекта, указывающее, включено ли создание объекта, на который ссылаются, в создаваемый скрипт.
Открытое свойствоСтатический элемент ScriptSchema Возвращает значение свойства ScriptSchema.
Открытое свойствоСтатический элемент Statistics Возвращает значение объекта, которое указывает, создается ли статистика для всех таблиц и представлений, включаемых в создаваемый скрипт.
Открытое свойствоСтатический элемент TimestampToBinary Возвращает значение объекта, которое указывает, преобразуются ли типы данных timestamp в типы данных binary(8) во время внесения в скрипт создания таблицы или определяемого пользователем типа данных.
Открытое свойствоСтатический элемент ToFileOnly Возвращает значение объекта, которое указывает, выводятся данные только в файл или также формируется строковый вывод.
Открытое свойствоСтатический элемент Triggers Возвращает значение объекта, которое показывает, включается ли в создаваемый скрипт определение для триггеров.
Открытое свойствоСтатический элемент WithDependencies Возвращает значение объекта, которое указывает, включаются ли все зависимые объекты в создаваемый скрипт.
Открытое свойствоСтатический элемент XmlIndexes Возвращает значение объекта, которое указывает, включаются ли XML-индексы в создаваемый скрипт.

В начало

Методы

  Имя Описание
Открытый методСтатический элемент Add Складывает два объекта ScriptOption, чтобы создать объект ScriptOptions.
Открытый методСтатический элемент BitwiseOr Объединяет два объекта ScriptingOptions с помощью битовой операции «ИЛИ».
Открытый метод Equals Возвращает логическое значение, показывающее, равны ли два объекта ScriptOptions. (Переопределяет Object. . :: . .Equals(Object).)
Защищенный метод Finalize (Производный от Object.)
Открытый метод GetHashCode Возвращает хэш-код для этого объекта. (Переопределяет Object. . :: . .GetHashCode() () () ().)
Открытый метод GetType (Производный от Object.)
Защищенный метод MemberwiseClone (Производный от Object.)
Открытый метод ToString Возвращает строку, представляющую текущий объект. (Переопределяет Object. . :: . .ToString() () () ().)

В начало

Операторы

  Имя Описание
Открытый операторСтатический элемент Addition Создает набор параметров создания скриптов путем выполнения операции сложения с двумя объектами ScriptOption.
Открытый операторСтатический элемент BitwiseOr Создает набор параметров создания скриптов путем выполнения битовой операции «ИЛИ» с двумя объектами ScriptOption.
Открытый операторСтатический элемент Implicit Widening Implicit Implicit Implicit(ScriptOption to ScriptingOptions) Неявно преобразует указанный объект ScriptOption в объект ScriptingOptions.

В начало

Замечания

The ScriptOption object contains a property for each type of SQL Server item that can be scripted. The actual set of items to be scripted is specified using the ScriptingOptions object.

Warning: Some script options cause the Transfer object to generate script that does not execute on the target server.

Thread Safety

Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Безопасная многопоточная работа с членами экземпляров типа не гарантируется.

Примеры

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server
'Reference the AdventureWorks2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2008R2")
'Define a Scripter object and set the required scripting options.
Dim scrp As Scripter
scrp = New Scripter(srv)
scrp.Options.ScriptDrops = False
scrp.Options.WithDependencies = True
'Iterate through the tables in database and script each one. Display the script.
'Note that the StringCollection type needs the System.Collections.Specialized namespace to be included.
Dim tb As Table
Dim smoObjects(1) As Urn
For Each tb In db.Tables
    smoObjects = New Urn(0) {}
    smoObjects(0) = tb.Urn
    If tb.IsSystemObject = False Then
        Dim sc As StringCollection
        sc = scrp.Script(smoObjects)
        Dim st As String
        For Each st In sc
            Console.WriteLine(st)
        Next
    End If
Next

Безопасность многопоточности

Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.

См. также

Справочник

Пространство имен Microsoft.SqlServer.Management.Smo

Другие ресурсы

Создание сценария

  • Last updated on