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 為共用) 成員具備多執行緒作業安全。不保證所有執行個體成員都是安全執行緒。
執行緒安全性
這個型別的任何公用 static (在 Visual Basic 中為 Shared) 成員都是執行緒安全的。並不是所有的執行個體成員都保證可以用於所有的執行緒。