Synonym クラス

Synonym オブジェクトは、SQL Server シノニムを表します。

継承階層

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.ScriptNameObjectBase
          Microsoft.SqlServer.Management.Smo.ScriptSchemaObjectBase
            Microsoft.SqlServer.Management.Smo.Synonym

名前空間:  Microsoft.SqlServer.Management.Smo
アセンブリ:  Microsoft.SqlServer.Smo (Microsoft.SqlServer.Smo.dll)

構文

'宣言
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
<PhysicalFacetAttribute> _
Public NotInheritable Class Synonym _
    Inherits ScriptSchemaObjectBase _
    Implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable,  _
    IExtendedProperties, IScriptable, IAlterable
'使用
Dim instance As Synonym
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
[PhysicalFacetAttribute]
public sealed class Synonym : ScriptSchemaObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
    IScriptable, IAlterable
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
[PhysicalFacetAttribute]
public ref class Synonym sealed : public ScriptSchemaObjectBase, 
    ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, 
    IScriptable, IAlterable
[<SealedAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
[<PhysicalFacetAttribute>]
type Synonym =  
    class 
        inherit ScriptSchemaObjectBase 
        interface ISfcSupportsDesignMode 
        interface IObjectPermission 
        interface ICreatable 
        interface IDroppable 
        interface IExtendedProperties 
        interface IScriptable 
        interface IAlterable 
    end
public final class Synonym extends ScriptSchemaObjectBase implements ISfcSupportsDesignMode, IObjectPermission, ICreatable, IDroppable, IExtendedProperties, IScriptable, IAlterable

Synonym 型は、以下のメンバーを公開しています。

コンストラクター

  名前 説明
パブリック メソッド Synonym() Synonym クラスの新しいインスタンスを初期化します。
パブリック メソッド Synonym(Database, String) 指定したデータベースで、指定した名前を使用して Synonym クラスの新しいインスタンスを初期化します。
パブリック メソッド Synonym(Database, String, String) 指定したデータベースで、指定した名前とスキーマを使用して Synonym クラスの新しいインスタンスを初期化します。
パブリック メソッド Synonym(Database, String, String, String, String, String) 指定したデータベースで、指定した名前とベース オブジェクトを使用して Synonym クラスの新しいインスタンスを初期化します。
パブリック メソッド Synonym(Database, String, String, String, String, String, String) 指定したデータベースで、指定した名前、スキーマ、およびベース オブジェクトを使用して、Synonym クラスの新しいインスタンスを初期化します。

先頭に戻る

プロパティ

  名前 説明
パブリック プロパティ BaseDatabase ベース オブジェクトが存在するベース データベースを取得します。値の設定も可能です。
パブリック プロパティ BaseObject シノニムが定義されたベース オブジェクトを取得します。値の設定も可能です。
パブリック プロパティ BaseSchema ベース オブジェクトのスキーマを取得します。値の設定も可能です。
パブリック プロパティ BaseServer ベース オブジェクトが存在する SQL Server のインスタンスを取得します。値の設定も可能です。
パブリック プロパティ BaseType Synonym オブジェクトの種類を指定します。
パブリック プロパティ CreateDate シノニムが作成された日時を取得します。
パブリック プロパティ DateLastModified シノニムが最後に変更された日時を取得します。
パブリック プロパティ Events シノニムによってサポートされるイベントを取得します。
パブリック プロパティ ExtendedProperties Synonym オブジェクトの拡張プロパティに関する情報を含む ExtendedProperty オブジェクトのコレクションを表します。
パブリック プロパティ ID シノニムを一意に識別する ID 値を取得します。
パブリック プロパティ IsSchemaOwned Synonym オブジェクトがスキーマによって所有されているかどうかを示す Boolean 値を取得します。
パブリック プロパティ Name シノニムの名前を示す String 値を取得します。値の設定も可能です。 (ScriptSchemaObjectBase.Name をオーバーライドします。)
パブリック プロパティ Owner Synonym の所有者を取得します。値の設定も可能です
パブリック プロパティ Parent Synonym オブジェクトの親である Database オブジェクトを取得します。
パブリック プロパティ Properties オブジェクトのプロパティを表す Property オブジェクトのコレクションを取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ Schema シノニムを含むスキーマの名前を示す String 値を取得します。値の設定も可能です。 (ScriptSchemaObjectBase.Schema をオーバーライドします。)
パブリック プロパティ State 参照先のオブジェクトの状態を取得します。 (SmoObjectBase から継承されています。)
パブリック プロパティ Urn オブジェクトを一意に識別する URN (Uniform Resource Name) アドレスの値を取得します。 (SqlSmoObject から継承されています。)
パブリック プロパティ UserData 参照先のオブジェクトに関連付けられたユーザー定義データを取得します。値の設定も可能です。 (SmoObjectBase から継承されています。)

先頭に戻る

メソッド

  名前 説明
パブリック メソッド Alter SQL Server のインスタンスの Synonym オブジェクトのプロパティに対する変更をすべて更新します。
パブリック メソッド Create SQL Server のインスタンスで、Synonym オブジェクトの定義に基づいてシノニムを作成します。
パブリック メソッド Deny(ObjectPermissionSet, String) 特定のシノニムについて、指定した権限付与対象ユーザーが指定した権限セットにアクセスするのを拒否します。
パブリック メソッド Deny(ObjectPermissionSet, array<String[]) 特定のシノニムについて、指定した複数の権限付与対象ユーザーが指定した権限セットにアクセスするのを拒否します。
パブリック メソッド Deny(ObjectPermissionSet, String, Boolean) シノニムの指定した権限付与対象ユーザーと、指定した権限セットをその権限付与対象ユーザーから許可された他のユーザーに対し、指定した権限セットを拒否します。
パブリック メソッド Deny(ObjectPermissionSet, array<String[], Boolean) シノニムの指定した権限付与対象ユーザーと、指定した権限セットをその権限付与対象ユーザーから許可された他のユーザーに対し、指定した権限セットを拒否します。
パブリック メソッド Discover Object 型の一覧を検出します。 (SqlSmoObject から継承されています。)
パブリック メソッド Drop SQL Server のインスタンスからシノニムを削除します。
パブリック メソッド EnumObjectPermissions() シノニムに対するオブジェクト権限の一覧を列挙します。
パブリック メソッド EnumObjectPermissions(String) シノニムの指定した権限付与対象ユーザーに対するオブジェクト権限の一覧を列挙します。
パブリック メソッド EnumObjectPermissions(ObjectPermissionSet) シノニムの指定した権限に対するオブジェクト権限の一覧を列挙します。
パブリック メソッド EnumObjectPermissions(String, ObjectPermissionSet) 特定のシノニムについて、指定した権限付与対象ユーザーと指定した権限に対するオブジェクト権限の一覧を列挙します。
パブリック メソッド Equals (Object から継承されています。)
プロテクト メソッド FormatSqlVariant SqlVariant 型としてオブジェクトの書式を設定します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetContextDB このオブジェクトに関連付けられているコンテキスト データベースを取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetDBName オブジェクトに関連付けられたデータベース名を取得します。 (SqlSmoObject から継承されています。)
パブリック メソッド GetHashCode (Object から継承されています。)
プロテクト メソッド GetPropValue SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetPropValueOptional SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetPropValueOptionalAllowNull SqlSmoObject オブジェクトのプロパティの値を取得します。 (SqlSmoObject から継承されています。)
プロテクト メソッド GetServerObject SqlSmoObject オブジェクトのサーバーを取得します。 (SqlSmoObject から継承されています。)
パブリック メソッド GetType (Object から継承されています。)
パブリック メソッド Grant(ObjectPermissionSet, String) 特定のシノニムについて、指定した権限付与対象ユーザーが指定した権限セットにアクセスするのを許可します。
パブリック メソッド Grant(ObjectPermissionSet, array<String[]) 特定のシノニムについて、指定した複数の権限付与対象ユーザーが指定した権限セットにアクセスするのを許可します。
パブリック メソッド Grant(ObjectPermissionSet, String, Boolean) 権限付与対象ユーザーに対し、指定した権限へのアクセスと、アクセスをシノニムの他のユーザーに許可する権限を与えます。
パブリック メソッド Grant(ObjectPermissionSet, array<String[], Boolean) 権限付与対象ユーザーに対し、指定した権限へのアクセスと、アクセスをシノニムの他のユーザーに許可する権限を許可します。
パブリック メソッド Grant(ObjectPermissionSet, String, Boolean, String) 特定のシノニムについて、指定した権限セットを権限付与対象ユーザーに許可します。さらに、その権限付与対象ユーザーに対し、与えられているロールに基づいて、権限セットを他のユーザーに許可する権限を与えます。
パブリック メソッド Grant(ObjectPermissionSet, array<String[], Boolean, String) 特定のシノニムについて、指定した権限セットを権限付与対象ユーザーに許可します。さらに、その権限付与対象ユーザーに対し、与えられているロールに基づいて、権限セットを他のユーザーに許可する権限を与えます。
パブリック メソッド Initialize() オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。)
パブリック メソッド Initialize(Boolean) オブジェクトを初期化し、プロパティを強制的に読み込ませます。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsObjectInitialized オブジェクトが初期化されたかどうかを確認します。 (SqlSmoObject から継承されています。)
プロテクト メソッド IsObjectInSpace オブジェクトが孤立しているか、または SQL Server のインスタンスに接続されているかを確認します。 (SqlSmoObject から継承されています。)
パブリック メソッド Refresh スクリプト名を更新します。 (ScriptNameObjectBase から継承されています。)
パブリック メソッド Revoke(ObjectPermissionSet, String) シノニムの権限付与対象ユーザーから、以前に許可した権限セットを取り消します。
パブリック メソッド Revoke(ObjectPermissionSet, array<String[]) シノニムの権限付与対象ユーザーの一覧から、以前に許可した権限セットを取り消します。
パブリック メソッド Revoke(ObjectPermissionSet, String, Boolean, Boolean) シノニムの権限付与対象ユーザーと、指定した権限セットをその権限付与対象ユーザーから許可された他のすべてのユーザーについて、以前に許可した権限を取り消します。権限が与えられているユーザーは、想定したロールに基づいて、他のユーザーから特定の権限のセットを取り消すこともできます。
パブリック メソッド Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean) シノニムの権限付与対象ユーザーと、その権限付与対象ユーザーから指定した権限セットを許可された他のすべてのユーザーについて、以前に許可した権限を取り消します。また、権限付与対象ユーザーに対し、想定したロールに基づいて指定した権限のセットを他のユーザーから取り消す権限を許可します。
パブリック メソッド Revoke(ObjectPermissionSet, String, Boolean, Boolean, String) シノニムの権限付与対象ユーザーと、指定した権限セットをその権限付与対象ユーザーから許可された他のすべてのユーザーについて、以前に許可した権限を取り消します。権限が与えられているユーザーは、想定したロールに基づいて、他のユーザーから特定の権限のセットを取り消すこともできます。
パブリック メソッド Revoke(ObjectPermissionSet, array<String[], Boolean, Boolean, String) シノニムの権限付与対象ユーザーと、その権限付与対象ユーザーから指定した権限セットを許可された他のすべてのユーザーについて、以前に許可した権限を取り消します。また、権限付与対象ユーザーに対し、想定したロールに基づいて指定した権限のセットを他のユーザーから取り消す権限を許可します。
パブリック メソッド Script() シノニムの再作成に使用できる Transact-SQL スクリプトを生成します。
パブリック メソッド Script(ScriptingOptions) スクリプト オプションで指定したとおりにシノニムを再作成するために使用できる Transact-SQL スクリプトを生成します。
プロテクト メソッド SetParentImpl SqlSmoObject の親を newParent パラメーターに設定します。 (SqlSmoObject から継承されています。)
パブリック メソッド ToString 参照するオブジェクトを表す String を返します。 (SqlSmoObject から継承されています。)
パブリック メソッド Validate オブジェクトの状態を検証します。 (SmoObjectBase から継承されています。)

