LinkedServer Class

  • Article

A LinkedServer object represents a database system other than SQL Server and is linked to the current instance of SQL Server by using an OLE DB driver.

Inheritance Hierarchy

System.Object
  Microsoft.SqlServer.Management.Smo.SmoObjectBase
    Microsoft.SqlServer.Management.Smo.SqlSmoObject
      Microsoft.SqlServer.Management.Smo.NamedSmoObject
        Microsoft.SqlServer.Management.Smo.LinkedServer

Namespace:  Microsoft.SqlServer.Management.Smo
Assembly:  Microsoft.SqlServer.Smo (in Microsoft.SqlServer.Smo.dll)

Syntax

'Declaration
<PhysicalFacetAttribute> _
<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)> _
Public NotInheritable Class LinkedServer _
    Inherits NamedSmoObject _
    Implements ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable,  _
    IScriptable
'Usage
Dim instance As LinkedServer

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)]
public sealed class LinkedServer : NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

[PhysicalFacetAttribute]
[EvaluationModeAttribute(AutomatedPolicyEvaluationMode::CheckOnSchedule)]
public ref class LinkedServer sealed : public NamedSmoObject, 
    ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

[<SealedAttribute>]
[<PhysicalFacetAttribute>]
[<EvaluationModeAttribute(AutomatedPolicyEvaluationMode.CheckOnSchedule)>]
type LinkedServer =  
    class 
        inherit NamedSmoObject 
        interface ISfcSupportsDesignMode 
        interface ICreatable 
        interface IDroppable 
        interface IAlterable 
        interface IScriptable 
    end

public final class LinkedServer extends NamedSmoObject implements ISfcSupportsDesignMode, ICreatable, IDroppable, IAlterable, IScriptable

The LinkedServer type exposes the following members.

Constructors

  Name Description
Public method LinkedServer() Initializes a new instance of the LinkedServer object.
Public method LinkedServer(Server, String) Initializes a new instance of the LinkedServer object on the specified instance of SQL Server and with the specified name.

Top

Properties

  Name Description
Public property Catalog Gets or sets the database to be used when the linked server is made through a connection to an OLE DB provider.
Public property CollationCompatible Gets or sets the Boolean property value that specifies whether the default collation of the linked server is compatible with the default collation on the local instance of SQL Server.
Public property CollationName Gets or sets the name of the collation to use when sorting data from the linked server.
Public property ConnectTimeout Gets or sets the number of seconds to wait for a connection to be established with the linked server before timing out.
Public property DataAccess Gets or sets the Boolean property value that specifies whether data can be accessed on the linked server.
Public property DataSource Gets or sets the data source to be used when the linked server is made through a connection to an OLE DB provider.
Public property DateLastModified Gets the date and time when the linked server was last modified.
Public property DistPublisher Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
Public property Distributor Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
Public property ID Gets the ID value that uniquely identifies the linked server.
Public property IsPromotionofDistributedTransactionsForRPCEnabled Gets or sets a Boolean property value that specifies whether the promotion of distributed transaction for RPC (remote procedure calls) is enabled.
Public property LazySchemaValidation Gets or sets the Boolean property value that specifies whether the schema used by the linked server data is validated when the local instance of SQL Server is idle or not.
Public property LinkedServerLogins Represents a collection of LinkedServerLogin objects. Each LinkedServerLogin object represents a linked server login defined on the linked server.
Public property Location Gets or sets the description of the location of the linked server.
Public property Name Gets or sets a String which contains the name of the LinkedServer. (Overrides NamedSmoObject.Name.)
Public property Parent Gets or sets the Server object that is the parent of the LinkedServer object.
Public property ProductName Gets or sets the name of the product to which SQL Server can connect through the OLE DB Provider.
Public property Properties Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
Public property ProviderName Gets or sets the name of the OLE DB provider used to connect to the linked server.
Public property ProviderString Gets or sets the connection string used to connect to a linked server by way of the OLE DB Provider.
Public property Publisher Gets or sets a Boolean property value that specifies whether the linked server is a replication Publisher or not.
Public property QueryTimeout Gets or sets the time in seconds to wait for a query to execute before timing out.
Public property Rpc Gets or sets the Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs).
Public property RpcOut The Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs) with output parameters.
Public property State Gets the state of the referenced object. (Inherited from SmoObjectBase.)
Public property Subscriber Gets or sets the Boolean property value that specifies whether the linked server is a replication Subscriber.
Public property Urn Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
Public property UserData Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
Public property UseRemoteCollation Gets or sets the Boolean property value that specifies whether to use the collation that is associated with the data from the linked server.

