如何部署SQL Server Compact Edition 4.0？

Question

如何部署Microsoft SQL Server Compact 4.0?

---

SQL Server Compact Edition（当前版本为4.0）是：

一款免费的嵌入式数据库，软件开发人员可以用它来构建Windows桌面应用程序。 它体积小，支持在应用程序文件夹内私有部署其二进制文件。

但你该如何实际部署它呢？

• 微软表示它可以在应用程序文件夹中部署(好)，并支持xcopy部署。
• 微软还表示它不能在应用程序文件夹中部署(不好)，并且不支持xcopy部署。
• 一些人有使用简单xcopy部署的示例，但他们没有提供完成部署所需的详细信息

问题在于，除非注册ADO OLEdb提供程序，否则无法使用它。 注册OLEdb提供程序必须以管理员身份执行。 这意味着对于不是管理员的用户，SQL Server Compact版将失败。

SQL Server Compact 4.0附带了一个redist_enu.txt文件：

.exe文件列表中的每个文件都会在目标计算机上安装其封闭组件到特定位置。这有助于确保可维护性和技术支持。这些.exe文件中包含的.dll文件也可以在此redist.txt中单独使用。但是，这些单独的.dll发行可能导致可维护性问题。有关更多详细信息，请参见http://go.microsoft.com/fwlink/?LinkId=94589

通过BreadCrumb进行私有部署检测：仅部署本地堆栈并显式加载SQL Server Compact Assembly（通过Assembly.LoadFrom()、.local文件或使用DLL / COM重定向策略）的私有部署不受支持，可能导致可维护性问题。有关更多信息，请参见http://support.microsoft.com/kb/835322和http://msdn2.microsoft.com/en-us/library/aa375142.aspx

Microsoft SQL Server Compact 4.0

SSCERuntime_x86-ENU.exe
SSCERuntime_x86-DEU.exe
SSCERuntime_x86-FRA.exe
SSCERuntime_x86-JPN.exe
SSCERuntime_x86-RUS.exe
SSCERuntime_x86-ESN.exe
SSCERuntime_x86-ITA.exe
SSCERuntime_x86-KOR.exe
SSCERuntime_x86-CHT.exe
SSCERuntime_x86-CHS.exe
SSCERuntime_x64-ENU.exe
SSCERuntime_x64-DEU.exe
SSCERuntime_x64-FRA.exe
SSCERuntime_x64-JPN.exe
SSCERuntime_x64-RUS.exe
SSCERuntime_x64-ESN.exe
SSCER

C:\Program Files\Microsoft SQL Server Compact Edition\v4.0\
      sqlceoledb40.dll
      sqlceqp40.dll
      sqlcese40.dll
      sqlceca40.dll
      sqlcecompact40.dll
      sqlceer40EN.dll
      sqlceme40.dll

注意: 还有一些包含更多dll的子文件夹。

我尝试将这7个dll文件复制到一个文件夹中，并尝试使用ADO连接打开连接字符串：

Provider=Microsoft.SQLSERVER.CE.OLEDB.4.0;Data Source="store.sdf"

但是它会出现0x80004005 未指定错误

我试图扭动小部件，但它却扭曲了弗洛伯。

- Ian Boyd

---

我个人没有做过这个，但是文档不清楚吗？http://msdn.microsoft.com/en-us/library/aa983326(v=vs.110).aspx - Pondlife

请查看我的博客文章：http://erikej.blogspot.com/2011/02/using-sql-server-compact-40-with.html，使用SQL Server Compact 4.0与桌面私有部署和安装项目（MSI）（第2部分）。 - ErikEJ

你引用了 app.config，我猜想这是一个.NET应用程序。而我正在使用一个本地应用程序并采用xcopy部署。 - Ian Boyd

@Pondlife，“如何：使用应用程序部署 SQL Server Compact 4.0 数据库”页面非常清晰明了。不幸的是，它并不能正常工作。他们假设一个.NET应用程序，并忽略了OLEDB COM dll“sqlceoledb40.dll”的必需注册。 - Ian Boyd

在文档永久消失之前，通过备份来记录此帖子！ - user8529958

Answer 1

我已经创建了解决方案。

SQL Server Compact Edition由7个dll组成：

• sqlceme40.dll 未记录的本地平面API库（.net System.Data.SqlServerCe.dll程序集是这个dll的包装器）
• sqlceca40.dll 实现Engine、Replication、Error和其他几个COM对象的COM dll
• sqlceoledb40.dll 实现SSCE的OLEdb提供程序的COM dll（允许使用ADO）
• sqlcese40.dll 未知
• sqlceqp40.dll 未知
• sqlcecompact40.dll 未知
• sqlceer40en.dll 未知

尝试简单地发行这些dll存在问题，因为其中两个是COM对象。COM对象dll需要进行注册，例如:

