LinkedServer.EnumTables Method (String, String, String, LinkedTableType)

  • Article

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

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

Syntax

'Declaration
Public Function EnumTables ( _
    tableName As String, _
    schemaName As String, _
    databaseName As String, _
    tableType As LinkedTableType _
) As DataTable
'Usage
Dim instance As LinkedServer 
Dim tableName As String 
Dim schemaName As String 
Dim databaseName As String 
Dim tableType As LinkedTableType 
Dim returnValue As DataTable 

returnValue = instance.EnumTables(tableName, _
    schemaName, databaseName, tableType)

public DataTable EnumTables(
    string tableName,
    string schemaName,
    string databaseName,
    LinkedTableType tableType
)

public:
DataTable^ EnumTables(
    String^ tableName, 
    String^ schemaName, 
    String^ databaseName, 
    LinkedTableType tableType
)

member EnumTables : 
        tableName:string * 
        schemaName:string * 
        databaseName:string * 
        tableType:LinkedTableType -> DataTable

public function EnumTables(
    tableName : String, 
    schemaName : String, 
    databaseName : String, 
    tableType : LinkedTableType
) : DataTable

Parameters

Return Value

Type: System.Data.DataTable
A DataTable object value that contains a list of tables that can be accessed on the linked server. The table describes the different columns of the returned DataTable.

Column

Data type

Description

TABLE_CAT

String

The table qualifier name. Various DBMS products support three-part naming for tables (qualifier.owner.name). In SQL Server, this column represents the database name. In some other products, it represents the server name of the database environment of the table. This field can be NULL.

TABLE_SCHEMA

String

The owner of the table in the linked server. In SQL Server, this column represents the name of the database user who created the table. This field always returns a value.

TABLE_NAME

String

The name of the table in the linked server. This field always returns a value.

TABLE_TYPE

String

The type of table: table, system table, or view.

REMARKS

String

SQL Server does not return a value for this column.

Examples

Using Linked Servers in SMO

See Also

Reference

LinkedServer Class

EnumTables Overload

Microsoft.SqlServer.Management.Smo Namespace

Other Resources

Linked Servers (Database Engine)

sp_addlinkedserver (Transact-SQL)

sp_tables_ex (Transact-SQL)