Export (0) Print
Expand All
This topic has not yet been rated - Rate this topic

SqlServices Class

Supports installing and removing the SQL Server database elements of ASP.NET features.

System.Object
  System.Web.Management.SqlServices

Namespace:  System.Web.Management
Assembly:  System.Web (in System.Web.dll)
[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, Level = AspNetHostingPermissionLevel.High)]
public static class SqlServices

The SqlServices type exposes the following members.

  NameDescription
Public methodStatic memberGenerateApplicationServicesScriptsGenerates the SQL scripts for the selected features. The scripts will reference the database indicated by the database parameter.
Public methodStatic memberGenerateSessionStateScriptsGenerates the SQL script for installing or removing session state. The script will reference the database indicated by the database parameter.
Public methodStatic memberInstall(String, String, SqlFeatures)Installs components for selected ASP.NET features on a SQL Server database.
Public methodStatic memberInstall(String, SqlFeatures, String)Installs components for selected ASP.NET services on a SQL Server database.
Public methodStatic memberInstall(String, String, String, String, SqlFeatures)Installs components for selected ASP.NET features on a SQL Server database.
Public methodStatic memberInstallSessionState(String, String, SessionStateType)Installs components for ASP.NET session state on a SQL Server database.
Public methodStatic memberInstallSessionState(String, SessionStateType, String)Installs components for ASP.NET session state on a SQL Server database.
Public methodStatic memberInstallSessionState(String, String, String, String, SessionStateType)Installs components for ASP.NET session state on a SQL Server database.
Public methodStatic memberUninstall(String, String, SqlFeatures)Removes components for selected ASP.NET features from a SQL Server database.
Public methodStatic memberUninstall(String, SqlFeatures, String)Removes components for selected ASP.NET features from a SQL Server database.
Public methodStatic memberUninstall(String, String, String, String, SqlFeatures)Removes components for selected ASP.NET features from a SQL Server database.
Public methodStatic memberUninstallSessionState(String, String, SessionStateType)Removes components for ASP.NET session state from a SQL Server database.
Public methodStatic memberUninstallSessionState(String, SessionStateType, String)Removes components for ASP.NET session state from a SQL Server database.
Public methodStatic memberUninstallSessionState(String, String, String, String, SessionStateType)Removes components for ASP.NET session state from a SQL Server database.
Top

You can use SQL Server databases to store information for ASP.NET features such as session state, membership, Web parts personalization, and role management. These features require that the SQL Server database to which they are connected be properly configured before use. You can use the ASP.NET Register SQL tool (aspnet_regsql.exe) to do this, or you can call the static methods exposed by the SqlServices class directly from your code.

NoteNote

Using the aspnet_regsql.exe tool or the SqlServices class to configure the database only sets up the database that the providers will use with the proper tables, triggers, and stored procedures. Configuring the database in this way does not modify configuration files to specify that these features use the SQL Providers for these services.

The following code example shows how to use the SqlServices class.


using System;
using System.Web.Management;

namespace UsingSQLServices
{
	class UsingSqlServices
	{
		static void Main(string[] args)
		{
			try
			{
// Values to use.
string server = "ASPFeatureServer";
string database = "ASPFeatureDB";
string connectionString =
	"server=ASPFeatureServer, pooling=False, user=<user name>, password=<secure password>";
string user = "AspAdmin";
string password = "Secure Password"; // Use a sicure password.

// Install membership and personalization.
SqlServices.Install(database,
	SqlFeatures.Membership &
	SqlFeatures.Personalization,
	connectionString);

// Remove membership and personalization.
SqlServices.Uninstall(database,
	SqlFeatures.Membership &
	SqlFeatures.Personalization,
	connectionString);

// Install all features.
SqlServices.Install(server, database,
	SqlFeatures.All);

// Remove all features.
SqlServices.Uninstall(server, database,
	SqlFeatures.All);

// Install a custom session state database.
SqlServices.InstallSessionState(database,
	SessionStateType.Custom,
	connectionString);

// Remove a custom session state database.
SqlServices.UninstallSessionState(database,
	SessionStateType.Custom,
	connectionString);

// Install temporary session state.
SqlServices.InstallSessionState(server, null,
	SessionStateType.Temporary);

// Remove temporary session state.
SqlServices.UninstallSessionState(server, null,
	SessionStateType.Temporary);

// Install persisted session state.
SqlServices.InstallSessionState(server, user, password,
	null, SessionStateType.Persisted);

// Remove persisted session state.
SqlServices.UninstallSessionState(server, user, password,
	null, SessionStateType.Persisted);
			}
			catch (SqlExecutionException sqlExecutionException)
			{
Console.WriteLine(
	"An SQL execution exception occurred.");
Console.WriteLine();
Console.WriteLine("  Message: {0}",
	sqlExecutionException.Message);
Console.WriteLine("  Server: {0}",
	sqlExecutionException.Server);
Console.WriteLine("  Database: {0}",
	sqlExecutionException.Database);
Console.WriteLine("  Commands: {0}",
	sqlExecutionException.Commands);
Console.WriteLine("  SqlFile: {0}",
	sqlExecutionException.SqlFile);
Console.WriteLine("  Inner Exception: {0}",
	sqlExecutionException.Exception);
			}
			catch (Exception ex)
			{
Console.WriteLine("An unknown exception occurred.");
Console.WriteLine();
Console.WriteLine("  Message: {0}", ex.Message);
			}
		}
	}
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Did you find this helpful?
(1500 characters remaining)
Thank you for your feedback

Community Additions

ADD
Show:
© 2014 Microsoft. All rights reserved.