SqlConnection.ChangeDatabase(String) Method

Reference

Definition

Namespace:: System.Data.SqlClient

Assembly:: System.Data.SqlClient.dll

Assembly:: System.Data.dll

Package:: System.Data.SqlClient v4.8.6

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Changes the current database for an open SqlConnection.

public:
 override void ChangeDatabase(System::String ^ database);

public:
 virtual void ChangeDatabase(System::String ^ database);

public override void ChangeDatabase (string database);

public void ChangeDatabase (string database);

override this.ChangeDatabase : string -> unit

abstract member ChangeDatabase : string -> unit
override this.ChangeDatabase : string -> unit

Public Overrides Sub ChangeDatabase (database As String)

Public Sub ChangeDatabase (database As String)

Parameters

database: String

The name of the database to use instead of the current database.

Implements

ChangeDatabase(String)

Exceptions

ArgumentException

The database name is not valid.

InvalidOperationException

The connection is not open.

SqlException

Cannot change the database.

Examples

The following example creates a SqlConnection and displays some of its read-only properties.

private static void ChangeSqlDatabase(string connectionString)
{
    // Assumes connectionString represents a valid connection string
    // to the AdventureWorks sample database.
    using (SqlConnection connection = new SqlConnection(connectionString))
    {
        connection.Open();
        Console.WriteLine("ServerVersion: {0}", connection.ServerVersion);
        Console.WriteLine("Database: {0}", connection.Database);

        connection.ChangeDatabase("Northwind");
        Console.WriteLine("Database: {0}", connection.Database);
    }
}

Private Sub ChangeSqlDatabase(ByVal connectionString As String)
    ' Assumes connectionString represents a valid connection string
    ' to the AdventureWorks sample database.
    Using connection As New SqlConnection(connectionString)

        connection.Open()
        Console.WriteLine("ServerVersion: {0}", connection.ServerVersion)
        Console.WriteLine("Database: {0}", connection.Database)

        connection.ChangeDatabase("Northwind")
        Console.WriteLine("Database: {0}", connection.Database)
    End Using
End Sub

Remarks

The value supplied in the database parameter must be a valid database name. The database parameter cannot contain a null value, an empty string, or a string with only blank characters.

Applies to

Share via