>regsvr32 sqlceca40.dll
>regsvr32 sqlceoledb40.dll

问题在于注册COM对象需要 管理员 权限(使用全局解决方案来解决本地问题)。这意味着您的用户会

• 必须安装您的应用程序(但您不希望这样做)
• 需要您的用户拥有管理员权限(但您不希望这样做)

幸运的是，从Windows XP开始，微软解决了这个常见的问题: 无需注册即可使用的COM。

首先，您将声明您的应用程序依赖于 SQL Server Compact Edition 4.0。为此，您需要编写一个程序集清单：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0"> 
    <assemblyIdentity 
        version="1.0.0.0"
        processorArchitecture="X86"
        name="client"
        type="win32"
    /> 

    <description>Hyperion Pro</description> 

    <!-- We have a dependancy on SQL Server CE 4.0 -->
    <dependency>
        <dependentAssembly>
            <assemblyIdentity
                type="win32"
                name="Microsoft.SQLSERVER.CE.4.0"
                version="4.0.0.0" processorArchitecture="x86"
            />
        </dependentAssembly>
    </dependency>

    <!-- We are high-dpi aware on Windows Vista -->
    <asmv3:application xmlns:asmv3="urn:schemas-microsoft-com:asm.v3">
        <asmv3:windowsSettings
            xmlns="http://schemas.microsoft.com/SMI/2005/WindowsSettings">
            <dpiAware>true</dpiAware>
        </asmv3:windowsSettings>
    </asmv3:application>

    <!-- We were designed and tested on Windows 7 -->
    <compatibility xmlns="urn:schemas-microsoft-com:compatibility.v1">
        <application>
            <!--The ID below indicates application support for Windows 7 -->
            <supportedOS Id="{35138b9a-5d96-4fbd-8e2d-a2440225f93a}"/>
            <!--The ID below indicates application support for Windows Vista -->
            <!--supportedOS Id="{e2011457-1546-43c5-a5fe-008deee3d3f0}"/-->
        </application>
    </compatibility>

    <!-- Disable file and registry virtualization -->
    <trustInfo xmlns="urn:schemas-microsoft-com:asm.v2">
        <security>
            <requestedPrivileges>
                <requestedExecutionLevel level="asInvoker" uiAccess="false"/>
            </requestedPrivileges>
        </security>
    </trustInfo>
</assembly>

您可以将这个文件 放在 您的可执行文件旁边（作为 Hyperion.exe.manifest），或者将其构建为您的应用程序的一个 RT_MANIFEST 资源。

请注意，我们依赖一个名为 Microsoft.SQLSERVER.CE.4.0 的程序集。我们首先创建这个程序集，创建一个名为：

Microsoft.SQLSERVER.CE.4.0

当您部署您的应用程序时，您将把包含此 "程序集" 的 7 个 dll 文件和一个特殊的 .manifest 文件一起放置在这个 Microsoft.SQLSERVER.CE.4.0 子文件夹中。

C:\
╰──Users
   ╰──Ian
      ╰──AppData
         ╰──Local
            ╰──Hyperion Pro
               ├──Hyperion.exe
               ├──Hyperion.exe.manifest
               ╰──Microsoft.SQLSERVER.CE.4.0
                  ├──sqlceme40.dll
                  ├──sqlceca40.dll
                  ├──sqlceoledb40.dll
                  ├──sqlcese40.dll
                  ├──sqlceqp40.dll
                  ├──sqlcecompact40.dll
                  ├──sqlceer40en.dll
                  ╰──Microsoft.SQLSERVER.CE.4.0.manifest

换句话说，应用程序文件夹包含您的应用程序和 Microsoft.SQLSERVER.CE.4.0 文件夹：

 Directory of C:\Users\Ian\AppData\Local\Hyperion Pro

05/29/2012  09:23 AM         1,899,008 Hyperion.exe
05/28/2012  01:46 PM             1,587 Hyperion.exe.manifest
05/29/2012  09:27 AM    <DIR>          Microsoft.SQLSERVER.CE.4.0
           2 File(s)      1,900,675 bytes
           1 Dir(s)  20,851,503,104 bytes free

您的下一个任务是定义Microsoft.SQLSERVER.CE.4.0.manifest文件。无需注册 COM 允许清单文件声明所有 COM 对象和它们的 clsid。这需要大量的逆向工程。但 SQL Server Compact Edition 4.0 的程序集清单为：

Microsoft.SQLSERVER.CE.4.0.manifest：

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<assembly xmlns="urn:schemas-microsoft-com:asm.v1" manifestVersion="1.0">

<assemblyIdentity 
       type="win32"
       name="Microsoft.SQLSERVER.CE.4.0"
       processorArchitecture="x86"
       version="4.0.0.0" />

