SqlServices Class

Definition

Namespace:

System.Web.Management

Assembly:

System.Web.dll

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

public ref class SqlServices abstract sealed

public static class SqlServices

type SqlServices = class

Public Class SqlServices

Inheritance

Object

SqlServices

Examples

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);
            }
        }
    }
}

Imports System.Web.Management

Module UsingSqlServices
    Sub Main()
        Try
' Values to use.
Dim server As String = "ASPFeatureServer"
Dim database As String = "ASPFeatureDB"
Dim connectionString As String = _
    "server=ASPFeatureServer, pooling=False, user=<user name>, password=<secure password>"
Dim user As String = "AspAdmin"
Dim password As String = "Secure Password"

' Install membership and personalization.
SqlServices.Install(database, _
    SqlFeatures.Membership And _
    SqlFeatures.Personalization, _
    connectionString)

' Remove membership and personalization.
SqlServices.Uninstall(database, _
    SqlFeatures.Membership And _
    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, Nothing, _
    SessionStateType.Temporary)

' Remove temporary session state.
SqlServices.UninstallSessionState(server, Nothing, _
    SessionStateType.Temporary)

' Install persisted session state.
SqlServices.InstallSessionState(server, user, password, _
    Nothing, SessionStateType.Persisted)

' Remove persisted session state.
SqlServices.UninstallSessionState(server, user, password, _
    Nothing, SessionStateType.Persisted)
        Catch sqlExecutionException As 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 ex As Exception
Console.WriteLine("An unknown exception occurred.")
Console.WriteLine()
Console.WriteLine("  Message: {0}", ex.Message)
        End Try
    End Sub
End Module

Remarks

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.

Note

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.

Methods

GenerateApplicationServicesScripts(Boolean, SqlFeatures, String)	Generates the SQL scripts for the selected features. The scripts will reference the database indicated by the database parameter.
GenerateSessionStateScripts(Boolean, SessionStateType, String)	Generates the SQL script for installing or removing session state. The script will reference the database indicated by the database parameter.
Install(String, SqlFeatures, String)	Installs components for selected ASP.NET services on a SQL Server database.
Install(String, String, SqlFeatures)	Installs components for selected ASP.NET features on a SQL Server database.
Install(String, String, String, String, SqlFeatures)	Installs components for selected ASP.NET features on a SQL Server database.
InstallSessionState(String, SessionStateType, String)	Installs components for ASP.NET session state on a SQL Server database.
InstallSessionState(String, String, SessionStateType)	Installs components for ASP.NET session state on a SQL Server database.
InstallSessionState(String, String, String, String, SessionStateType)	Installs components for ASP.NET session state on a SQL Server database.
Uninstall(String, SqlFeatures, String)	Removes components for selected ASP.NET features from a SQL Server database.
Uninstall(String, String, SqlFeatures)	Removes components for selected ASP.NET features from a SQL Server database.
Uninstall(String, String, String, String, SqlFeatures)	Removes components for selected ASP.NET features from a SQL Server database.
UninstallSessionState(String, SessionStateType, String)	Removes components for ASP.NET session state from a SQL Server database.
UninstallSessionState(String, String, SessionStateType)	Removes components for ASP.NET session state from a SQL Server database.
UninstallSessionState(String, String, String, String, SessionStateType)	Removes components for ASP.NET session state from a SQL Server database.

See also

• Installing the SQL Server Provider Database
• Session State Modes