LinkedServer Members

  • Article

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

The following tables list the members exposed by the LinkedServer type.

Public Constructors

  Name Description
LinkedServer Overloaded. Initializes a new instance of the LinkedServer object.

Top

Protected Fields

  Name Description
ms219766.protfield(en-US,SQL.90).gif m_ExtendedProperties  (inherited from SqlSmoObject )

Top

Public Properties

(see also Protected Properties )

  Name Description
ms219766.pubproperty(en-US,SQL.90).gif Catalog Gets or sets the database to be used when the linked server is made through a connection to an OLE DB provider. .
ms219766.pubproperty(en-US,SQL.90).gif 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 Microsoft SQL Server.
ms219766.pubproperty(en-US,SQL.90).gif CollationName Gets or sets the name of the collation to use when sorting data from the linked server.
ms219766.pubproperty(en-US,SQL.90).gif ConnectTimeout Gets or sets the number of seconds to wait for a connection to be established with the linked server before timing out.
ms219766.pubproperty(en-US,SQL.90).gif DataAccess Gets or sets the Boolean property value that specifies whether data can be accessed on the linked server.
ms219766.pubproperty(en-US,SQL.90).gif DataSource Gets or sets the data source to be used when the linked server is made through a connection to an OLE DB provider.
ms219766.pubproperty(en-US,SQL.90).gif DateLastModified Gets the date and time when the linked server was last modified.
ms219766.pubproperty(en-US,SQL.90).gif DistPublisher Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
ms219766.pubproperty(en-US,SQL.90).gif Distributor Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.
ms219766.pubproperty(en-US,SQL.90).gif ID Gets the ID value that uniquely identifies the linked server.
ms219766.pubproperty(en-US,SQL.90).gif 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 Microsoft SQL Server is idle or not.
ms219766.pubproperty(en-US,SQL.90).gif LinkedServerLogins Represents a collection of LinkedServerLogin objects. Each LinkedServerLogin object represents a linked server login defined on the linked server.
ms219766.pubproperty(en-US,SQL.90).gif Location Gets or sets the description of the location of the linked server.
ms219766.pubproperty(en-US,SQL.90).gif Name  Gets or sets the name of the object. (inherited from NamedSmoObject)
ms219766.pubproperty(en-US,SQL.90).gif Parent Gets or sets the Server object that is the parent of the LinkedServer object.
ms219766.pubproperty(en-US,SQL.90).gif ProductName Gets or sets the name of the product to which Microsoft SQL Server can connect through the OLE DB Provider.
ms219766.pubproperty(en-US,SQL.90).gif Properties  Gets a collection of Property objects that represent the object properties. (inherited from SqlSmoObject)
ms219766.pubproperty(en-US,SQL.90).gif ProviderName Gets or sets the name of the OLE DB provider used to connect to the linked server.
ms219766.pubproperty(en-US,SQL.90).gif ProviderString Gets or sets the connection string used to connect to a linked server by way of the OLE DB Provider.
ms219766.pubproperty(en-US,SQL.90).gif Publisher Gets or sets a Boolean property value that specifies whether the linked server is a replication Publisher or not.
ms219766.pubproperty(en-US,SQL.90).gif QueryTimeout Gets or sets the time in seconds to wait for a query to execute before timing out.
ms219766.pubproperty(en-US,SQL.90).gif Rpc Gets or sets the Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs).
ms219766.pubproperty(en-US,SQL.90).gif RpcOut The Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs) with output parameters.
ms219766.pubproperty(en-US,SQL.90).gif State  Gets the state of the referenced object. (inherited from SmoObjectBase)
ms219766.pubproperty(en-US,SQL.90).gif Subscriber Gets or sets the Boolean property value that specifies whether the linked server is a replication Subscriber.
ms219766.pubproperty(en-US,SQL.90).gif Urn  Gets the Uniform Resource Name (URN) address value that uniquely identifies the object. (inherited from SqlSmoObject)
ms219766.pubproperty(en-US,SQL.90).gif UserData  Gets or sets user-defined data associated with the referenced object. (inherited from SmoObjectBase)
ms219766.pubproperty(en-US,SQL.90).gif UseRemoteCollation Gets or sets the Boolean property value that specifies whether to use the collation associated with the data from the linked server.

Top

Protected Properties

  Name Description
ms219766.protproperty(en-US,SQL.90).gif ExecuteForScalar  Gets or sets the Boolean property value that specifies whether the object is set to the execute for scalar option. (inherited from SqlSmoObject)
ms219766.protproperty(en-US,SQL.90).gif ObjectInSpace  Gets the Boolean property value that specifies whether the object exists in isolation or whether it is connected to the instance of Microsoft SQL Server directly or indirectly. (inherited from SqlSmoObject)
ms219766.protproperty(en-US,SQL.90).gif PresetProperties  Gets or sets the preset properties of the referenced object. (inherited from SqlSmoObject)
ms219766.protproperty(en-US,SQL.90).gif ScalarResult  Gets the scalar result for the referenced object. (inherited from SqlSmoObject)

Top

Public Methods

(see also Protected Methods )

  Name Description
