TechNet
Export (0) Print
Expand All

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.

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


No code example is currently available or this language may not be supported.

NameDescription
System_CAPS_pubmethodLinkedServer()

Initializes a new instance of the LinkedServer object.

System_CAPS_pubmethodLinkedServer(Server, String)

Initializes a new instance of the LinkedServer object on the specified instance of SQL Server and with the specified name.

NameDescription
System_CAPS_pubpropertyCatalog

Gets or sets the database to be used when the linked server is made through a connection to an OLE DB provider.

System_CAPS_pubpropertyCollationCompatible

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.

System_CAPS_pubpropertyCollationName

Gets or sets the name of the collation to use when sorting data from the linked server.

System_CAPS_pubpropertyConnectTimeout

Gets or sets the number of seconds to wait for a connection to be established with the linked server before timing out.

System_CAPS_pubpropertyDataAccess

Gets or sets the Boolean property value that specifies whether data can be accessed on the linked server.

System_CAPS_pubpropertyDataSource

Gets or sets the data source to be used when the linked server is made through a connection to an OLE DB provider.

System_CAPS_pubpropertyDateLastModified

Gets the date and time when the linked server was last modified.

System_CAPS_pubpropertyDistPublisher

Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.

System_CAPS_pubpropertyDistributor

Gets or sets a Boolean property value that specifies whether the linked server is participating in replication as a distribution Publisher.

System_CAPS_pubpropertyExecutionManager

(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyID

Gets the ID value that uniquely identifies the linked server.

System_CAPS_pubpropertyIsPromotionofDistributedTransactionsForRPCEnabled

Gets or sets a Boolean property value that specifies whether the promotion of distributed transaction for RPC (remote procedure calls) is enabled.

System_CAPS_pubpropertyLazySchemaValidation

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.

System_CAPS_pubpropertyLinkedServerLogins

Represents a collection of LinkedServerLogin objects. Each LinkedServerLogin object represents a linked server login defined on the linked server.

System_CAPS_pubpropertyLocation

Gets or sets the description of the location of the linked server.

System_CAPS_pubpropertyName

Gets or sets a String which contains the name of the LinkedServer.(Overrides NamedSmoObject.Name.)

System_CAPS_pubpropertyParent

Gets or sets the Server object that is the parent of the LinkedServer object.

System_CAPS_pubpropertyProductName

Gets or sets the name of the product to which SQL Server can connect through the OLE DB Provider.

System_CAPS_pubpropertyProperties

Gets a collection of Property objects that represent the object properties.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyProviderName

Gets or sets the name of the OLE DB provider used to connect to the linked server.

System_CAPS_pubpropertyProviderString

Gets or sets the connection string used to connect to a linked server by way of the OLE DB Provider.

System_CAPS_pubpropertyPublisher

Gets or sets a Boolean property value that specifies whether the linked server is a replication Publisher or not.

System_CAPS_pubpropertyQueryTimeout

Gets or sets the time in seconds to wait for a query to execute before timing out.

System_CAPS_pubpropertyRpc

Gets or sets the Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs).

System_CAPS_pubpropertyRpcOut

The Boolean property value that specifies whether the linked server supports remote procedure calls (RPCs) with output parameters.

System_CAPS_pubpropertyState

Gets the state of the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertySubscriber

Gets or sets the Boolean property value that specifies whether the linked server is a replication Subscriber.

System_CAPS_pubpropertyUrn

Gets the Uniform Resource Name (URN) address value that uniquely identifies the object.(Inherited from SqlSmoObject.)

System_CAPS_pubpropertyUserData

Gets or sets user-defined data associated with the referenced object.(Inherited from SmoObjectBase.)

System_CAPS_pubpropertyUseRemoteCollation

Gets or sets the Boolean property value that specifies whether to use the collation that is associated with the data from the linked server.

NameDescription
System_CAPS_pubmethodAlter()

Updates any LinkedServer object property changes on the instance of SQL Server. 

System_CAPS_pubmethodCreate()

Creates a linked server on the instance of SQL Server as defined by the LinkedServer object.

System_CAPS_pubmethodDiscover()

Discovers a list of type Object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodDrop()

Removes the reference to the linked server from the instance of SQL Server.

System_CAPS_pubmethodDrop(Boolean)

Removes the reference to the linked server from the instance of SQL Server.