<!-- OLEDB Provider -->
<file name = "sqlceoledb40.dll">
    <comClass
            description = "Microsoft SQL Server Compact OLE DB Provider for Windows"
            clsid="{2006C53A-C915-41EA-BAA9-9EAB3A1FBF97}"
            threadingModel = "Both"
            progid = "Microsoft.SQLSERVER.CE.OLEDB.4.0" />
</file>

<!-- Native flat engine library -->
<file name="sqlceme40.dll" />

<!-- Engine and Replication COM object -->
<file name="sqlceca40.dll">
    <comClass description="Active SSCE Engine Object"
            clsid="{68D45319-3702-4837-9F8E-DA6845D82482}"
            threadingModel="Both"
            progid="SSCE.Engine.4.0" />
    <comClass description="SSCE Error Object"
            clsid="{36228F21-B5C7-4054-8DC2-47D3E236E8B5}"
            threadingModel="Both"
            progid="SSCE.Error.4.0" />
    <comClass description="SSCE Param Object"
            clsid="{0B3A7B75-A9B0-4580-9AA5-1A7DA47AD1CB}"
            threadingModel="Both"
            progid="SSCE.Param.4.0" />
    <comClass description="Active SSCE Replication Object"
            clsid="{11D5B2D4-26A4-44F5-A48B-0FAC3A919ED8}"
            threadingModel="Both"
            progid="SSCE.Replication.4.0" />
    <comClass description="Active SSCE remote data access Object"
            clsid="{58BC9AD6-BF11-40B3-9AB1-E3F2ED784C08}"
            threadingModel="Both"
            progid="SSCE.RemoteDataAccess.4.0" />

    <typelib tlbid="{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}"
            version="4.0" 
            helpdir=""/>
</file>

<comInterfaceExternalProxyStub 
    name="ISSCEEngine"
    iid="{10EC3E45-0870-4D7B-9A2D-F4F81B6B7FA2}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCEError"
    iid="{31155A3B-871D-407F-9F73-DEBFAC7EFBE3}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCERDA"
    iid="{4F04F79D-1FF1-4DCD-802B-3D51B9356C14}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCEParams"
    iid="{A78AFF90-049C-41EC-B1D8-665968AAC4A6}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCEParam"
    iid="{A9876C60-2667-44E5-89DB-E9A46ED392C0}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCEErrors"
    iid="{C40143CA-E9F9-4FF4-B8B4-CC02C064FC1B}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<comInterfaceExternalProxyStub 
    name="ISSCEMerge"
    iid="{C6EB397F-D585-428D-A4F4-454A1842CB47}"
    proxyStubClsid32="{00020424-0000-0000-C000-000000000046}"
    baseInterface="{00000000-0000-0000-C000-000000000046}"
    tlbid = "{CE4AACFA-3CFD-4028-B2D9-F272314F07C8}" />

<file name="sqlceqp40.dll" />
<file name="sqlcese40.dll" />
<file name="sqlcecompact40.dll" />
<file name="sqlceer40EN.dll" />

</assembly>

最后一个需要注意的是，就像我们依赖于一个叫做Microsoft.SQLSERVER.CE.4.0的程序集一样，SQL Server Compact Edition 4.0也依赖于一个名为Microsoft.VC90.CRT的程序集。幸运的是，你安装的SQLCE附带了这个程序集的一个副本：

Microsoft.VC90.CRT
├──Microsoft.VC90.CRT.manifest 
╰──msvcr90.dll

这意味着最终的目录结构如下：

C:\
╰──Users
   ╰──Ian
      ╰──AppData
         ╰──Local
            ╰──Hyperion Pro
               ├──Hyperion.exe
               ├──Hyperion.exe.manifest
               ╰──Microsoft.SQLSERVER.CE.4.0
                  ├──Microsoft.SQLSERVER.CE.4.0.manifest
                  ├──sqlceme40.dll
                  ├──sqlceca40.dll
                  ├──sqlceoledb40.dll
                  ├──sqlcese40.dll
                  ├──sqlceqp40.dll
                  ├──sqlcecompact40.dll
                  ├──sqlceer40en.dll
                  ╰──Microsoft.VC90.CRT
                     ├──Microsoft.VC90.CRT.manifest
                     ╰──msvcr90.dll
               

- Ian Boyd

---

哎呀，绕了一大圈。其实有更简单的方法：私有部署。你甚至可以更进一步，不需要将私有程序集和VC++文件复制到项目中，只需链接它们并将构建操作设置为“仅在新建时复制”。 - InteXX

@InteXX 所有这些都需要并假定使用Visual Studio。还有其他的IDE可以构建本地Win32/64可执行文件。 - Ian Boyd

是的，你说得对。那个特定的私有部署过程只适用于Visual Studio。其他人需要另一种方式。这是一个关于无需注册COM的好文章。下次我需要做这个的时候，我会参考它。干得好。 - InteXX

