[转]SQL Server编程:SMO介绍

Posted 2020-08-28 绣春刀

转自：周公

最近在项目中用到了有关SQL Server管理任务方面的编程实现，有了一些自己的心得体会，想在此跟大家分享一下，在工作中用到了SMO/SQL CLR/SSIS等方面的知识，在国内这方面的文章并不多见，有也是一些零星的应用，特别是SSIS部分国内外的文章大都是讲解如何拖拽控件的，在开发过程中周公除了参阅SQL Server帮助文档、MSDN及StackOverFlow等网站，这些网站基本上都是英文的，为了便于一些英文不好的开发者学习，周公在自己的理解上加以整理成系列，不到之处请大家谅解。
SMO简介
SMO是英文SQL Server Management Objects的缩写，意思是SQL Server管理对象系列，包含了一些列的命名空间(namespace)、动态链接库（dll)和类(class)。这些类偏重于SQL Server的管理，并且在底层是通过SQL Server数据库提供程序(System.Data.SqlClient)下的类来与SQL Server来进行交互的。可以通过编程的方式利用SMO来管理SQL Server7.0以上的版本（SQL Server 7.0/2000/2005/2008)，如果低于以上版本的SQL Server则无法利用SMO来管理（除了历史原因遗留的系统，在现在的开发中那些不受支持的SQL Server算是和Windows95一样的古董了）。同时，要使用SMO的话，必须安装SQL Server Native Client，一般情况下当我们安装.Net Framework2.0以上版本或者SQL Server2005以上版本时就会自动安装上了。
在32位系统下如果安装的是SQL Server2005并且没有更改安装路径，则SMO程序集的路径是：C:\Program Files\Microsoft SQL Server\90\SDK\Assemblies，相应的，如果安装的是SQL Server2008，则SMO程序集的路径就是C:\Program Files\Microsoft SQL Server\100\SDK\Assemblies，如果是在64位系统下安装，则根据安装的SQL Server的版本来判断是在Program Files (x86)还是在Program Files下面的对应目录下。
在SMO中有如下命名空间：Microsoft.SqlServer.Management.Common、Microsoft.SqlServer.Management.Nmo、Microsoft.SqlServer.Management.Smo、Microsoft.SqlServer.Management.Smo.Agent、Microsoft.SqlServer.Management.Smo.Broker、Microsoft.SqlServer.Management.Smo.Mail、Microsoft.SqlServer.Management.Smo.RegisteredServers、Microsoft.SqlServer.Management.Smo.Wmi、Microsoft.SqlServer.Management.Trace，关于这些命名空间在哪个dll中以及该命名空间下有哪些类，大家可以查阅SQL Server的帮助文章或者查阅在线MSDN，例如查看命名空间下的类可以浏览：http://msdn.microsoft.com/zh-cn/library/microsoft.sqlserver.management.smo(v=sql.100)
SMO体系架构
我们知道在SQL Server体系中处于顶层是SQL Server实例，每个实例会有多个数据库，每个数据库会有多个表、存储过程、函数、登录账号等，每个表会有列、索引、主键等信息，每个列会有列名、默认值、字段大小等信息，在SMO中有与之相对应的一套类体系结构。 

在DatabaseCollection中每个元素都是一个Database类的实例，分别对应数据实例中的一个数据库；在TableCollection中每个元素都是一个Table的实例，分别对应数据库中的一个表；在ColumnCollection中每个元素都是一个Column类的实例，分别对应表中的每一列，以上这些类都位于Microsoft.SqlServer.Management.Smo命名空间下，在Microsoft.SqlServer.Smo.dll这个dll中。
当然，在Microsoft.SqlServer.Management.Smo命名空间中的类远不止上面提到的这些，上面的表格只是做了一个简单的类比。
SMO用法示例
上面的文章只是做了一个简单的介绍，也许通过上面枯燥的介绍大家没什么印象，下面通过一段简单的代码来简单演示一下用法，首先要添加响应的引用。在VS2008中可以直接通过下面的方式添加引用：

但是在VS2010中就没有这么方便了，它使用了过滤属性（而且还无法禁用掉或者进行设置），使得无法添加这些程序集，如下图：