ms219766.pubmethod(en-US,SQL.90).gif Alter Updates any LinkedServer object property changes on the instance of Microsoft SQL Server.
ms219766.pubmethod(en-US,SQL.90).gif Create Creates a linked server on the instance of Microsoft SQL Server as defined by the LinkedServer object.
ms219766.pubmethod(en-US,SQL.90).gif Drop Overloaded. Removes the reference to the linked server from the instance of Microsoft SQL Server.
ms219766.pubmethod(en-US,SQL.90).gif EnumColumns Overloaded. Enumerates a list of columns that can be accessed on the linked server.
ms219766.pubmethod(en-US,SQL.90).gif EnumTables Overloaded. Enumerates a list of tables that are available on the linked server.
ms219766.pubmethod(en-US,SQL.90).gif Equals  Overloaded. (inherited from Object )
ms219766.pubmethod(en-US,SQL.90).gif GetHashCode  (inherited from Object )
ms219766.pubmethod(en-US,SQL.90).gif GetType  (inherited from Object )
ms219766.pubmethod(en-US,SQL.90).gif Initialize  Overloaded. Initializes the object and forces the properties be loaded. (inherited from SqlSmoObject)
ms219766.pubmethod(en-US,SQL.90).gifms219766.static(en-US,SQL.90).gif ReferenceEquals  (inherited from Object )
ms219766.pubmethod(en-US,SQL.90).gif Refresh  Refreshes the object and retrieves properties when the object is next accessed. (inherited from SqlSmoObject)
ms219766.pubmethod(en-US,SQL.90).gif Script Overloaded. Generates a Transact-SQL script that can be used to re-create the linked server registration.
ms219766.pubmethod(en-US,SQL.90).gif ToString  Returns a String that represents the referenced object. (inherited from SqlSmoObject)

Top

Protected Methods

  Name Description
ms219766.protmethod(en-US,SQL.90).gif AlterImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif AlterImplFinish  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif AlterImplInit  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif AlterImplWorker  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif BindDefaultImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif BindRuleImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CheckCollation  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CheckObjectState  Overloaded. Validates the state of the referenced object. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif CheckObjectStateImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CheckVersion80  Checks the validity of the object on Microsoft SQL Server 2000. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif CheckVersion80SP3  Checks the validity of the object on Microsoft SQL Server 2000 SP3. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif CheckVersion90  Check the validity of the object on Microsoft SQL Server 2005. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif CheckVersionBelow90  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CleanObject  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CreateImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CreateImplFinish  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif CreateImplInit  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif DropImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif DropImplWorker  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif Finalize  (inherited from Object )
ms219766.protmethod(en-US,SQL.90).gif FormatSqlVariant  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GenerateDataSpaceScript  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetBindDefaultScript  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetBindRuleScript  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetBoolParameter  Overloaded. (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetDateTimeParameter  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetDateTimeParameterAsInt  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetDBName  Gets the database name associated with the object. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif GetEnumParameter  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetFragOptionString  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetGuidParameter  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetParameter  Overloaded. (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetPropValue  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetPropValueOptional  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetPropValueOptionalAllowNull  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetRealValue  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetScriptingOptionsForCreate  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetServerName  Gets the name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif GetSqlServerVersionName  Gets the version name of the instance of Microsoft SQL Server with which the object is associated. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif GetStringParameter  Overloaded. (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetTimeSpanParameterAsInt  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif GetUrnRecursive  Overloaded. (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ImplInitialize  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gifms219766.static(en-US,SQL.90).gif IsCollectionDirty  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif IsObjectDirty  Verifies whether the object properties have been modified and the changes have not yet been persisted on the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif IsObjectInitialized  Verifies whether the object has been initialized. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif IsObjectInSpace  Verifies whether the object is isolated or connected to the instance of Microsoft SQL Server. (inherited from SqlSmoObject)
ms219766.protmethod(en-US,SQL.90).gif IsVersion80SP3  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif MarkDropped  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif MarkForDropImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif MemberwiseClone  (inherited from Object )
ms219766.protmethod(en-US,SQL.90).gif PostAlter  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif PostCreate  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif PostDrop  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif RenameImpl  (inherited from NamedSmoObject )
ms219766.protmethod(en-US,SQL.90).gif RenameImplWorker  (inherited from NamedSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptAlter  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptChangeOwner  (inherited from NamedSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptCreate  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptDdl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptDrop  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptImpl  Overloaded. (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptImplWorker  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif ScriptRename  (inherited from NamedSmoObject )
ms219766.protmethod(en-US,SQL.90).gif SetParentImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gifms219766.static(en-US,SQL.90).gif Trace  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif UnbindDefaultImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gif UnbindRuleImpl  (inherited from SqlSmoObject )
ms219766.protmethod(en-US,SQL.90).gifms219766.static(en-US,SQL.90).gif UpdateCollectionState2  (inherited from SqlSmoObject )

Top

See Also

Reference

LinkedServer Class
Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Using Linked Servers in SMO
Linking Servers
sp_addlinkedserver (Transact-SQL)