Класс JobStep
The JobStep class represents a Microsoft SQL Server job step.
Иерархия наследования
System. . :: . .Object
Microsoft.SqlServer.Management.Smo. . :: . .SmoObjectBase
Microsoft.SqlServer.Management.Smo. . :: . .SqlSmoObject
Microsoft.SqlServer.Management.Smo. . :: . .NamedSmoObject
Microsoft.SqlServer.Management.Smo.Agent. . :: . .AgentObjectBase
Microsoft.SqlServer.Management.Smo.Agent..::..JobStep
Пространство имен: Microsoft.SqlServer.Management.Smo.Agent
Сборка: Microsoft.SqlServer.Smo (в Microsoft.SqlServer.Smo.dll)
Синтаксис
'Декларация
<SfcElementTypeAttribute("Step")> _
Public NotInheritable Class JobStep _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
'Применение
Dim instance As JobStep
[SfcElementTypeAttribute("Step")]
public sealed class JobStep : AgentObjectBase,
IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[SfcElementTypeAttribute(L"Step")]
public ref class JobStep sealed : public AgentObjectBase,
IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
[<SfcElementTypeAttribute("Step")>]
type JobStep =
class
inherit AgentObjectBase
interface IAlterable
interface ICreatable
interface IDroppable
interface IRenamable
interface IScriptable
end
public final class JobStep extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
Тип JobStep обеспечивает доступ к следующим элементам.
Конструкторы
Имя | Описание | |
---|---|---|
JobStep() () () () | Initializes a new instance of the JobStep class. | |
JobStep(Job, String) | Initializes a new instance of the JobStep class for the specified job and with the specified name. |
В начало
Свойства
Имя | Описание | |
---|---|---|
Command | Gets or sets the command execution string for the job step. | |
CommandExecutionSuccessCode | Gets or sets the process exit code from a command shell process executed as a job step. | |
DatabaseName | Gets or sets the name of the database to which the job step command execution is confined. | |
DatabaseUserName | Gets or sets the database user account that the job step assumes when executing the command string. | |
ExecuteForScalar | Возвращает или задает значение свойства типа Boolean, указывающее, настроен ли объект для выполнения в скалярном режиме. (Производный от SqlSmoObject.) | |
ID | Gets or sets the ID value that uniquely identifies the job step. | |
IsTouched | Возвращает значение свойства типа Boolean, указывающее, были ли свойства объекта обновлены, но еще не сохранены на сервере. (Производный от SqlSmoObject.) | |
JobStepFlags | The JobStepFlags property is reserved for future use. | |
LastRunDate | Gets the date and time when the job step was last executed. | |
LastRunDuration | Gets the time that the referenced job step took to run when it was last executed. | |
LastRunOutcome | Gets the outcome of the job step when it was last executed. | |
LastRunRetries | Gets the number of retries that were attempted when the job step was last executed. | |
Name | Gets or sets the name of the object. (Производный от NamedSmoObject.) | |
ObjectInSpace | Возвращает значение свойства типа Boolean, указывающее, существует ли объект изолированно или же он явно или неявно подключен к экземпляру SQL Server. (Производный от SqlSmoObject.) | |
OnFailAction | Gets or sets the action to take when the job step finishes execution with failure. | |
OnFailStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of failure. | |
OnSuccessAction | Gets or sets the action to take when the job step finishes execution with success. | |
OnSuccessStep | Gets or sets the job step that is executed after the referenced job step finishes execution with a completion status of success. | |
OSRunPriority | Gets or sets the execution thread scheduling for job steps executing operating system tasks. | |
OutputFileName | Gets or sets the name and path of the operating system file that records job step result message text. | |
Parent | Gets or sets the Job object that is the parent of the JobStep object. | |
Properties | Возвращает коллекцию объектов Property, представляющих свойства объекта. (Производный от SqlSmoObject.) | |
ProxyName | Gets or sets the name of the Microsoft SQL Server Agent proxy account that is required by the job step. | |
RetryAttempts | Gets or sets the maximum number of times a job step is retried before it is returned with a completion status of failure. | |
RetryInterval | Gets or sets the number of minutes that Microsoft SQL Server Agent waits before trying to execute a job step that has previously failed. | |
ScalarResult | Возвращает скалярный результат для объекта, на который ссылаются. (Производный от SqlSmoObject.) | |
Server | Gets or sets the name of the server on which the job step runs. | |
State | Gets the state of the referenced object. (Производный от SmoObjectBase.) | |
SubSystem | Gets or sets the Microsoft SQL Server Agent execution subsystem used to interpret job step command text. | |
Urn | Возвращает значение адреса универсального имени ресурса (URN), которое однозначно идентифицирует объект. (Производный от SqlSmoObject.) | |
UserData | Gets or sets user-defined data associated with the referenced object. (Производный от SmoObjectBase.) |
В начало
Методы
Имя | Описание | |
---|---|---|
AddDatabaseContext(StringCollection) | Добавляет контекст базы данных в коллекцию запросов, определенную параметром queries. (Производный от SqlSmoObject.) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | Добавляет контекст базы данных в коллекцию запросов, определяемую параметром queries при использовании указанных параметров создания скриптов. (Производный от SqlSmoObject.) | |
Alter | Updates any JobStep object property changes on instance of Microsoft SQL Server. | |
AlterImpl | Активирует событие изменения объекта. (Производный от SqlSmoObject.) | |
AlterImplFinish | Метод, вызываемый при завершении события изменения объекта. (Производный от SqlSmoObject.) | |
AlterImplInit | Метод, вызываемый при инициализации события изменения объекта. (Производный от SqlSmoObject.) | |
AlterImplWorker | Вызывает методы изменения. (Производный от SqlSmoObject.) | |
BindDefaultImpl | Связывает элементы по умолчанию, определенные параметрами. (Производный от SqlSmoObject.) | |
BindRuleImpl | Связывает схему правил с правилом и столбцами, определенными параметрами. (Производный от SqlSmoObject.) | |
CheckCollation | Проверяет порядок параметров создания скриптов в методе сортировки, определенном параметром collationName. (Производный от SqlSmoObject.) | |
CheckObjectState() () () () | Проверяет состояние связанного объекта. (Производный от SqlSmoObject.) | |
CheckObjectState(Boolean) | Проверяет состояние связанного объекта с возможностью указать исключение, возникающее, если объект еще не создан. (Производный от SqlSmoObject.) | |
CheckObjectStateImpl | Проверяет состояние объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
CheckVersion100 | Проверяет, является ли SQL Server версией SQL Server 2008. (Производный от SqlSmoObject.) | |
CheckVersion80 | Проверяет правильность объекта в SQL Server 2000. (Производный от SqlSmoObject.) | |
CheckVersion80SP3 | Проверяет правильность объекта в SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.) | |
CheckVersion90 | Проверяет правильность объекта в SQL Server 2005. (Производный от SqlSmoObject.) | |
CheckVersionBelow90 | Проверяет, является ли SQL Server более ранней версией, чем SQL Server 2005. (Производный от SqlSmoObject.) | |
CleanObject | Устанавливает объект в неизмененное исходное состояние. (Производный от SqlSmoObject.) | |
Create | Creates a job step on the instance of Microsoft SQL Server as defined by the JobStep object. | |
CreateImpl | Создает объект с параметрами создания скриптов. (Производный от SqlSmoObject.) | |
CreateImplFinish | Метод, вызываемый при завершении события создания. (Производный от SqlSmoObject.) | |
CreateImplInit | Метод, вызываемый при инициализации события создания. (Производный от SqlSmoObject.) | |
DeleteLogs(DateTime) | Deletes job step log files that are older than the specified date. | |
DeleteLogs(Int32) | Deletes job step log files that have log numbers lower than the specified value. | |
Discover | Находит список типа Object. (Производный от SqlSmoObject.) | |
Drop | Removes the referenced job step. | |
DropImpl | Удаляет объект SqlSmoObject. (Производный от SqlSmoObject.) | |
DropImplWorker | Вызывает методы удаления. (Производный от SqlSmoObject.) | |
EnumLogs | Returns an enumerated list of the job step log files. | |
EnumScriptImpl | Перечисляет сценарии, заданные параметром so. (Производный от SqlSmoObject.) | |
EnumScriptImplWorker | Вызывает методы, перечисляющие заданные параметром so сценарии. (Производный от SqlSmoObject.) | |
EnumScriptImplWorkerSOChanged | Возвращает строку IEnumerable, описывающую параметры создания скриптов объекта. (Производный от SqlSmoObject.) | |
Equals | (Производный от Object.) | |
ExecuteNonQuery | (Производный от SqlSmoObject.) | |
Finalize | (Производный от Object.) | |
FormatSqlVariant | Форматирует объект как имеющий тип SqlVariant. (Производный от SqlSmoObject.) | |
GenerateDataSpaceFileStreamScript | Формирует скрипт, создающий файл данных. (Производный от SqlSmoObject.) | |
GenerateDataSpaceScript | Формирует скрипт, выделяющий пространство в файле данных. (Производный от SqlSmoObject.) | |
GetBindDefaultScript | Возвращает скрипт, привязывающий значения по умолчанию, определенные параметрами defSchema и defName. (Производный от SqlSmoObject.) | |
GetBindRuleScript | Возвращает скрипт, указывающий правила привязки. (Производный от SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Назначает параметр типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Назначает свойство типа boolean объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetDateTimeParameter | Назначает свойство типа datetime объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetDateTimeParameterAsInt | Назначает свойство типа datetime объекта SqlSmoObject в виде целочисленного значения, если свойство типа datetime не равно NULL. (Производный от SqlSmoObject.) | |
GetDBName | Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. Gets the database name that is associated with the object. (Производный от AgentObjectBase.) | |
GetEnumParameter | Назначает свойство перечисления SqlSmoObject. (Производный от SqlSmoObject.) | |
GetFragOptionString | Возвращает объект FragmentationOption в виде строкового значения. (Производный от SqlSmoObject.) | |
GetGuidParameter | Назначает свойство Guid объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetHashCode | (Производный от Object.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Назначает параметр объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetPropValue | Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetPropValueOptional | Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetPropValueOptionalAllowNull | Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetRealValue | Возвращает значение свойства объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetScriptingOptionsForCreate | Возвращает параметры ScriptingOptions объектаSqlSmoObject. (Производный от SqlSmoObject.) | |
GetServerName | Возвращает имя экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.) | |
GetServerObject | Возвращает сервер объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetSqlServerVersionName | Возвращает имя версии экземпляра SQL Server, с которым связан объект. (Производный от SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | Назначает параметр типа string объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetTimeSpanParameterAsInt | Назначает параметр временного диапазона объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
GetType | (Производный от Object.) | |
GetUrnRecursive(StringBuilder) | Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | Присваивает объект Urn объекту SqlSmoObject. (Производный от SqlSmoObject.) | |
ImplInitialize | Инициализирует поля объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
Initialize() () () () | Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.) | |
Initialize(Boolean) | Инициализирует объект и инициирует загрузку свойств. (Производный от SqlSmoObject.) | |
IsObjectDirty | Проверяет, было ли изменено свойство объекта, еще не сохраненное в экземпляре SQL Server. (Производный от SqlSmoObject.) | |
IsObjectInitialized | Проверяет, был ли объект инициализирован. (Производный от SqlSmoObject.) | |
IsObjectInSpace | Проверяет, является ли объект изолированным или подключенным к экземпляру SQL Server. (Производный от SqlSmoObject.) | |
IsVersion80SP3 | Определяет, является ли SQL Server версией SQL Server 2000 с пакетом обновления 3 (SP3). (Производный от SqlSmoObject.) | |
IsVersion90AndAbove | Определяет, является ли SQL Server версией SQL Server 2005 или более поздней. (Производный от SqlSmoObject.) | |
MarkDropped | Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.) | |
MarkForDropImpl | Устанавливает состояние SqlSmoState для удаления. (Производный от SqlSmoObject.) | |
MemberwiseClone | (Производный от Object.) | |
PostAlter | Метод, активируемый после изменения SqlSmoObject. (Производный от SqlSmoObject.) | |
PostCreate | Метод, активируемый после создания SqlSmoObject. (Производный от SqlSmoObject.) | |
PostDrop | Метод, активируемый после удаления SqlSmoObject. (Производный от SqlSmoObject.) | |
Refresh | Обновляет объект и извлекает свойства объекта при следующем обращении. (Производный от SqlSmoObject.) | |
Rename | Renames the job step. | |
RenameImpl | Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.) | |
RenameImplWorker | Указано только в ознакомительных целях. Не поддерживается. Совместимость с будущими версиями не гарантируется. (Производный от NamedSmoObject.) | |
Script() () () () | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step. | |
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job step as specified by the scripting options. | |
ScriptAlter | Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.) | |
ScriptCreate | Изменяет SqlSmoObject в соответствии с параметрами. (Производный от SqlSmoObject.) | |
ScriptDdl | Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.) | |
ScriptDrop | Вызывает исключение InvalidSmoOperationException. (Производный от SqlSmoObject.) | |
ScriptImpl() () () () | Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.) | |
ScriptImpl(ScriptingOptions) | Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.) | |
ScriptImplWorker | Возвращает коллекцию скриптов SqlSmoObject. (Производный от SqlSmoObject.) | |
ScriptOwner | Alters the script owner authorization. (Производный от NamedSmoObject.) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (Производный от NamedSmoObject.) | |
SetParentImpl | Устанавливает родительский объект объекта SqlSmoObject в значение параметра newParent. (Производный от SqlSmoObject.) | |
SetSchemaOwned | Sets the schema owned value. (Производный от NamedSmoObject.) | |
ToString | Возвращает String, представляющее объект, на который ссылаются. (Производный от SqlSmoObject.) | |
TouchImpl | Не реализовано. (Производный от SqlSmoObject.) | |
UnbindDefaultImpl | Отменяет привязку столбцов по умолчанию для объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
UnbindRuleImpl | Отменяет привязку правил для объекта SqlSmoObject. (Производный от SqlSmoObject.) | |
Validate | Validates the state of an object. (Производный от SmoObjectBase.) |
В начало
События
Имя | Описание | |
---|---|---|
PropertyChanged | Представляет событие, возникающее при изменении свойства. (Производный от SqlSmoObject.) | |
PropertyMetadataChanged | Представляет событие, возникающее при изменении метаданных свойства. (Производный от SqlSmoObject.) |
В начало
Поля
Имя | Описание | |
---|---|---|
m_ExtendedProperties | Представляет свойство, определенное для расширения свойств, предоставляемых объектом SqlSmoObject. (Производный от SqlSmoObject.) | |
singletonParent | Представляет единственного родителя. (Производный от SqlSmoObject.) |
В начало
Явные реализации интерфейса
Имя | Описание | |
---|---|---|
IAlienObject. . :: . .Discover | Находит любые зависимости. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .GetDomainRoot | Возвращает корневой элемент домена. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .GetParent | Возвращает родительский объект для данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyType | Возвращает тип указанного свойства. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .GetPropertyValue | Возвращает значение указанного свойства. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .GetUrn | Возвращает универсальное имя ресурса для объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .Resolve | Возвращает экземпляр, содержащий данные об объекте из универсального имени ресурса для объекта. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .SetObjectState | Задает состоянию объекта указанное значение SfcObjectState. (Производный от SqlSmoObject.) | |
IAlienObject. . :: . .SetPropertyValue | Устанавливает значение свойства. (Производный от SqlSmoObject.) | |
ISfcPropertyProvider. . :: . .GetPropertySet | Возвращает ссылку на интерфейс для набора свойств данного объекта. Не ссылайтесь на этот элемент непосредственно из кода. Он поддерживает работу инфраструктуры SQL Server. (Производный от SqlSmoObject.) |
В начало
Замечания
SQL Server Agent jobs contain one or more execution units called steps. Each job step contains a textual command, type of execution that specifies command interpretation, and logic that determines the behavior of the job if the step succeeds or fails. For example, a job step can contain:
The command text. For example:
DBCC CHECKDB ('Northwind') WITH NO_INFOMSGS
A job step execution type: Transact-SQL for example.
An indication that the job should stop if the step fails.
With the JobStep object, you can do the following:
Create a SQL Server Agent job step.
Remove a job step from a SQL Server Agent job.
Manage existing job steps by changing, for example, the command text or the actions taken on success or failure of the step.
Obtain details about the last attempted execution of the step.
To get JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role.
To set JobStep object properties, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the owner of the job step, or be a member of the sysadmin fixed server role.
To create a job step, users must be a member of SQLAgentUserRole database role on the MSDB database or be a member of the sysadmin fixed server role. The user must also have permission on any proxy accounts used by the job step.
To drop a job step, users must be a member of SQLAgentUserRole database role on the MSDB database, be the owner of the job step, or be a member of the sysadmin fixed server role.
Thread Safety
Все общие статические члены этого типа (Shared в Microsoft Visual Basic) можно использовать в многопоточных операциях. Безопасная многопоточная работа с членами экземпляров типа не гарантируется.
Безопасность многопоточности
Любые открытые статический (Shared в Visual Basic) элементы этого типа потокобезопасны. Потокобезопасность с элементами экземпляров не гарантируется.