Top

Methods

  Name Description
Public method Alter Updates any LinkedServer object property changes on the instance of SQL Server. 
Public method Create Creates a linked server on the instance of SQL Server as defined by the LinkedServer object.
Public method Discover Discovers a list of type Object. (Inherited from SqlSmoObject.)
Public method Drop() Removes the reference to the linked server from the instance of SQL Server.
Public method Drop(Boolean) Removes the reference to the linked server from the instance of SQL Server.
Public method EnumColumns() Enumerates a list of columns that can be accessed on the linked server.
Public method EnumColumns(String) Enumerates a list of columns that can be accessed on the linked server for a specified table.
Public method EnumColumns(String, String) Enumerates a list of columns that can be accessed on the linked server for a specified table and schema.
Public method EnumColumns(String, String, String) Enumerates a list of columns that can be accessed on the linked server for a specified table, schema, and database.
Public method EnumColumns(String, String, String, String) Enumerates a list of columns that can be accessed on the linked server for a specified column.
Public method EnumTables() Enumerates a list of tables that are available on the linked server.
Public method EnumTables(String) Enumerates a list of tables that are available on the linked server for a specified table name.
Public method EnumTables(String, String) Enumerates a list of tables that are available on the linked server for a specified table name and schema.
Public method EnumTables(String, String, String) Enumerates a list of tables that are available on the linked server for a specified table name, schema, and database.
Public method EnumTables(String, String, String, LinkedTableType) Enumerates a list of tables that are available on the linked server for a specified table name, schema, database, and linked table type.
Public method Equals (Inherited from Object.)
Protected method FormatSqlVariant Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
Protected method GetContextDB Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
Protected method GetDBName Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
Public method GetHashCode (Inherited from Object.)
Protected method GetPropValue Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptional Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetPropValueOptionalAllowNull Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Protected method GetServerObject Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
Public method GetType (Inherited from Object.)
Public method Initialize() Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Public method Initialize(Boolean) Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
Protected method IsObjectInitialized Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
Protected method IsObjectInSpace Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
Public method Refresh Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
Public method Script() Generates a Transact-SQL script that can be used to re-create the linked server registration.
Public method Script(ScriptingOptions) Generates a Transact-SQL script that can be used to re-create the linked server registration as specified by the script options.
Protected method SetParentImpl Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
Public method TestConnection Tests the connection to a linked server.
Public method ToString Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
Public method Validate Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

  Name Description
Public event PropertyChanged Represents the event that occurs when a property is changed. (Inherited from SqlSmoObject.)
Public event PropertyMetadataChanged Represents the event that occurs when property metadata changes. (Inherited from SqlSmoObject.)

Top

Explicit Interface Implementations

  Name Description
Explicit interface implemetationPrivate method IAlienObject.Discover Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetDomainRoot Returns the root of the domain. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetParent Gets the parent of this object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyType Gets the type of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetPropertyValue Gets the value of the specified property. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.GetUrn Gets the Unified Resource Name (URN) of the object. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.Resolve Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetObjectState Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method IAlienObject.SetPropertyValue Sets the property value. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate method ISfcPropertyProvider.GetPropertySet Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
Explicit interface implemetationPrivate property ISfcSupportsDesignMode.IsDesignMode Gets or sets the Boolean property value that specifies whether the schema used by the linked server data is validated when the local instance of SQL Server is idle or not.

Top

Remarks

To get LinkedServer object properties, users can be a member of the public fixed server role.

To set LinkedServer object properties, users must have ALTER ANY LINKED SERVER permission on the server or be a member of the sysadmin fixed server role.

To create or drop a linked server, users must have ALTER ANY LINKED SERVER permission on the server or be a member of the sysadmin fixed server role.

To enumerate tables or columns on the linked server, users must have SELECT permission on the schema.

Thread Safety

Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.  

Examples

Using Linked Servers in SMO

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

See Also

Reference

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Linked Servers (Database Engine)

sp_addlinkedserver (Transact-SQL)