我看到有人在Stack Overflow提了和我疑惑相同的问题，别人给了一个答案就是在VS2010中安装Muse.VSExtensions来解决，安装地址：http://visualstudiogallery.msdn.microsoft.com/36a6eb45-a7b1-47c3-9e85-09f0aef6e879/，我尝试了一下不是很理想，不过Muse.VSExtensions还提供了其它的功能（比如移除未使用的程序集）还是不错的。
注意在编译下面的代码之前需要添加对microsoft.sqlserver.connectioninfo.dll和microsoft.sqlserver.smo.dll的引用。
代码如下：

    using System;
    using Microsoft.SqlServer.Management.Common;//需添加microsoft.sqlserver.connectioninfo.dll的引用
    using Microsoft.SqlServer.Management.Smo;//需添加microsoft.sqlserver.smo.dll的引用
    
    namespace SSISStudy
    {
        /// <summary>
        /// SQL Server编程些列文章(1):SMO介绍的配套代码
        /// 作者：周公 
        /// 创建日期：2012-05-17 
        /// 博客地址：http://blog.csdn.net/zhoufoxcn http://zhoufoxcn.blog.51cto.com 
        /// 新浪微博地址：http://weibo.com/zhoufoxcn  
        /// </summary>
        class SMODemo01
        {
            /// <summary>
            /// 显示数据库的概要情况
            /// </summary>
            public static void ShowServerInfo()
            {
                //创建ServerConnection的实例
                ServerConnection connection = new ServerConnection();
                //指定连接字符串
                connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
                //实例化Server
                Server server = new Server(connection);
                Console.WriteLine("ActiveDirectory:{0}", server.ActiveDirectory);
                Console.WriteLine("InstanceName:{0}",server.InstanceName);
    
                //列出当前SQL Server实例中的登录用户
                foreach (Login login in server.Logins)
                {
                    Console.WriteLine("Name:{0},CreateDate:{1},DefaultDatabase:{2}", login.Name, login.CreateDate, login.DefaultDatabase);
                }
                //通过索引方式找到master数据库
                Database db = server.Databases["master"];
                Console.WriteLine("Database:{0}", db.Name);
                Console.WriteLine("CreateDate:{0},Dbo:{1}", db.CreateDate, db.Owner);
                Console.WriteLine("DataSpaceUsage:{0},SpaceAvailable:{1}", db.DataSpaceUsage, db.SpaceAvailable);
                Console.WriteLine("PrimaryFilePath:{0}", db.PrimaryFilePath);
                //列出master数据库下每个表的概要信息
                foreach (Table table in db.Tables)
                {
                    Console.WriteLine("\tTable:{0}，DataSpaceUsed:{1},CreateDate:{2}", table.Name, table.DataSpaceUsed, table.CreateDate);
                    //urnCollection.Add(table.Urn);
                    //列出每个表中每个列的概要信息
                    foreach (Column column in table.Columns)
                    {
                        Console.WriteLine("\t\tColumn:{0}，DataType:{1}，Nullable:{2}", column.Name, column.DataType, column.Nullable);
                    }
                }
                //列出master数据库中的角色信息
                foreach(DatabaseRole dbRole in db.Roles)
                {
                    Console.WriteLine("DB Role {0} Created at {1}", dbRole.Name, dbRole.CreateDate);
                }
    
                Console.ReadLine();
            }
    
        }
    }

程序的执行效果如下：

通过上面的代码可以获取很多有关数据库的信息，而在代码中我们没有写一行SQL语句，而在之前周公曾写过一篇博客《在.NET中根据SQL Server系统表获取数据库管理信息》，在其中为了查找这些信息周公是查了很多资料才知道SQL语句的写法，使用SMO之后连SQL语句都免了，可见利用SMO来管理数据库的方便性。在后续的篇幅中周公将讲述如何利用SMO来获取SQL Server中数据库的创建语句及如何利用SMO来创建Job。

在上一篇周公简单讲述了SMO的一些基本概念，实际上SMO体系结构远不止周公在上一篇中讲述的那么简单，下图是MSDN上给出的一个完整的结构图：

 

上图是一个完整的涉及到各种关系的结构图。不过它们之间的层次结构关系周公已经在上一篇做了简单概述。
在本篇中周公还是在上一篇的基础上再做稍微深入一点的介绍，在本篇中主要讲述如何获取数据库常见对象信息，并且如何利用SMO来进行一些日常操作：如创建Login，创建数据库、备份数据库和还原数据库。执行上面这些操作的SQL语句也许我们已经写过，下面我们来看看利用SMO来操作的代码将如何写。为了便于理解，在代码中的注释比较详尽，所以本篇中代码之外的讲解就不多了。另外，需要注意的是SMO的dll的版本随着升级变化比较大，这一点不同.NET Framework，没有考虑向下兼容。
代码如下：

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using Microsoft.SqlServer.Management.Smo.RegisteredServers;//在microsoft.sqlserver.smo.dll中
using Microsoft.SqlServer.Management.Smo;//需添加microsoft.sqlserver.smo.dll的引用
using Microsoft.SqlServer.Management.Common;//需添加microsoft.sqlserver.connectioninfo.dll的引用