我不确定你在这里使用“Hyperion”的意思。这是你的应用程序的名称还是必须包含的文字？ - InteXX

@InteXX Hyperion是一个应用程序的虚构名称。 - Ian Boyd

除非我将以下文件移动到可执行文件的同一目录中，否则它在 Windows 10 的 64 位版本下无法工作：sqlcese40.dll、sqlceme40.dll 和 sqlceqp40.dll。 - FKDev

Answer 2

对于 Sql Server Ce 4.0 SP1 版本：

不必处理所有繁琐的部署细节，我选择将设置文件作为 EmbeddedResource 包含在我的 exe 文件中，并编写了以下小助手：

 public static class RedistHelper
    {
        private static readonly ILog Log = LogManager.GetLogger(
                                              MethodBase.GetCurrentMethod().DeclaringType);

        private static readonly string SqlCeRedistName64 = "SSCERuntime_x64-ENU.exe";
        private static readonly string SqlCeRedistName32 = "SSCERuntime_x86-ENU.exe";
        private static readonly Dictionary<string, Assembly> Assemblies = 
                        new Dictionary<string, Assembly>(StringComparer.OrdinalIgnoreCase);

        private static string SqlCeRedistName
        {
            get 
            {
                return Environment.Is64BitOperatingSystem 
                                       ? SqlCeRedistName64 
                                       : SqlCeRedistName32;
            }
        }

        public static bool IsSqlCeInstalled()
        {
            RegistryKey localKey = RegistryKey.OpenBaseKey(RegistryHive.LocalMachine,
                                                           RegistryView.Registry64);
            RegistryKey ret = localKey.OpenSubKey(
                    @"SOFTWARE\Microsoft\Microsoft SQL Server Compact Edition\v4.0\ENU");
            return ret != null;
        }

        private static byte[] ReadFully(Stream input)
        {
            byte[] buffer = new byte[16 * 1024];
            using (MemoryStream ms = new MemoryStream())
            {
                int read;
                while ((read = input.Read(buffer, 0, buffer.Length)) > 0)
                    ms.Write(buffer, 0, read);
                return ms.ToArray();
            }
        }

        public static Assembly OnCurrentDomainOnAssemblyResolve(object sender,
                                                                ResolveEventArgs args)
        {
            Assembly dll;
            var name = new AssemblyName(args.Name).Name + ".dll";
            if (!Assemblies.TryGetValue(name, out dll))
            {
                Assembly res = typeof(RedistHelper).Assembly;
                using (Stream input =
                           res.GetManifestResourceStream(typeof(RedistHelper), name))
                {
                    if (input == null)
                    {
                        Log.WarnFormat("Assembly {0} does not contain {1}", res, name);
                        return null;
                    }
                    dll = Assembly.Load(ReadFully(input));
                    if (dll == null)
                    {
                        Log.WarnFormat("Assembly {0} failed to load.", name);
                        return null;
                    }
                    Log.InfoFormat("Loaded assembly {0}.", name);
                    Assemblies[name] = dll;
                    return dll;
                }
            }
            return dll;
        }

        public static void InstallSqlCe()
        {
            using (Stream stream =
                       typeof(RedistHelper).Assembly.GetManifestResourceStream(
                           typeof(RedistHelper), SqlCeRedistName))
            {
                Debug.Assert(stream != null);
                byte[] bytes = new byte[(int)stream.Length];
                stream.Read(bytes, 0, bytes.Length);
                string path = Path.Combine(Path.GetTempPath(), SqlCeRedistName);

                if (File.Exists(path))
                    File.Delete(path);

                File.WriteAllBytes(path, bytes);

                Process process = new Process
                                  {
                                      StartInfo = new ProcessStartInfo
                                                  {
                                                      FileName = path,
                                                      UseShellExecute = true
                                                  }
                                  };
                process.Start();
                process.WaitForExit();
            }
        }
    }

唯一让我头痛的是引用 System.Data.SqlServerCe.dll - 它无法合并，因此我在我的主程序中按需加载它：

AppDomain.CurrentDomain.AssemblyResolve += RedistHelper.OnCurrentDomainOnAssemblyResolve;

- Casper Leon Nielsen

Answer 3

不确定是否有所改变。但是使用最新的SQL Server CE nuget包后，应用程序清单不再需要。您将获得两组二进制文件：x86和amd64。只需将它们复制到x86和/或amd64子目录下的目标文件夹中即可。

|--Your App Dir
   |--x86 (x86 sql ce binaries)
   |--amd64 (amd64 sql ce binaries)

现在你已经准备好了。看起来 System.Data.SqlCe.dll 可以自动找到并加载本地二进制文件。如果你的应用程序只针对一个平台，你也可以将它们部署在应用程序目录中。

- Shao Skywalker