Job 类
The Job class represents a Microsoft SQL Server Agent job.
继承层次结构
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..::..Job
命名空间: Microsoft.SqlServer.Management.Smo.Agent
程序集: Microsoft.SqlServer.Smo(在 Microsoft.SqlServer.Smo.dll 中)
语法
声明
Public NotInheritable Class Job _
Inherits AgentObjectBase _
Implements IAlterable, ICreatable, IDroppable, IRenamable, _
IScriptable
用法
Dim instance As Job
public sealed class Job : AgentObjectBase, IAlterable,
ICreatable, IDroppable, IRenamable, IScriptable
public ref class Job sealed : public AgentObjectBase,
IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
[<SealedAttribute>]
type Job =
class
inherit AgentObjectBase
interface IAlterable
interface ICreatable
interface IDroppable
interface IRenamable
interface IScriptable
end
public final class Job extends AgentObjectBase implements IAlterable, ICreatable, IDroppable, IRenamable, IScriptable
Job 类型公开以下成员。
构造函数
名称 | 说明 | |
---|---|---|
Job() () () () | Initializes a new instance of the Job class. | |
Job(JobServer, String) | Initializes a new instance of the Job class on the specified instance of Microsoft SQL Server Agent and with the specified name. | |
Job(JobServer, String, Int32) | Initializes a new instance of the Job class on the specified instance of SQL Server Agent and with the specified name and category |
页首
属性
名称 | 说明 | |
---|---|---|
Category | Gets or sets the category to which the job belongs. | |
CategoryID | Gets the ID value that uniquely identifies the job category. | |
CategoryType | Gets or sets the type of category, with respect to local or multiserver jobs. | |
CurrentRunRetryAttempt | Gets the number of times Microsoft SQL Server Agent has attempted to run the job unsuccessfully. | |
CurrentRunStatus | Gets the current execution status of the job. | |
CurrentRunStep | Gets information about the job step that is currently running. | |
DateCreated | Gets the date and time when the job was created. | |
DateLastModified | Gets the date and time when the job was last modified. | |
DeleteLevel | Gets or sets the completion action that determines whether to delete the job definition when the job finishes execution. | |
Description | Gets or sets the textual description of the job. | |
EmailLevel | Gets or sets the completion action that determines whether to send an e-mail notification to an operator when the job finishes execution. | |
EventLogLevel | Gets or sets the completion action that determines whether to generate an operating system event log entry when the job finishes execution. | |
ExecuteForScalar | 获取或设置 Boolean 属性值,该值指定对象是否设置为针对标量选项执行。 (从 SqlSmoObject 继承。) | |
HasSchedule | Gets the Boolean property value that specifies whether the job has at least one schedule. | |
HasServer | Gets the Boolean property value that specifies whether the job has a target server assigned for multiple-server operations. | |
HasStep | Gets the Boolean property value that specifies whether the job has at least one job step. | |
IsEnabled | Gets or sets the Boolean property value that specifies whether the job is enabled. | |
IsTouched | 获取 Boolean 属性值,该值指定在服务器上对象属性是否已更新但尚未持久化。 (从 SqlSmoObject 继承。) | |
JobID | Gets the job ID value. | |
JobSchedules | Gets a collection of JobSchedule objects that represent the schedules assigned to the job. | |
JobSteps | Gets a collection of JobStep objects that represent the job steps defined for the job. | |
JobType | Gets the job type, which specifies whether the job is local or multiserver. | |
LastRunDate | Gets the date and time when the job was last run. | |
LastRunOutcome | Gets the result of the job from the last time it completed execution. | |
Name | Gets or sets the name of the Job. (覆盖 NamedSmoObject. . :: . .Name。) | |
NetSendLevel | Gets or sets the completion action that determines whether to net-send a notification to an operator when the job finishes execution. | |
NextRunDate | Gets the date and time when the job is next scheduled to run. | |
NextRunScheduleID | Gets the ID value of the schedule that is responsible for the next execution of the job. | |
ObjectInSpace | 获取 Boolean 属性值,该值指定对象是否单独存在,或者对象是否直接或间接连接到 SQL Server 的实例。 (从 SqlSmoObject 继承。) | |
OperatorToEmail | Gets or sets the operator that receives notification by e-mail when the job finishes execution. | |
OperatorToNetSend | Gets or sets the operator that receives a net-send notification when the job finishes execution. | |
OperatorToPage | Gets or sets the operator that receives a pager notification when the job finishes execution. | |
OriginatingServer | Gets the name of the server that is acting as the master server in a multiserver job. | |
OwnerLoginName | Gets or sets the owner of the job. | |
PageLevel | Gets or sets the completion action that determines whether to send a pager notification to an operator when the job finishes execution. | |
Parent | Gets or sets the JobServer object that is the parent of the Job object. | |
Properties | 获取表示对象属性的 Property 对象的集合。 (从 SqlSmoObject 继承。) | |
ScalarResult | 获取所引用对象的标量结果。 (从 SqlSmoObject 继承。) | |
StartStepID | Gets or sets the ID value of the first job step in the sequence to be executed. | |
State | Gets the state of the referenced object. (从 SmoObjectBase 继承。) | |
Urn | 获取唯一标识对象的统一资源名称 (URN) 地址值。 (从 SqlSmoObject 继承。) | |
UserData | Gets or sets user-defined data associated with the referenced object. (从 SmoObjectBase 继承。) | |
VersionNumber | Gets a system-maintained value that is incremented every time the job is modified. |
页首
方法
名称 | 说明 | |
---|---|---|
AddDatabaseContext(StringCollection) | 将数据库上下文添加到 queries 参数标识的查询集合。 (从 SqlSmoObject 继承。) | |
AddDatabaseContext(StringCollection, ScriptingOptions) | 将数据库上下文添加到 queries 参数标识的查询集合,并且使用指定的脚本选项。 (从 SqlSmoObject 继承。) | |
AddSharedSchedule | Adds a shared schedule to the Microsoft SQL Server Agent job. | |
Alter | Updates any Job object property changes on an instance of Microsoft SQL Server. | |
AlterImpl | 激活对象已更改事件。 (从 SqlSmoObject 继承。) | |
AlterImplFinish | 在对象已更改事件完成时调用的方法。 (从 SqlSmoObject 继承。) | |
AlterImplInit | 在对象已更改事件初始化时调用的方法。 (从 SqlSmoObject 继承。) | |
AlterImplWorker | 调用 Alter 方法。 (从 SqlSmoObject 继承。) | |
ApplyToTargetServer | Adds a server to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. | |
ApplyToTargetServerGroup | Adds one or more servers to the list of target servers maintained for the referenced Microsoft SQL Server Agent job. | |
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 SP3 上对象的有效性。 (从 SqlSmoObject 继承。) | |
CheckVersion90 | 检查 SQL Server 2005 上对象的有效性。 (从 SqlSmoObject 继承。) | |
CheckVersionBelow90 | 检查 SQL Server 的版本是否在 SQL Server 2005 之前。 (从 SqlSmoObject 继承。) | |
CleanObject | 将对象设置为未修改的状态。 (从 SqlSmoObject 继承。) | |
Create | Creates a job on the instance of Microsoft SQL Server as defined by the Job object. | |
CreateImpl | 使用脚本选项创建对象。 (从 SqlSmoObject 继承。) | |
CreateImplFinish | 在创建事件完成时调用的方法。 (从 SqlSmoObject 继承。) | |
CreateImplInit | 在创建事件初始化时调用的方法。 (从 SqlSmoObject 继承。) | |
DeleteJobStepLogs(DateTime) | Deletes job step log files that are older than the specified date. | |
DeleteJobStepLogs(Int32) | Deletes job step log files that are larger that the specified log ID number. | |
Discover | 发现 Object 类型的列表。 (从 SqlSmoObject 继承。) | |
Drop() () () () | Removes an existing job. | |
Drop(Boolean) | Removes an existing job. | |
DropImpl | 删除 SqlSmoObject。 (从 SqlSmoObject 继承。) | |
DropImplWorker | 调用 drop 方法。 (从 SqlSmoObject 继承。) | |
EnumAlerts | Enumerates a list of Agent alerts that cause automated execution of the referenced job. | |
EnumHistory() () () () | Enumerates a list of execution history associated with the referenced job. | |
EnumHistory(JobHistoryFilter) | Enumerates a list of execution history associated with the referenced job. | |
EnumJobStepLogs() () () () | Enumerates a list of job step log files for the referenced job. | |
EnumJobStepLogs(Int32) | Enumerates a list of job step log files for the job step with the specified ID value. | |
EnumJobStepLogs(String) | Enumerates a list of job step log files for the job step with the specified name. | |
EnumJobStepsByID | Returns an array of JobStep objects that belong to the referenced job and that are ordered by ID value. | |
EnumScriptImpl | 枚举 so 参数指定的脚本。 (从 SqlSmoObject 继承。) | |
EnumScriptImplWorker | 调用枚举 so 参数指定的脚本的方法。 (从 SqlSmoObject 继承。) | |
EnumScriptImplWorkerSOChanged | 返回描述对象的脚本选项的 IEnumerable 字符串。 (从 SqlSmoObject 继承。) | |
EnumTargetServers | Enumerates a list of execution target servers that have been assigned to the referenced job. | |
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%) | 对 SqlSmoObject 的布尔参数赋值。 (从 SqlSmoObject 继承。) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | 对 SqlSmoObject 的布尔属性赋值。 (从 SqlSmoObject 继承。) | |
GetDateTimeParameter | 对 SqlSmoObject 的日期时间属性赋值。 (从 SqlSmoObject 继承。) | |
GetDateTimeParameterAsInt | 为 SqlSmoObject 的日期时间属性赋一个整数值(如果该日期时间属性不为 Null)。 (从 SqlSmoObject 继承。) | |
GetDBName | 不要在您的代码中直接引用此成员。它支持 SQL Server 基础结构。 Gets the database name that is associated with the object. (从 AgentObjectBase 继承。) | |
GetEnumParameter | 对 SqlSmoObject 的枚举属性赋值。 (从 SqlSmoObject 继承。) | |
GetFragOptionString | 获取作为字符串值的 FragmentationOption 对象。 (从 SqlSmoObject 继承。) | |
GetGuidParameter | 对 SqlSmoObject 的 Guid 属性赋值。 (从 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 | 获取 SqlSmoObject 对象的 ScriptingOptions。 (从 SqlSmoObject 继承。) | |
GetServerName | 获取对象与之关联的 SQL Server 实例的名称。 (从 SqlSmoObject 继承。) | |
GetServerObject | 获取 SqlSmoObject 对象的服务器。 (从 SqlSmoObject 继承。) | |
GetSqlServerVersionName | 获取对象与之关联的 SQL Server 实例的版本名称。 (从 SqlSmoObject 继承。) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | 对 SqlSmoObject 对象的字符串参数赋值。 (从 SqlSmoObject 继承。) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | 对 SqlSmoObject 对象的字符串参数赋值。 (从 SqlSmoObject 继承。) | |
GetTimeSpanParameterAsInt | 对 SqlSmoObject 对象的时间范围参数赋值。 (从 SqlSmoObject 继承。) | |
GetType | (从 Object 继承。) | |
GetUrnRecursive(StringBuilder) | 对 SqlSmoObject 对象的 Urn 对象赋值。 (从 SqlSmoObject 继承。) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | 对 SqlSmoObject 对象的 Urn 对象赋值。 (从 SqlSmoObject 继承。) | |
ImplInitialize | 初始化 SqlSmoObject 对象的字段。 (从 SqlSmoObject 继承。) | |
Initialize() () () () | 初始化对象并强制加载属性。 (从 SqlSmoObject 继承。) | |
Initialize(Boolean) | 初始化对象并强制加载属性。 (从 SqlSmoObject 继承。) | |
Invoke | Runs the job. | |
IsObjectDirty | 验证在 SQL Server 的实例上对象属性是否已修改并且更改是否尚未持久化。 (从 SqlSmoObject 继承。) | |
IsObjectInitialized | 验证对象是否已初始化。 (从 SqlSmoObject 继承。) | |
IsObjectInSpace | 验证对象是单独存在还是连接到 SQL Server 的实例。 (从 SqlSmoObject 继承。) | |
IsVersion80SP3 | 确定 SQL Server 的版本是否为 SQL Server 2000 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 继承。) | |
PurgeHistory | Removes system records maintaining execution history for the referenced job. | |
Refresh | 刷新对象并在下一次访问该对象时检索属性。 (从 SqlSmoObject 继承。) | |
RemoveAllJobSchedules() () () () | Removes all shared and unshared schedules from the job. | |
RemoveAllJobSchedules(Boolean) | Removes all unused schedules from the job. | |
RemoveAllJobSteps | Removes all the job steps associated with the job. | |
RemoveFromTargetServer | Removes an execution target server from the list of target servers maintained for a job. | |
RemoveFromTargetServerGroup | Removes a group of execution target servers from the list of target servers maintained for a job. | |
RemoveSharedSchedule(Int32) | Removes the specified shared schedule from the job. | |
RemoveSharedSchedule(Int32, Boolean) | Removes the specified shared schedule from the job and keeps unused schedules. | |
Rename | Renames the job. | |
RenameImpl | 标识为仅供参考。不提供支持。不保证以后的兼容性。 (从 NamedSmoObject 继承。) | |
RenameImplWorker | 标识为仅供参考。不提供支持。不保证以后的兼容性。 (从 NamedSmoObject 继承。) | |
Script() () () () | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job. | |
Script(ScriptingOptions) | Generates a Transact-SQL script that can be used to re-create the Microsoft SQL Server Agent job 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 继承。) | |
Start() () () () | Runs the referenced job. | |
Start(String) | Runs the referenced job starting at the specified job step. | |
Stop | Stops executing the referenced job. | |
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 继承。) |
页首
注释
To get or set Job object properties, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.
To create a job, users must be a member of the SQLAgentUserRole, SQLAgentReaderRole, and SQLAgentOperatorRole database roles on the MSDB database, or be a member of the sysadmin fixed server role.
To drop a job, users must be a member of the SQLAgentUserRole database role on the MSDB database, or be the owner of the job, or be a member of the sysadmin fixed server role.
Thread Safety
此类型的任何公共静态(Microsoft Visual Basic 中的 Shared)成员在多线程操作中是安全的。不保证所有实例成员都是线程安全的。
线程安全
此类型的任何公共 static(在 Visual Basic 中为 Shared) 成员都是线程安全的。不保证所有实例成员都是线程安全的。