9 11 2016

Um dos artigos mais acessados até hoje aqui no site é aquele onde eu mostrei como podemos fazer backup e restauração do SQL Server através do C#. Esses dias atrás, recebi um e-mail de alguém que tinha lido esse artigo perguntando como ele poderia verificar se uma instância do SQL Server já estava instalada e rodando (por exemplo, uma instância chamada “SQLEXPRESS“). Pensei comigo: “Hmm, que dúvida interessante, ainda não sei como fazer isso“. Resolvi pesquisar e acabei descobrindo que conseguimos listar facilmente as instâncias do SQL Server com C# e VB.NET através do SMO (que é a mesma biblioteca que utilizamos para fazer o backup e restauração). Vamos ver como podemos implementar essa funcionalidade na nossa aplicação?

Criando o projeto de exemplo

Para entendermos como é que funciona o processo de listagem das instâncias do SQL Server, vamos criar um novo projeto do tipo “Windows Forms Application“. Não se engane: o código que eu vou mostrar nesse artigo funciona nas outras plataformas também (como WPF, ASP.NET, Console Application, etc). Só escolhi Windows Forms para facilitar a nossa vida.

Uma vez criado o projeto, vamos adicionar as referências às bibliotecas do SMO (SQL Server Management Objects). Você encontra esses itens dentro da categoria “Extensions” da tela “Reference Manager“:

– Microsoft.SqlServer.ConnectionInfo
– Microsoft.SqlServer.Management.Sdk.Sfc
– Microsoft.SqlServer.Smo
– Microsoft.SqlServer.SmoExtended

Em seguida, vamos ajustar o formulário do nosso projeto, adicionando um DataGridView (dataGridViewInstancias) e um botão (listarSQLButton), de forma que ele fique parecido com a imagem a seguir:

Listando todas as instâncias (rede e local)

Agora que já temos o formulário criado e as referências do SMO adicionadas ao projeto, vamos implementar o código para listarmos todas as instâncias que conseguirmos encontrar, tanto na rede quanto no computador local. Isso é muito tranquilo de ser feito com o SMO, mais especificamente com a classe SmoApplication. Essa classe possui um método estático (chamado EnumAvailableSqlServers) que implementa justamente a funcionalidade de listar as instâncias do SQL Server.

O método “EnumAvailableSqlServers” possui três sobrecargas. A primeira delas não recebe nenhum parâmetro, e o resultado da sua chamada será uma DataTable contendo as informações de todas as instâncias que forem encontradas, tanto na rede quanto no computador onde a aplicação está sendo executada. O código do evento de clique no nosso botão deve ficar assim:

        // C#
        private void listarSQLButton_Click(object sender, EventArgs e)
        {
            dataGridViewInstancias.DataSource = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers();
        }

    ' VB.NET
    Private Sub listarSQLButton_Click(sender As Object, e As EventArgs) Handles listarSQLButton.Click
        dataGridViewInstancias.DataSource = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers()
    End Sub

Execute a aplicação, clique no botão e veja o resultado:

Filtrando a pesquisa pelo nome da instância

Em algumas situações, pode ser que precisemos procurar por um nome de instância específico. Nesse caso, ao invés de simplesmente chamarmos o método “EnumAvailableSqlServers” e filtrarmos o resultado, podemos utilizar a sobrecarga do método que recebe uma string, que é justamente o filtro que queremos utilizar na busca.

Vamos, então, adicionar um TextBox no formulário (nomeInstanciaTextBox), onde o usuário poderá especificar o nome do servidor e instância que ele quer procurar:

Em seguida, vamos fazer uma pequena alteração no código para considerarmos esse TextBox na consulta:

        // C#
        private void listarSQLButton_Click(object sender, EventArgs e)
        {
            DataTable servers = null;
            if (!string.IsNullOrWhiteSpace(nomeInstanciaTextBox.Text))
                servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(nomeInstanciaTextBox.Text);
            else
                servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers();
            dataGridViewInstancias.DataSource = servers;
        }

    ' VB.NET
    Private Sub listarSQLButton_Click(sender As Object, e As EventArgs) Handles listarSQLButton.Click
        Dim servers As DataTable = Nothing
        If Not String.IsNullOrWhiteSpace(nomeInstanciaTextBox.Text) Then
            servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(nomeInstanciaTextBox.Text)
        Else
            servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers()
        End If
        dataGridViewInstancias.DataSource = servers
    End Sub

Pronto! Agora podemos procurar por uma instância específica do SQL Server:

Pesquisando somente instâncias locais

Uma outra opção que podemos adicionar no nosso formulário é alternativa de pesquisarmos somente as instâncias locais. A terceira sobrecarga do método “EnumAvailableSqlServers” recebe um parâmetro booleano. Quando passamos “true” para esse parâmetro, o método fará a pesquisa somente no computador onde a aplicação está rodando (e não na rede toda).

Para implementarmos essa opção, vamos adicionar um CheckBox no nosso formulário (somenteInstanciasLocaisCheckBox):

E, no código, utilizamos a informação da propriedade “Checked” no parâmetro do método “EnumAvailableSqlServers“:

        // C#
        private void listarSQLButton_Click(object sender, EventArgs e)
        {
            DataTable servers = null;
            if (!string.IsNullOrWhiteSpace(nomeInstanciaTextBox.Text))
                servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(nomeInstanciaTextBox.Text);
            else
                servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(somenteInstanciasLocaisCheckBox.Checked);
            dataGridViewInstancias.DataSource = servers;
        }

    ' VB.NET
    Private Sub listarSQLButton_Click(sender As Object, e As EventArgs) Handles listarSQLButton.Click
        Dim servers As DataTable = Nothing
        If Not String.IsNullOrWhiteSpace(nomeInstanciaTextBox.Text) Then
            servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(nomeInstanciaTextBox.Text)
        Else
            servers = Microsoft.SqlServer.Management.Smo.SmoApplication.EnumAvailableSqlServers(somenteInstanciasLocaisCheckBox.Checked)
        End If
        dataGridViewInstancias.DataSource = servers
    End Sub

Feito isso, ao pesquisarmos as instâncias com o CheckBox marcado, somente as instâncias locais serão retornadas (no meu caso, não tenho nenhuma instância local instalada, por isso a lista está vazia):

Concluindo

As classes disponíveis no pacote SQL Server Management Object possuem funcionalidades muito interessantes para gerenciarmos bancos de dados SQL Server. Uns tempos atrás eu mostrei como criar e restaurar backups do SQL Server utilizando essas classes. Hoje eu resolvi mostrar como podemos utilizar essas mesmas classes para pesquisarmos instâncias do SQL Server com C# e VB.NET.

Você já teve a necessidade de saber se uma instância do SQL Server estava disponível ou não? Se sim, como é que você acabou resolvendo essa necessidade? Utilizando as classes do SMO, como eu demonstrei nesse artigo, ou de alguma outra forma? Conte-nos mais detalhes na caixa de comentários!

Por fim, convido você a inscrever-se na minha newsletter. Ao fazer isso, você receberá um e-mail toda semana sobre o artigo publicado e ficará sabendo também em primeira mão sobre o artigo da próxima semana, além de receber dicas “bônus” que eu só compartilho por e-mail. Inscreva-se utilizando o formulário logo abaixo.

Até a próxima!

André Lima

Utilizando o Oracle com C# e VB.NET Como imprimir um formulário no Windows Forms com C# e VB.NET?