Introduction to SQL Server Shared Management Objects (SMO)

What is it and Why SMO?

SMO stands for Shared Management Objects. It is a SQL administration API used to get meta data information from SQL Server. You may ask "Why? I can already do that". True, but what if your only need was to have a tool that could do some of the following:
  1. Backups and restores
  2. Create some test databases
  3. Maybe even export some SQL Server related information to an Excel Spreadsheet
This tutorial focuses on getting started using this powerful API in your .NET applications. Mind you, this is not a replacement for SQL Server Management Studio (SSMS). This tutorial just gives you the initial steps you need to progress more in the SMO related technosphere.

What Do You Need to get Started?

  1. SQL Server 2005 onwards
  2. Shared Management Objects Installed (Required Assemblies)
  3. Visual Studio Professional or Express editions (2005 onwards)
...and finally, the will and enthusiasm to build your first SMO application.

For this tutorial we'll be using: What Are We Going to Accomplish?

To keep things simple we are going to populate a list of databases from the SQL Server Express instance, similar to SQL Server Management Studio. Let’s begin.

1) Launch Visual Basic Express Edition 2010. Click on File > New Project > Windows Application as shown in the screen below. Enter the Project name as you please. I have entered SMOApp:

New SMO Project

2) Now from the Toolbox place a TreeView Control onto the Form. Dock it to the left.

3) Next let us turn our attention to adding the needed assemblies. Right click on References > Add Reference:

Add an assembly to the project

4) Now your References should resemble as shown below:

Project references

5) So now that everything's in place, let's start coding!! Yeah!!

Double click the form to launch the Code Window and copy and paste the code as shown below:

Imports Microsoft.SqlServer.Management.Smo

Imports Microsoft.SqlServer.Management.Common

 

Public Class Form1

 

    Public Sub LoadDB()


        'Declare an instance of the Server Class along with the Connection String

        Dim Mysvr As New Server(".\SQLEXPRESS")

 

        'Declare a Database Variable that will enumerate in the TreeView

        Dim db As New Database

 

        'Now iterate through the list of databases within the server

        For Each db In Mysvr.Databases


            'We are now going to populate the TreeView Nodes with the Databases

            TreeView1.Nodes.Add(db.Name)


        Next

 

    End Sub



    Private Sub Form1_Load(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load

 

        Try


            LoadDB()


        Catch ex As SqlServerManagementException


            MessageBox.Show("Error" + ex.Message, "Error", MessageBoxButtons.OK, MessageBoxIcon.Error)


        End Try


    End Sub


End Class


I have added some beautification to simulate it like a real Database Explorer as shown below. Feel free to experiment with your own images. The final output is shown below:

Database Explorer

Well, wasn't that easy :-)?

Nice Job

The next article in the series is coming soon. Do let me know your feedback. You can e-mail me anil.mahadev at gmail.com with the SubjectLine: indicating SMO Article

End of Technical Article

SQL Server Club is a free community service from Norb Technologies - Making SQL Server Faster - www.norbtechnologies.com