LinkedServer Class

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
	LinkedServer()	Initializes a new instance of the LinkedServer object.
	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
	Catalog	Gets or sets the database to be used when the linked server is made through a connection to an OLE DB provider.
	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.
	CollationName	Gets or sets the name of the collation to use when sorting data from the linked server.
	ConnectTimeout	Gets or sets the number of seconds to wait for a connection to be established with the linked server before timing out.
	DataAccess	Gets or sets the Boolean property value that specifies whether data can be accessed on the linked server.
	DataSource	Gets or sets the data source to be used when the linked server is made through a connection to an OLE DB provider.
	DateLastModified	Gets the date and time when the linked server was last modified.
	DistPublisher	Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
	Distributor	Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
	ID	Gets the ID value that uniquely identifies the linked server.
	IsPromotionofDistributedTransactionsForRPCEnabled	Gets or sets a Boolean property value that specifies whether the promotion of distributed transaction for RPC (remote procedure calls) is enabled.
	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.
	LinkedServerLogins	Represents a collection of LinkedServerLogin objects. Each LinkedServerLogin object represents a linked server login defined on the linked server.
	Location	Gets or sets the description of the location of the linked server.
	Name	Gets or sets a String which contains the name of the LinkedServer. (Overrides NamedSmoObject.Name.)
	Parent	Gets or sets the Server object that is the parent of the LinkedServer object.
	ProductName	Gets or sets the name of the product to which SQL Server can connect through the OLE DB Provider.
	Properties	Gets a collection of Property objects that represent the object properties. (Inherited from SqlSmoObject.)
	ProviderName	Gets or sets the name of the OLE DB provider used to connect to the linked server.
	ProviderString	Gets or sets the connection string used to connect to a linked server by way of the OLE DB Provider.
	Publisher	Gets or sets a Boolean property value that specifies whether the linked server is a replication Publisher or not.
	QueryTimeout	Gets or sets the time in seconds to wait for a query to execute before timing out.
	Rpc	Gets or sets the Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs).
	RpcOut	The Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs) with output parameters.
	State	Gets the state of the referenced object. (Inherited from SmoObjectBase.)
	Subscriber	Gets or sets the Boolean property value that specifies whether the linked server is a replication Subscriber.
	Urn	Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (Inherited from SqlSmoObject.)
	UserData	Gets or sets user-defined data associated with the referenced object. (Inherited from SmoObjectBase.)
	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
	Alter	Updates any LinkedServer object property changes on the instance of SQL Server.
	Create	Creates a linked server on the instance of SQL Server as defined by the LinkedServer object.
	Discover	Discovers a list of type Object. (Inherited from SqlSmoObject.)
	Drop()	Removes the reference to the linked server from the instance of SQL Server.
	Drop(Boolean)	Removes the reference to the linked server from the instance of SQL Server.
	EnumColumns()	Enumerates a list of columns that can be accessed on the linked server.
	EnumColumns(String)	Enumerates a list of columns that can be accessed on the linked server for a specified table.
	EnumColumns(String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified table and schema.
	EnumColumns(String, String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified table, schema, and database.
	EnumColumns(String, String, String, String)	Enumerates a list of columns that can be accessed on the linked server for a specified column.
	EnumTables()	Enumerates a list of tables that are available on the linked server.
	EnumTables(String)	Enumerates a list of tables that are available on the linked server for a specified table name.
	EnumTables(String, String)	Enumerates a list of tables that are available on the linked server for a specified table name and schema.
	EnumTables(String, String, String)	Enumerates a list of tables that are available on the linked server for a specified table name, schema, and database.
	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.
	Equals	(Inherited from Object.)
	FormatSqlVariant	Formats an object as SqlVariant type. (Inherited from SqlSmoObject.)
	GetContextDB	Gets the context database that is associated with this object. (Inherited from SqlSmoObject.)
	GetDBName	Gets the database name that is associated with the object. (Inherited from SqlSmoObject.)
	GetHashCode	(Inherited from Object.)
	GetPropValue	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptional	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetPropValueOptionalAllowNull	Gets a property value of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetServerObject	Gets the server of the SqlSmoObject object. (Inherited from SqlSmoObject.)
	GetType	(Inherited from Object.)
	Initialize()	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	Initialize(Boolean)	Initializes the object and forces the properties be loaded. (Inherited from SqlSmoObject.)
	IsObjectInitialized	Verifies whether the object has been initialized. (Inherited from SqlSmoObject.)
	IsObjectInSpace	Verifies whether the object is isolated or connected to the instance of SQL Server. (Inherited from SqlSmoObject.)
	Refresh	Refreshes the object and retrieves properties when the object is next accessed. (Inherited from SqlSmoObject.)
	Script()	Generates a Transact-SQL script that can be used to re-create the linked server registration.
	Script(ScriptingOptions)	Generates a Transact-SQL script that can be used to re-create the linked server registration as specified by the script options.
	SetParentImpl	Sets the parent of the SqlSmoObject to the newParent parameter. (Inherited from SqlSmoObject.)
	TestConnection	Tests the connection to a linked server.
	ToString	Returns a String that represents the referenced object. (Inherited from SqlSmoObject.)
	Validate	Validates the state of an object. (Inherited from SmoObjectBase.)

Top

Events

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

Top

Explicit Interface Implementations

	Name	Description
	IAlienObject.Discover	Discovers any dependencies. Do not reference this member directly in your code. It supports the SQL Server infrastructure. (Inherited from SqlSmoObject.)
	IAlienObject.GetDomainRoot	Returns the root of the domain. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.GetPropertyType	Gets the type of the specified property. (Inherited from SqlSmoObject.)
	IAlienObject.GetPropertyValue	Gets the value of the specified property. (Inherited from SqlSmoObject.)
	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.)
	IAlienObject.Resolve	Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object. (Inherited from SqlSmoObject.)
	IAlienObject.SetObjectState	Sets the object state to the specified SfcObjectState value. (Inherited from SqlSmoObject.)
	IAlienObject.SetPropertyValue	Sets the property value. (Inherited from SqlSmoObject.)
	ISfcPropertyProvider.GetPropertySet	Gets the interface reference to the set of properties of this object. (Inherited from SqlSmoObject.)
	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)