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 | Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (从 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 | Gets the Boolean property value that specifies whether the object properties have been updated but not yet persisted on the server. (从 SqlSmoObject 继承。) | |
JobID | Gets or sets 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 | (覆盖 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 | Gets the Boolean property value that specifies whether the object exists in isolation, or whether it is directly or indirectly connected to the instance of 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 | Gets a collection of Property objects that represent the object properties. (从 SqlSmoObject 继承。) | |
ScalarResult | Gets the scalar result for the referenced object. (从 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 | Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (从 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 | (从 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 | (从 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 | (从 SqlSmoObject 继承。) | |
CheckObjectState() () () () | Validates the state of the referenced object. (从 SqlSmoObject 继承。) | |
CheckObjectState(Boolean) | Validates the state of the referenced object with the option to specify that an exception is thrown if the object is not yet created. (从 SqlSmoObject 继承。) | |
CheckObjectStateImpl | (从 SqlSmoObject 继承。) | |
CheckVersion100 | (从 SqlSmoObject 继承。) | |
CheckVersion80 | Checks the validity of the object on SQL Server 2000. (从 SqlSmoObject 继承。) | |
CheckVersion80SP3 | Checks the validity of the object on SQL Server 2000 SP3. (从 SqlSmoObject 继承。) | |
CheckVersion90 | Check the validity of the object on SQL Server 2005. (从 SqlSmoObject 继承。) | |
CheckVersionBelow90 | (从 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 | (从 SqlSmoObject 继承。) | |
Drop() () () () | Removes an existing job. | |
Drop(Boolean) | Removes an existing job. | |
DropImpl | (从 SqlSmoObject 继承。) | |
DropImplWorker | (从 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 | (从 SqlSmoObject 继承。) | |
EnumScriptImplWorker | (从 SqlSmoObject 继承。) | |
EnumTargetServers | Enumerates a list of execution target servers that have been assigned to the referenced job. | |
Equals | (从 Object 继承。) | |
Finalize | (从 Object 继承。) | |
FormatSqlVariant | (从 SqlSmoObject 继承。) | |
GenerateDataSpaceFileStreamScript | (从 SqlSmoObject 继承。) | |
GenerateDataSpaceScript | (从 SqlSmoObject 继承。) | |
GetBindDefaultScript | (从 SqlSmoObject 继承。) | |
GetBindRuleScript | (从 SqlSmoObject 继承。) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (从 SqlSmoObject 继承。) | |
GetBoolParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (从 SqlSmoObject 继承。) | |
GetDateTimeParameter | (从 SqlSmoObject 继承。) | |
GetDateTimeParameterAsInt | (从 SqlSmoObject 继承。) | |
GetDBName | Gets the database name that is associated with the object. (从 AgentObjectBase 继承。) | |
GetEnumParameter | (从 SqlSmoObject 继承。) | |
GetFragOptionString | (从 SqlSmoObject 继承。) | |
GetGuidParameter | (从 SqlSmoObject 继承。) | |
GetHashCode | (从 Object 继承。) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (从 SqlSmoObject 继承。) | |
GetParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (从 SqlSmoObject 继承。) | |
GetPropValue | (从 SqlSmoObject 继承。) | |
GetPropValueOptional | (从 SqlSmoObject 继承。) | |
GetPropValueOptionalAllowNull | (从 SqlSmoObject 继承。) | |
GetRealValue | (从 SqlSmoObject 继承。) | |
GetScriptingOptionsForCreate | (从 SqlSmoObject 继承。) | |
GetServerName | Gets the name of the instance of SQL Server with which the object is associated. (从 SqlSmoObject 继承。) | |
GetServerObject | (从 SqlSmoObject 继承。) | |
GetSqlServerVersionName | Gets the version name of the instance of SQL Server with which the object is associated. (从 SqlSmoObject 继承。) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%) | (从 SqlSmoObject 继承。) | |
GetStringParameter(StringBuilder, ScriptingOptions, String, String, Int32%, Boolean) | (从 SqlSmoObject 继承。) | |
GetTimeSpanParameterAsInt | (从 SqlSmoObject 继承。) | |
GetType | (从 Object 继承。) | |
GetUrnRecursive(StringBuilder) | (从 SqlSmoObject 继承。) | |
GetUrnRecursive(StringBuilder, UrnIdOption) | (从 SqlSmoObject 继承。) | |
ImplInitialize | (从 SqlSmoObject 继承。) | |
Initialize() () () () | Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。) | |
Initialize(Boolean) | Initializes the object and forces the properties be loaded. (从 SqlSmoObject 继承。) | |
Invoke | Runs the job. | |
IsObjectDirty | Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of SQL Server. (从 SqlSmoObject 继承。) | |
IsObjectInitialized | Verifies whether the object has been initialized. (从 SqlSmoObject 继承。) | |
IsObjectInSpace | Verifies whether the object is isolated or connected to the instance of SQL Server. (从 SqlSmoObject 继承。) | |
IsVersion80SP3 | (从 SqlSmoObject 继承。) | |
MarkDropped | (从 SqlSmoObject 继承。) | |
MarkForDropImpl | (从 SqlSmoObject 继承。) | |
MemberwiseClone | (从 Object 继承。) | |
PostAlter | (从 SqlSmoObject 继承。) | |
PostCreate | (从 SqlSmoObject 继承。) | |
PostDrop | (从 SqlSmoObject 继承。) | |
PurgeHistory | Removes system records maintaining execution history for the referenced job. | |
Refresh | Refreshes the object and retrieves properties when the object is next accessed. (从 SqlSmoObject 继承。) | |
RemoveAllJobSchedules() () () () | Removes all shared and unshared schedules from the job. | |
RemoveAllJobSchedules(Boolean) | Removes all shared and unshared 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 | This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。) | |
RenameImplWorker | This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 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 继承。) | |
ScriptChangeOwner | This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。) | |
ScriptCreate | (从 SqlSmoObject 继承。) | |
ScriptDdl | (从 SqlSmoObject 继承。) | |
ScriptDrop | (从 SqlSmoObject 继承。) | |
ScriptImpl() () () () | (从 SqlSmoObject 继承。) | |
ScriptImpl(ScriptingOptions) | (从 SqlSmoObject 继承。) | |
ScriptImplWorker | (从 SqlSmoObject 继承。) | |
ScriptRename | This method supports the SMO infrastructure and is not intended to be used directly from your code. (从 NamedSmoObject 继承。) | |
SetParentImpl | (从 SqlSmoObject 继承。) | |
Start() () () () | Runs the referenced job. | |
Start(String) | Runs the referenced job starting at the specified job step. | |
Stop | Stops executing the referenced job. | |
ToString | Returns a String that represents the referenced object. (从 SqlSmoObject 继承。) | |
TouchImpl | (从 SqlSmoObject 继承。) | |
UnbindDefaultImpl | (从 SqlSmoObject 继承。) | |
UnbindRuleImpl | (从 SqlSmoObject 继承。) | |
Validate | (从 SmoObjectBase 继承。) |
页首
显式接口实现
名称 | 说明 | |
---|---|---|
IAlienObjectDiscover | (从 SqlSmoObject 继承。) | |
IAlienObjectGetParent | (从 SqlSmoObject 继承。) | |
IAlienObjectGetProperty | (从 SqlSmoObject 继承。) | |
ISfcPropertyProviderGetPropertySet | (从 SqlSmoObject 继承。) | |
IAlienObjectGetUrn | (从 SqlSmoObject 继承。) | |
IAlienObjectResolve | (从 SqlSmoObject 继承。) | |
IAlienObjectSetProperty | (从 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) 成员都是线程安全的。不保证所有实例成员都是线程安全的。