先頭に戻る

イベント

  名前 説明
パブリック イベント PropertyChanged プロパティが変更されるときに発生するイベントを表します。 (SqlSmoObject から継承されています。)
パブリック イベント PropertyMetadataChanged プロパティ メタデータが変更されたときに発生するイベントを表します。 (SqlSmoObject から継承されています。)

先頭に戻る

明示的なインターフェイスの実装

  名前 説明
明示的なインターフェイスの実装プライベート メソッド IAlienObject.Discover 依存関係を検出します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.GetDomainRoot ドメインのルートを返します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.GetParent このオブジェクトの親を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.GetPropertyType 指定したプロパティの種類を取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.GetPropertyValue 指定されたプロパティの値を取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.GetUrn オブジェクトの Unified Resource Name (URN) を取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.Resolve オブジェクトに関する情報を含むインスタンスを、オブジェクトの Unified Resource Name (URN) から取得します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.SetObjectState オブジェクトの状態を、指定した SfcObjectState 値に設定します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド IAlienObject.SetPropertyValue プロパティの値を設定します。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート メソッド ISfcPropertyProvider.GetPropertySet このオブジェクトのプロパティ セットへのインターフェイス リファレンスを取得します。このメンバーをコード内で直接参照しないでください。このメンバーは、SQL Server インフラストラクチャをサポートしています。 (SqlSmoObject から継承されています。)
明示的なインターフェイスの実装プライベート プロパティ ISfcSupportsDesignMode.IsDesignMode シノニムがデザイン モードをサポートしているかどうかを示す Boolean 値を取得します。

