SqlServices Class

SqlServices Class

 

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

Namespace:   System.Web.Management
Assembly:  System.Web (in System.Web.dll)

System.Object
  System.Web.Management.SqlServices

[AspNetHostingPermissionAttribute(SecurityAction.LinkDemand, 
	Level = AspNetHostingPermissionLevel.High)]
public static class SqlServices

NameDescription
System_CAPS_pubmethodSystem_CAPS_staticGenerateApplicationServicesScripts(Boolean, SqlFeatures, String)

Generates the SQL scripts for the selected features. The scripts will reference the database indicated by the database parameter.

System_CAPS_pubmethodSystem_CAPS_staticGenerateSessionStateScripts(Boolean, SessionStateType, String)

Generates the SQL script for installing or removing session state. The script will reference the database indicated by the database parameter.

System_CAPS_pubmethodSystem_CAPS_staticInstall(String, SqlFeatures, String)

Installs components for selected ASP.NET services on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticInstall(String, String, SqlFeatures)

Installs components for selected ASP.NET features on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticInstall(String, String, String, String, SqlFeatures)

Installs components for selected ASP.NET features on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticInstallSessionState(String, SessionStateType, String)

Installs components for ASP.NET session state on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticInstallSessionState(String, String, SessionStateType)

Installs components for ASP.NET session state on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticInstallSessionState(String, String, String, String, SessionStateType)

Installs components for ASP.NET session state on a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstall(String, SqlFeatures, String)

Removes components for selected ASP.NET features from a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstall(String, String, SqlFeatures)

Removes components for selected ASP.NET features from a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstall(String, String, String, String, SqlFeatures)

Removes components for selected ASP.NET features from a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstallSessionState(String, SessionStateType, String)

Removes components for ASP.NET session state from a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstallSessionState(String, String, SessionStateType)

Removes components for ASP.NET session state from a SQL Server database.

System_CAPS_pubmethodSystem_CAPS_staticUninstallSessionState(String, String, String, String, SessionStateType)

Removes components for ASP.NET session state from a SQL Server database.

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.

System_CAPS_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
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show:
© 2016 Microsoft