Получение списка доступных в сети SQL серверов

      В данной статье рассмотрим два варианта получения доступных в сети SQL серверов.

• С использованием стандартного класса «SqlDataSourceEnumerator» из Microsoft Net. Fraemwork; 
• С использованием WinAPI.

1)      Для получения доступных SQL серверов на локальном компьютере или в сети необходимо воспользоваться классом «SqlDataSourceEnumerator», который обеспечивает доступ к этим сведениям, предоставляя объект «DataTable» с данными обо всех видимых серверах. Для этого необходимо вызвать метод «GetDataSources», который возвращает таблицу «DataTable» со сведениями о доступных серверах:

DataTable dt = System.Data.Sql.SqlDataSourceEnumerator.Instance.GetDataSources()

      Таблица, возвращенная в результате вызова этого метода, содержит следующие столбцы, причем все эти столбцы содержат значения «string».

• «ServerName» - Имя сервера.
• «InstanceName» - Имя экземпляра сервера. Пуст, если сервер выполняется как используемый по умолчанию экземпляр.
• «IsClustered» - Указывает, является ли сервер частью кластера.
• «Version» - Версия сервера.

      Сведения о серверах из списка могут включать или не включать такие дополнительные данные, как «IsClustered» и версия (Version). Это зависит от того, каким образом был получен список. В списках серверов, полученных с помощью службы обозревателя «SQL Server», присутствует больше сведений, чем в списках серверов, найденных с помощью инфраструктуры Windows и содержащих только имена.
      Так же из-за особенностей механизма, используемого «SqlDataSourceEnumerator» для поиска источников данных в сети, этот метод не всегда возвращает полный список доступных серверов, и для последовательных вызовов содержимое списка может изменяться в зависимости от таких факторов, как время ожидания и сетевой трафик. Это может привести к тому, что при двух последовательных вызовах будут получены разные списки. В список входят только серверы, находящиеся в одной сети. Широковещательные пакеты обычно не проходят через маршрутизаторы, поэтому некоторый сервер может отсутствовать в списке, но будет стабильно работать.
      Если вы планируете применять данную функцию, чтобы дать возможность пользователю выбрать сервер из списка, обязательно предоставляйте пользователю возможность ввести отсутствующее в списке имя сервера на случай, если перечисление вернет не все доступные серверы.
      Кроме того, этот метод может выполняться довольно долго, поэтому в ситуациях, когда приоритетным является быстродействие, пользоваться им следует с осторожностью.

Дополнительную информацию вы можете получить по следующему адресу: https://msdn.microsoft.com.

      В «SQL Server 2000» данные для «SqlDataSourceEnumerator» предоставляются внутренним образом. Но в версии «SQL Server 2005» эти сведения предоставляются с использованием внешней службы Windows, называемой обозревателем SQL. Применение этой службы разрешено по умолчанию, но администраторы могут ее выключать или запрещать, в результате чего соответствующий экземпляр сервера становится невидимым для указанного класса. Эта служба применяется только в версии «SQL Server 2005» и не оказывает влияния на поведение «SQL Server 2000». Оборудование и программное обеспечение так же могут налагать свои ограничения на возможность поиска экземпляров «SQL Server».
      Ниже представлен пример получения и вывода сокращенной информации обо всех найденных в сети и (или) локальных SQL серверов в элемент управления «ComboBox» и более полной информации в элемент управления «RichTextBox».

//Переменная для хранения информации о 
//найденных серверах.
string ServerInfo = string.Empty;

//Получение доступных SQL серверов.
DataTable dt = System.Data.Sql.SqlDataSourceEnumerator.Instance.GetDataSources();
foreach (DataRow dr in dt.Rows)
{
    //Вывод найденной информации о серверах
    //в элемент управления СomboBox.
    comboBox1.Items.Add(string.Concat(dr["ServerName"], "\\", dr["InstanceName"]));

    //Добавление пустой строки после получения 
    //информации о сервере
    foreach (DataColumn col in dt.Columns)
    {
        ServerInfo += String.Format("{0,-15}: {1}", col.ColumnName, dr[col]) + Environment.NewLine;
    }

    //Добавление пустой строки после получения 
    //информации о сервере.
    ServerInfo += Environment.NewLine;                
}

//Вывод найденной информации о серверах
//в элемент управления RichTextBox.
richTextBox1.Text = ServerInfo;

2)      В данном примере необходимо добавить класс «SqlLocator» в листинг формы, где будет выполняться запуск процесса поиска и вывода найденных SQL серверов в сети.