namespace SSISStudy
{
    /// <summary>
    /// SQL Server编程些列文章(2):SMO常用对象的有关操作
    /// 作者：周公 
    /// 创建日期：2012-05-23 
    /// 博客地址：http://blog.csdn.net/zhoufoxcn http://zhoufoxcn.blog.51cto.com 
    /// 新浪微博地址：http://weibo.com/zhoufoxcn  
    class SMODemo02
    {
        /// <summary>
        /// 显示数据库常见对象信息示例，本方法中的代码只针对9.0版本的SMO dll(SQL2005附带程序集）
        /// </summary>
        public static void ShowSMOObjects()
        {
            Console.WriteLine("Server Group Information");
            foreach (ServerGroup serverGroup in SmoApplication.SqlServerRegistrations.ServerGroups)
            {
                Console.WriteLine("Group Name:{0},Path:{1},ServerType:{2},State:{3},Urn:{4}", serverGroup.Name, serverGroup.Path, serverGroup.ServerType, serverGroup.State, serverGroup.Urn);
            }

            Console.WriteLine("Registered Server Information");
            foreach (RegisteredServer regServer in SmoApplication.SqlServerRegistrations.RegisteredServers)
            {
                Console.WriteLine("Server Name:{0},Login:{1},State:{2},Urn:{3}", regServer.Name, regServer.Login, regServer.State, regServer.Urn);
            }

            //创建ServerConnection的实例
            ServerConnection connection = new ServerConnection();
            //指定连接字符串
            connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
            //实例化Server
            Server server = new Server(connection);
            Console.WriteLine("ActiveDirectory:{0},InstanceName:{1}", server.ActiveDirectory, server.InstanceName);
            //下面列出每个数据库的具体信息
            foreach (Database db in server.Databases)
            {
                Console.WriteLine("Database Name:{0},ActiveDirectory:{1},ActiveConnections:{2},DataSpaceUsage:{3},PrimaryFilePath:{4}", db.Name, db.ActiveDirectory, db.ActiveConnections, db.DataSpaceUsage, db.PrimaryFilePath);
                //列出数据库的数据文件文件组信息
                foreach (FileGroup fileGroup in db.FileGroups)
                {
                    Console.WriteLine("\tFileGroup Name:{0},Size:{1},State:{2},Urn:{3}", fileGroup.Name, fileGroup.Size, fileGroup.State, fileGroup.Urn);
                    //列出每个文件组中的数据文件信息
                    foreach (DataFile dataFile in fileGroup.Files)
                    {
                        Console.WriteLine("\t\tDataFile Name:{0},Size:{1},State:{2},Urn:{3},FileName:{4}", dataFile.Name, dataFile.Size, dataFile.State, dataFile.Urn, dataFile.FileName);
                    }
                }
                //列出数据库日志文件信息
                foreach (LogFile logFile in db.LogFiles)
                {
                    Console.WriteLine("\tLogFile Name:{0},Size:{1},State:{2},Urn:{3},FileName:{4}", logFile.Name, logFile.Size, logFile.State,logFile.Urn,logFile.FileName);
                }
            }
        }
        /// <summary>
        /// 利用SMO创建SQL登录
        /// </summary>
        public static void CreateLogin()
        {
            string loginName = "zhoufoxcn";//要创建的数据库登录名
            string loginPassword = "C#.NET";//登录密码

            //创建ServerConnection的实例
            ServerConnection connection = new ServerConnection();
            //指定连接字符串
            connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
            //实例化Server
            Server server = new Server(connection);

            #region [创建数据库登录对象]
            //检查在数据库是否已经存在该登录名
            var queryLogin = from Login temp in server.Logins
                             where string.Equals(temp.Name, loginName, StringComparison.CurrentCultureIgnoreCase)
                             select temp;
            Login login = queryLogin.FirstOrDefault<Login>();
            //如果存在就删除
            if (login != null)
            {
                login.Drop();
            }
            login = new Login(server, loginName);
            login.LoginType = LoginType.SqlLogin;//指定登录方式为SQL认证
            login.PasswordPolicyEnforced = true;
            login.DefaultDatabase = "master";//默认数据库
            login.Create(loginPassword);
            #endregion
        }
        /// <summary>
        /// 利用SMO创建数据库
        /// </summary>
        public static void CreateDatabase()
        {
            string databaseName = "SMODemo";
            //创建ServerConnection的实例
            ServerConnection connection = new ServerConnection();
            //指定连接字符串
            connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
            //实例化Server
            Server server = new Server(connection);

            #region [创建数据库对象]
            //检查在数据库是否已经存在该数据库
            var queryDatabase = from Database temp in server.Databases
                                where string.Equals(temp.Name, databaseName, StringComparison.CurrentCultureIgnoreCase)
                                select temp;
            Database database = queryDatabase.FirstOrDefault<Database>();
            //如果存在就删除
            if (database != null)
            {
                database.Drop();
            }

            database = new Database(server, databaseName);
            //指定数据库数据文件细节
            FileGroup fileGroup = new FileGroup { Name = "PRIMARY", Parent = database, IsDefault = true };
            DataFile dataFile = new DataFile
            {
                Name = databaseName + "_data",
                Parent = fileGroup,
                FileName = @"F:\SQLData2005\" + databaseName + ".mdf"
            };
            fileGroup.Files.Add(dataFile);
            //指定数据库日志文件细节
            LogFile logFile = new LogFile
            {
                Name = databaseName + "_log",
                Parent = database,
                FileName = @"F:\SQLData2005\" + databaseName + ".ldf"
            };

            database.FileGroups.Add(fileGroup);
            database.LogFiles.Add(logFile);

            database.Create();
            #endregion
        }
        /// <summary>
        /// 利用SMO备份数据库
        /// </summary>
        public static void BackupDatabase()
        {
            string databaseName = "msdb";//备份的数据库名
            string bkPath = @"C:\";//存放备份后的数据的文件夹
            //创建ServerConnection的实例
            ServerConnection connection = new ServerConnection();
            //指定连接字符串
            connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
            //实例化Server
            Server server = new Server(connection);

            #region [创建数据库备份对象]
            Backup backup = new Backup();
            backup.Action = BackupActionType.Database;//完全备份
            backup.Database = databaseName;
            backup.BackupSetDescription = "Full backup of master";
            backup.BackupSetName = "master Backup";
            //创建备份设备
            BackupDeviceItem bkDeviceItem = new BackupDeviceItem();
            bkDeviceItem.DeviceType = DeviceType.File;
            bkDeviceItem.Name = bkPath+databaseName+".bak";

            backup.Devices.Add(bkDeviceItem);
            backup.Incremental = false;
            backup.LogTruncation = BackupTruncateLogType.Truncate;
            backup.SqlBackup(server);
            #endregion
        }