先頭に戻る

説明

Synonym オブジェクトを使用して、プログラムからシノニムへアクセスします。 シノニムを使用すれば、SQL Server オブジェクトの代替名を作成できます。

使用例

'Connect to the local, default instance of SQL Server.
Dim srv As Server
srv = New Server()
'Reference the AdventureWorks2012 2008R2 database.
Dim db As Database
db = srv.Databases("AdventureWorks2012")
'Define a Synonym object variable by supplying the parent database, name, and schema arguments in the constructor.
'The name is also a synonym of the name of the base object.
Dim syn As Synonym
syn = New Synonym(db, "Shop", "Sales")
'Specify the base object, which is the object on which the synonym is based.
syn.BaseDatabase = "AdventureWorks2012"
syn.BaseSchema = "Sales"
syn.BaseObject = "Store"
syn.BaseServer = srv.Name
'Create the synonym on the instance of SQL Server.
syn.Create()

スレッド セーフ

この型の public static (Visual Basic では Shared) のメンバーはすべて、スレッド セーフです。インスタンス メンバーの場合は、スレッド セーフであるとは限りません。

関連項目

参照

Microsoft.SqlServer.Management.Smo 名前空間

その他の技術情報

シノニムの使用

シノニムの使用 (データベース エンジン)

CREATE SYNONYM (Transact-SQL)