SqlSmoObject クラス
定義
重要
一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。
すべてのインスタンス クラスの共通機能が含まれています
[System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))]
public abstract class SqlSmoObject : Microsoft.SqlServer.Management.Smo.SmoObjectBase, Microsoft.SqlServer.Management.Common.IRefreshable, Microsoft.SqlServer.Management.Sdk.Sfc.IAlienObject, Microsoft.SqlServer.Management.Sdk.Sfc.ISfcPropertyProvider, System.ComponentModel.INotifyPropertyChanged
[<System.ComponentModel.TypeConverter(typeof(Microsoft.SqlServer.Management.Sdk.Sfc.LocalizableTypeConverter))>]
type SqlSmoObject = class
inherit SmoObjectBase
interface ISfcPropertyProvider
interface ISfcNotifyPropertyMetadataChanged
interface INotifyPropertyChanged
interface IRefreshable
interface IAlienObject
Public MustInherit Class SqlSmoObject
Inherits SmoObjectBase
Implements IAlienObject, INotifyPropertyChanged, IRefreshable, ISfcPropertyProvider
- 継承
- 派生
- 属性
- 実装
コンストラクター
| 名前 | 説明 |
|---|---|
| SqlSmoObject() |
すべてのインスタンス クラスの共通機能が含まれています |
フィールド
| 名前 | 説明 |
|---|---|
| m_ExtendedProperties |
すべてのインスタンス クラスの共通機能が含まれています |
| singletonParent |
通常の SMO オブジェクトは、parentColl (親クラスの対応するコレクション) を介して親クラス参照にアクセスします。 Singleton クラスには親にコレクションがありません。 |
プロパティ
| 名前 | 説明 |
|---|---|
| CollationDatabaseInServer |
すべてのインスタンス クラスの共通機能が含まれています |
| DatabaseEngineEdition |
SMO オブジェクトの DatabaseEngineEdition を返します。 |
| DatabaseEngineType |
SMO オブジェクトの DatabaseEngineType を返します。 |
| ExecuteForScalar |
すべてのインスタンス クラスの共通機能が含まれています |
| ExecutionManager |
すべてのインスタンス クラスの共通機能が含まれています |
| IsTouched |
オブジェクトが Alter の無条件スクリプト化のためにタッチされたかどうか |
| ObjectInSpace |
すべてのインスタンス クラスの共通機能が含まれています |
| ParentCollection |
オブジェクトを含むコレクションを返します。 null を指定できます。 |
| Properties |
すべてのインスタンス クラスの共通機能が含まれています |
| ScalarResult |
すべてのインスタンス クラスの共通機能が含まれています |
| ServerVersion |
オブジェクトを含むサーバーの ServerVersion を返します。 オブジェクトが接続されたサーバーに関連付けられていない場合は、最も高い既知のサーバー バージョンが返されます。 |
| State |
オブジェクトの状態を返します。 (継承元 SmoObjectBase) |
| Urn |
その場で計算されたオブジェクトの Urn を返します。 |
| UserData |
すべてのインスタンス クラスの共通機能が含まれています (継承元 SmoObjectBase) |
メソッド
| 名前 | 説明 |
|---|---|
| AddDatabaseContext(StringCollection) |
メソッドは、スクリプト関連の作成メソッド (Table、Index などの派生クラスから) から呼び出されます。 |
| AlterImpl() |
すべてのインスタンス クラスの共通機能が含まれています |
| AlterImplWorker() |
すべてのインスタンス クラスの共通機能が含まれています |
| BindDefaultImpl(String, String, Boolean) |
すべてのインスタンス クラスの共通機能が含まれています |
| BindRuleImpl(String, String, Boolean) |
すべてのインスタンス クラスの共通機能が含まれています |
| CheckObjectState() |
すべてのインスタンス クラスの共通機能が含まれています |
| CheckObjectState(Boolean) |
これは仮想関数であるため、派生クラスはオブジェクトの状態に関する追加のチェックを行う場合にオーバーライドできます。 |
| CheckObjectStateImpl(Boolean) |
オブジェクトの状態を確認します。これは再使用されないため、この関数を直接呼び出すことができます。つまり、派生クラスは独自の検証を提供できません |
| CleanObject() |
すべてのインスタンス クラスの共通機能が含まれています |
| CreateImpl() |
すべてのインスタンス クラスの共通機能が含まれています |
| CreateOrAlterImpl() |
すべてのインスタンス クラスの共通機能が含まれています |
| Discover() |
ベスト エフォート検出メカニズム: このメソッドはメタデータに反映され、使用可能なすべてのオブジェクトを取得します |
| DropImpl(Boolean, Boolean) |
Azureのユーザー データベースに対するドロップ呼び出しの場合、データベースが削除されると接続が閉じられます。ExecutionManager は通常、接続を再度開いてこのような呼び出しを再試行しようとします。handleSevereError が true の場合は、この再試行を回避したいと考えています。 |
| DropImpl(Boolean) |
オブジェクトを削除する |
| DropImplWorker(Urn, Boolean) |
オブジェクトを削除する |
| ExecuteNonQuery(StringCollection, Boolean, Boolean) |
sql ステートメントを実行します |
| ExecuteWithModes(SqlExecutionModes, Action) |
指定された実行モードで、指定されたアクションを実行します。 アクションが完了または失敗した後に、元のモードをリセットします。 |
| FormatSqlVariant(Object) |
すべてのインスタンス クラスの共通機能が含まれています |
| GenerateAlterEvent() |
すべてのインスタンス クラスの共通機能が含まれています |
| GenerateAlterEvent(Urn, Object) |
すべてのインスタンス クラスの共通機能が含まれています |
| GetChildType(String, String) |
すべてのインスタンス クラスの共通機能が含まれています |
| GetContextDB() |
すべてのインスタンス クラスの共通機能が含まれています |
| GetDBName() |
すべてのインスタンス クラスの共通機能が含まれています |
| GetDisabledProperties(ScriptingPreferences) |
特定のサーバーの種類またはエディションで明示的に無効になっているプロパティの列挙可能な機能を提供します。 これは、指定されたターゲットで機能しないすべてのプロパティの一覧ではありません。 |
| GetFragOptionString(FragmentationOption) |
すべてのインスタンス クラスの共通機能が含まれています |
| GetPropValue(String) |
プロパティが使用可能な場合 (ダーティまたは取得された) 場合は、プロパティ バッグを直接取得します。それ以外の場合は OnPropertyMissing メソッドの呼び出し いずれの場合も、プロパティ値が NULL の場合は例外がスローされます。 |
| GetPropValueOptional(String) |
プロパティ値の取得元: - 状態が作成されている場合、またはデザイン モードの場合はプロパティ バッグ (可能な NULL 値) - OnPropertyMissing メソッドの呼び出し。それ以外の場合は (値が NULL の場合は例外がスローされます) |
| GetPropValueOptional<T>(String, T) |
名前付きプロパティの値を返します。 オブジェクトが Creating 状態で、プロパティがまだ設定されていない場合は、defaultValue が返されます。 オブジェクトが存在する場合、defaultValue は無視され、実際の値が返されます。 |
| GetPropValueOptionalAllowNull(String) |
からプロパティ値を取得します。 - 状態が作成されている場合、またはデザイン モードの場合はプロパティ バッグ (可能な NULL) - OnPropertyMissing メソッドの呼び出し。それ以外の場合は (可能な NULL) |
| GetRealValue(Property, Object) |
プロパティの実際の値を返します。 |
| GetServerName() |
すべてのインスタンス クラスの共通機能が含まれています |
| GetServerObject() |
すべてのインスタンス クラスの共通機能が含まれています |
| GetSqlServerVersionName() |
現在の接続の sqlserver パブリック名を取得します (例: "SQL Server 2008")。 |
| GetStringComparer() |
オブジェクト名の比較を実行するために、すべての子オブジェクト コレクションで使用される比較子を返します。 サーバーの比較子は、マスターの照合順序に基づいています。データベースとその子の比較子は、データベースの照合順序に基づいています |
| GetTypeFromUrnSkeleton(Urn) |
すべてのインスタンス クラスの共通機能が含まれています |
| GetUrnRecursive(StringBuilder, UrnIdOption) |
オブジェクトの Urn を計算します。場合によっては、キー フィールド以外の他のフィールドも定義に含めることができます。 |
| GetUrnRecursive(StringBuilder) |
オブジェクトの Urn を計算します。 |
| GetUrnSuffix(Type) |
指定した型から UrnSuffix を取得します。または、型が UrnSuffix という名前の静的プロパティを定義していない場合は空の文字列を取得します。 |
| ImplInitialize(String[], OrderBy[]) |
すべてのインスタンス クラスの共通機能が含まれています |
| InitChildCollection(Urn, Boolean) |
指定した型に関連付けられている子オブジェクト コレクションを初期化します。 たとえば、Column という名前は Columns コレクションを初期化します。 |
| Initialize() |
すべてのインスタンス クラスの共通機能が含まれています |
| Initialize(Boolean) |
列挙子からプロパティを読み取って、オブジェクトを初期化します。 |
| IsCollectionDirty(ICollection) |
すべてのインスタンス クラスの共通機能が含まれています |
| IsExpressSku() |
このオブジェクトを含むサーバーが Express SKU であるかどうかを返します。 |
| IsObjectDirty() |
すべてのインスタンス クラスの共通機能が含まれています |
| IsObjectInitialized() |
すべてのインスタンス クラスの共通機能が含まれています |
| IsObjectInSpace() |
すべてのインスタンス クラスの共通機能が含まれています |
| IsSupportedOnSqlAzure(Type) |
Microsoft Azure SQL Database で smo オブジェクト型がサポートされているかどうかを返します。 |
| IsSupportedProperty(String) |
指定したプロパティが現在のサーバー環境でサポートされているかどうかを検証します |
| IsVersion80SP3() |
すべてのインスタンス クラスの共通機能が含まれています |
| IsVersion90AndAbove() |
すべてのインスタンス クラスの共通機能が含まれています |
| MakeSqlString(String) |
SQL 文字列の一重引用符で囲まれた完全にエスケープされた SQL 文字列を返します。 |
| MarkDropped() |
すべてのインスタンス クラスの共通機能が含まれています |
| MarkForDropImpl(Boolean) |
すべてのインスタンス クラスの共通機能が含まれています |
| PostAlter() |
この関数は、オブジェクトを変更した後に指定アクションを実行する必要がある場合に、派生クラスによってオーバーライドされることを意図しています |
| PostCreate() |
この関数は、オブジェクトの作成後に指定アクションを実行する必要がある場合に、派生クラスによってオーバーライドされることを意図しています |
| PostDrop() |
この関数は、オブジェクトを削除した後に指定アクションを実行する必要がある場合に、派生クラスによってオーバーライドされることを意図しています |
| QuoteString(String, Char, Char) |
区切り記号で囲まれた戻り値の名前。 |
| Refresh() |
オブジェクトのプロパティをサーバーから読み取って更新します。 |
| ScriptImpl() |
すべてのインスタンス クラスの共通機能が含まれています |
| ScriptImpl(ScriptingOptions) |
オブジェクトのスクリプトを含む StringCollection オブジェクトを返します。 ScriptData が true の場合、このメソッドはエラーをスローします |
| SetAccessToken(IRenewableToken) |
接続の accessToken を設定します。 |
| SetParentImpl(SqlSmoObject) |
すべてのインスタンス クラスの共通機能が含まれています |
| SetState(SqlSmoState) |
オブジェクトの状態 (Existing、Dropped など) を設定します。アプリケーションでは、このメソッドの使用を避ける必要があります。 (継承元 SmoObjectBase) |
| SqlDateString(DateTime) |
DateTime を明確な形式の文字列に変換し、サーバーの言語設定に関係なく、T-SQL コードで sql datetime に変換できます。 |
| SqlString(String) |
文字列内のすべての一重引用符をエスケープします。 |
| ThrowIfAboveVersion100(String) |
このオブジェクトの ServerVersion メジャー バージョンが 10.0 を超える場合に例外をスローします (SQL 2008) |
| ThrowIfAboveVersion80(String) |
このオブジェクトの ServerVersion メジャー バージョンが 8.0 (SQL 2000) を超える場合、例外をスローします。 |
| ThrowIfBelowVersion100(String) |
このオブジェクトの ServerVersion メジャー バージョンが 10.0 を下回る場合に例外をスローします (SQL 2008) |
| ThrowIfBelowVersion110(String) |
移行元サーバーまたは移行先サーバーのいずれかが 11.0 を下回る場合に UnsupportedVersionException をスローします (SQL 2012) |
| ThrowIfBelowVersion110Prop(String) |
このオブジェクトの ServerVersion メジャー バージョンが 11.0 を下回っている場合は、指定されたプロパティがサポートされていないというテキストで例外をスローします (SQL 2012) |
| ThrowIfBelowVersion120(String) |
このオブジェクトの ServerVersion メジャー バージョンが 12.0 (SQL 2014) を下回る場合、例外をスローします。 |
| ThrowIfBelowVersion120Prop(String) |
このオブジェクトの ServerVersion メジャー バージョンが 12.0 (SQL 2014) 未満の場合、指定されたプロパティがサポートされていないというテキストで例外をスローします。 |
| ThrowIfBelowVersion130(String) |
このオブジェクトの ServerVersion メジャー バージョンが 13.0 (SQL 2016) を下回る場合、例外をスローします。 |
| ThrowIfBelowVersion130Prop(String) |
このオブジェクトの ServerVersion メジャー バージョンが 13.0 (SQL 2016) 未満の場合、指定されたプロパティがサポートされていないというテキストで例外をスローします |
| ThrowIfBelowVersion140(String) |
このオブジェクトの ServerVersion メジャー バージョンが 14.0 を下回る場合は例外をスローします (SQL 2017) |
| ThrowIfBelowVersion140Prop(String) |
このオブジェクトの ServerVersion メジャー バージョンが 14.0 (SQL 2017) 未満の場合、指定したプロパティがサポートされていないことを示すテキストを含む例外をスローします。 |
| ThrowIfBelowVersion160(String) |
このオブジェクトの ServerVersion メジャー バージョンが 16.0 未満の場合、例外をスローします。 |
| ThrowIfBelowVersion80(String) |
このオブジェクトの ServerVersion メジャー バージョンが 8.0 (SQL 2000) 未満の場合、例外をスローします。 |
| ThrowIfBelowVersion80SP3() |
このオブジェクトの ServerVersion が 8.760 (8.0 SP3) 未満の場合、例外をスローします。 |
| ThrowIfBelowVersion90(String) |
このオブジェクトの ServerVersion メジャー バージョンが 9.0 を下回る場合に例外をスローします (SQL 2005) |
| ToString() |
すべてのインスタンス クラスの共通機能が含まれています |
| Touch() |
Alter の無条件スクリプトのオブジェクトを "touched" としてマークします。 |
| TouchImpl() |
派生クラスがタッチされたときに追加の作業を実行できるようにする仮想メソッド。 |
| Trace(String) |
すべてのインスタンス クラスの共通機能が含まれています |
| UnbindDefaultImpl(Boolean) |
すべてのインスタンス クラスの共通機能が含まれています |
| UnbindRuleImpl(Boolean) |
すべてのインスタンス クラスの共通機能が含まれています |
| UpdateCollectionState2(ICollection) |
すべてのインスタンス クラスの共通機能が含まれています |
| Validate(String, Object[]) |
すべてのインスタンス クラスの共通機能が含まれています (継承元 SmoObjectBase) |
イベント
| 名前 | 説明 |
|---|---|
| PropertyChanged |
すべてのインスタンス クラスの共通機能が含まれています |
| PropertyMetadataChanged |
すべてのインスタンス クラスの共通機能が含まれています |
| PropertyMissing |
オブジェクトの初期化後にプロパティ フェッチが行われ、オブジェクトが値を取得するために SQL クエリを発行する必要がある場合に発生するイベント。 このイベントは同期的に発生するため、イベントのすべてのハンドラーが戻るまでフェッチはブロックされます。 |
明示的なインターフェイスの実装
| 名前 | 説明 |
|---|---|
| IAlienObject.Discover() |
すべてのインスタンス クラスの共通機能が含まれています |
| IAlienObject.GetDomainRoot() |
すべてのインスタンス クラスの共通機能が含まれています |
| IAlienObject.GetParent() |
すべてのインスタンス クラスの共通機能が含まれています |
| IAlienObject.GetPropertyType(String) |
プロパティの種類を検出します。 |
| IAlienObject.GetPropertyValue(String, Type) |
特定のプロパティの値を取得します。 プロパティが見つからない場合にスローします。 |
| IAlienObject.GetUrn() |
すべてのインスタンス クラスの共通機能が含まれています |
| IAlienObject.Resolve(String) |
すべてのインスタンス クラスの共通機能が含まれています |
| IAlienObject.SetObjectState(SfcObjectState) |
指定された SfcObjectState に基づいて、このオブジェクトの状態を設定します。 |
| IAlienObject.SetPropertyValue(String, Type, Object) |
書き込み可能な場合は、指定されたプロパティの値を設定します。 プロパティがプロパティ バッグにない場合は、リフレクションが使用されます。 プロパティが見つからない場合は例外をスローします。 |
| ISfcPropertyProvider.GetPropertySet() |
すべてのインスタンス クラスの共通機能が含まれています |
拡張メソッド
| 名前 | 説明 |
|---|---|
| GetAssessmentItems(SqlSmoObject, String[]) |
特定の |
| GetAssessmentResults(SqlSmoObject, IEnumerable<ICheck>) |
特定の |
| GetAssessmentResults(SqlSmoObject, String[]) |
特定の |
| GetAssessmentResultsList(SqlSmoObject, IEnumerable<ICheck>) |
特定の |
| GetAssessmentResultsList(SqlSmoObject, String[]) |
特定の |
| IsSupportedObject<T>(SqlSmoObject, ScriptingPreferences) |
指定した型がこのオブジェクトのルート サーバーの ServerVersion と DatabaseEngineType でサポートされているかどうかを確認します。 ScriptingPreferences が null 以外の場合は、ターゲット サーバーの ServerVersion と DatabaseEngineType で指定された型がサポートされているかどうかを確認します。 |