        /// <summary>
        /// 备份数据库
        /// </summary>
        public static void RestoreDatabase()
        {
            string databaseName = "SMODemo";//备份的数据库名
            string bkPath = @"C:\";//存放备份后的数据的文件夹
            //创建ServerConnection的实例
            ServerConnection connection = new ServerConnection();
            //指定连接字符串
            connection.ConnectionString = "Data Source=goodapp;Initial Catalog=master;User ID=sa;Password=root;";
            //实例化Server
            Server server = new Server(connection);

            Restore restore = new Restore();
            restore.NoRecovery = false;
            restore.NoRewind = false;
            restore.Action = RestoreActionType.Database;
            restore.Database = databaseName;

            //创建备份设备
            BackupDeviceItem bkDeviceItem = new BackupDeviceItem();
            bkDeviceItem.DeviceType = DeviceType.File;
            bkDeviceItem.Name = bkPath + databaseName + ".bak";

            //如果需要重新制定Restore后的数据库的物理文件位置，需要知道数据库文件的逻辑文件名
            //可以RESTORE FILELISTONLY 来列出逻辑文件名，如果覆盖已有数据库可以通过SMO来获取
            //因本处使用的是刚刚备份的msdb数据库来Restore，所以其分别为"MSDBData"和"MSDBLog"
            //如果不指定Restore路径则默认恢复到数据库服务器存放数据的文件夹下
            RelocateFile relocateDataFile = new RelocateFile { LogicalFileName = "MSDBData", PhysicalFileName = bkPath + databaseName + ".mdf" };//(databaseName + "_data", bkPath + databaseName + ".mdf");
            RelocateFile relocateLogFile = new RelocateFile { LogicalFileName = "MSDBLog", PhysicalFileName = bkPath + databaseName + ".ldf" };//(databaseName + "_log", bkPath + databaseName + ".ldf");

            restore.Devices.Add(bkDeviceItem);
            restore.RelocateFiles.Add(relocateDataFile);
            restore.RelocateFiles.Add(relocateLogFile);
            restore.SqlRestore(server);
        }
    }
}

执行结果在这里就不贴图了，反正是是在周公家里的中文环境和办公室英文环境中测试通过。预先透漏一下，下一篇将讲述如何获取SQL Server的对象的创建SQL语句，比如表、存储过程、函数等。