public class SqlLocator
{
[System.Runtime.InteropServices.DllImport("odbc32.dll")]
private static extern short SQLAllocHandle(short hType, IntPtr inputHandle, out IntPtr outputHandle);
[System.Runtime.InteropServices.DllImport("odbc32.dll")]
private static extern short SQLSetEnvAttr(IntPtr henv, int attribute, IntPtr valuePtr, int strLength);
[System.Runtime.InteropServices.DllImport("odbc32.dll")]
private static extern short SQLFreeHandle(short hType, IntPtr handle);
[System.Runtime.InteropServices.DllImport("odbc32.dll", CharSet = System.Runtime.InteropServices.CharSet.Ansi)]
private static extern short SQLBrowseConnect(IntPtr hconn, StringBuilder inString,
 short inStringLength, StringBuilder outString, short outStringLength,
 out short outLengthNeeded);

private const short SQL_HANDLE_ENV = 1;
private const short SQL_HANDLE_DBC = 2;
private const int SQL_ATTR_ODBC_VERSION = 200;
private const int SQL_OV_ODBC3 = 3;
private const short SQL_SUCCESS = 0;

private const short SQL_NEED_DATA = 99;
private const short DEFAULT_RESULT_SIZE = 1024;
private const string SQL_DRIVER_STR = "DRIVER=SQL SERVER";

private SqlLocator() { }

public static string[] GetServers()
{
    string[] retval = null;
    string txt = string.Empty;
    IntPtr henv = IntPtr.Zero;
    IntPtr hconn = IntPtr.Zero;
    StringBuilder inString = new StringBuilder(SQL_DRIVER_STR);
    StringBuilder outString = new StringBuilder(DEFAULT_RESULT_SIZE);
    short inStringLength = (short)inString.Length;
    short lenNeeded = 0;

    try
    {
        if (SQL_SUCCESS == SQLAllocHandle(SQL_HANDLE_ENV, henv, out henv))
        {
            if (SQL_SUCCESS == SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION, (IntPtr)SQL_OV_ODBC3, 0))
            {
                if (SQL_SUCCESS == SQLAllocHandle(SQL_HANDLE_DBC, henv, out hconn))
                {
                    if (SQL_NEED_DATA == SQLBrowseConnect(hconn, inString, inStringLength, outString,
                     DEFAULT_RESULT_SIZE, out lenNeeded))
                    {
                        if (DEFAULT_RESULT_SIZE < lenNeeded)
                        {
                            outString.Capacity = lenNeeded;
                            if (SQL_NEED_DATA != SQLBrowseConnect(hconn, inString, inStringLength, outString,
                             lenNeeded, out lenNeeded))
                            {
                                throw new ApplicationException("Unabled to aquire SQL Servers from ODBC driver.");
                            }
                        }
                        txt = outString.ToString();
                        int start = txt.IndexOf("{") + 1;
                        int len = txt.IndexOf("}") - start;
                        if ((start > 0) && (len > 0))
                        {
                            txt = txt.Substring(start, len);
                        }
                        else
                        {
                            txt = string.Empty;
                        }
                    }
                }
            }
        }
    }
    catch (Exception ex)
    {                
        #if (DEBUG)
        MessageBox.Show(ex.Message, "Acquire SQL Servier List Error");
        #endif
        txt = string.Empty;
    }
    finally
    {
        if (hconn != IntPtr.Zero)
        {
            SQLFreeHandle(SQL_HANDLE_DBC, hconn);
        }
        if (henv != IntPtr.Zero)
        {
            SQLFreeHandle(SQL_HANDLE_ENV, hconn);
        }
    }

    if (txt.Length > 0)
    {
        retval = txt.Split(",".ToCharArray());
    }

    return retval;
}

     Для получения списка SQL серверов с помощью данного класса необходимо вызвать из него метод «GetServers», который возвращает строковый массив с доступными в сети серверами.

//Предварительно очищаем все элементы управления
//в которые будут выводиться данные
comboBox1.Items.Clear();
richTextBox1.Text = string.Empty;

string[] theAvailableSqlServers = SqlLocator.GetServers();
if (theAvailableSqlServers != null)
{
    comboBox1.DataSource = theAvailableSqlServers;
    foreach (string NameServer in theAvailableSqlServers)
    {
         richTextBox1.Text += NameServer + Environment.NewLine;
    }
}
else
{
    MessageBox.Show("SQL сервера не найдены!");
}

Ссылка для скачивания примера: Яндекс.Диск