System_CAPS_pubmethodDropIfExists()

System_CAPS_pubmethodDropIfExists(Boolean)

System_CAPS_pubmethodEnumColumns()

Enumerates a list of columns that can be accessed on the linked server.

System_CAPS_pubmethodEnumColumns(String)

Enumerates a list of columns that can be accessed on the linked server for a specified table.

System_CAPS_pubmethodEnumColumns(String, String)

Enumerates a list of columns that can be accessed on the linked server for a specified table and schema.

System_CAPS_pubmethodEnumColumns(String, String, String)

Enumerates a list of columns that can be accessed on the linked server for a specified table, schema, and database.

System_CAPS_pubmethodEnumColumns(String, String, String, String)

Enumerates a list of columns that can be accessed on the linked server for a specified column.

System_CAPS_pubmethodEnumTables()

Enumerates a list of tables that are available on the linked server.

System_CAPS_pubmethodEnumTables(String)

Enumerates a list of tables that are available on the linked server for a specified table name.

System_CAPS_pubmethodEnumTables(String, String)

Enumerates a list of tables that are available on the linked server for a specified table name and schema.

System_CAPS_pubmethodEnumTables(String, String, String)

Enumerates a list of tables that are available on the linked server for a specified table name, schema, and database.

System_CAPS_pubmethodEnumTables(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.

System_CAPS_pubmethodEquals(Object)

(Inherited from Object.)

System_CAPS_protmethodFormatSqlVariant(Object)

Formats an object as T: Microsoft.Data.Schema.Sql.DataGenerator.SqlVariant type.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetContextDB()

Gets the context database that is associated with this object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetDBName()

Gets the database name that is associated with the object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetHashCode()

(Inherited from Object.)

System_CAPS_protmethodGetPropValue(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptional(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetPropValueOptionalAllowNull(String)

Gets a property value of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_protmethodGetServerObject()

Gets the server of the SqlSmoObject object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodGetType()

(Inherited from Object.)

System_CAPS_pubmethodInitialize()

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodInitialize(Boolean)

Initializes the object and forces the properties be loaded.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInitialized()

Verifies whether the object has been initialized.(Inherited from SqlSmoObject.)

System_CAPS_protmethodIsObjectInSpace()

Verifies whether the object is isolated or connected to the instance of SQL Server.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodIsSupportedProperty(String)

(Inherited from SqlSmoObject.)

System_CAPS_pubmethodRefresh()

Refreshes the object and retrieves properties when the object is next accessed.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodScript()

Generates a Transact-SQL script that can be used to re-create the linked server registration.

System_CAPS_pubmethodScript(ScriptingOptions)

Generates a Transact-SQL script that can be used to re-create the linked server registration as specified by the script options.

System_CAPS_protmethodSetParentImpl(SqlSmoObject)

Sets the parent of the SqlSmoObject to the newParent parameter.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodTestConnection()

Tests the connection to a linked server.

System_CAPS_pubmethodToString()

Returns a String that represents the referenced object.(Inherited from SqlSmoObject.)

System_CAPS_pubmethodValidate(String, Object[])

Validates the state of an object.(Inherited from SmoObjectBase.)

NameDescription
System_CAPS_pubeventPropertyChanged

Represents the event that occurs when a property is changed.(Inherited from SqlSmoObject.)

System_CAPS_pubeventPropertyMetadataChanged

Represents the event that occurs when property metadata changes.(Inherited from SqlSmoObject.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Discover()

Discovers any dependencies.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetDomainRoot()

Returns the root of the domain.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyType(String)

Gets the type of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.GetPropertyValue(String, Type)

Gets the value of the specified property.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.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.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.Resolve(String)

Gets the instance that contains the information about the object from the Unified Resource Name (URN) of the object.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetObjectState(SfcObjectState)

Sets the object state to the specified SfcObjectState value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodIAlienObject.SetPropertyValue(String, Type, Object)

Sets the property value.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privmethodISfcPropertyProvider.GetPropertySet()

Gets the interface reference to the set of properties of this object.

Do not reference this member directly in your code. It supports the SQL Server infrastructure.(Inherited from SqlSmoObject.)

System_CAPS_pubinterfaceSystem_CAPS_privpropertyISfcSupportsDesignMode.IsDesignMode

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.

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.  

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

Return to top
Show:
© 2016 Microsoft