SqlConnectionStringBuilder.AttachDBFilename Property (System.Data.SqlClient)

AttachDBFilename Property

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

SqlConnectionStringBuilder..::.AttachDBFilename Property

Updated: November 2007

Gets or sets a string that contains the name of the primary data file. This includes the full path name of an attachable database.

Namespace: System.Data.SqlClient
Assembly: System.Data (in System.Data.dll)

Syntax

Visual Basic (Declaration)

Public Property AttachDBFilename As String

Visual Basic (Usage)

Dim instance As SqlConnectionStringBuilder
Dim value As String

value = instance.AttachDBFilename

instance.AttachDBFilename = value

public string AttachDBFilename { get; set; }

Visual C++

public:
property String^ AttachDBFilename {
    String^ get ();
    void set (String^ value);
}

/** @property */
public String get_AttachDBFilename()
/** @property */
public  void set_AttachDBFilename(String value)

JScript

public function get AttachDBFilename () : String
public function set AttachDBFilename (value : String)

Property Value

Type: System..::.String

The value of the AttachDBFilename property, or String.Empty if no value has been supplied.

Remarks

This property corresponds to the "AttachDBFilename", "extended properties", and "initial file name" keys within the connection string. If the value passed in is null when you try to set the property, the AttachDBFilename property is reset. If the value has not been set and the developer tries to retrieve the property, the return value is String.Empty.

Note:
If the primary data file (.mdf) is read-only, the attachment will fail because the log path inside of the .mdf file needs to be updated. This could occur if the file has been copied from a CD. Change the file attribute to read/write prior to attaching it. AttachDBFilename is only supported for primary data files with an .mdf extension.

An error will be generated if a log file exists in the same directory as the data file and the 'database' keyword is used when attaching the primary data file. In this case, remove the log file. Once the database is attached, a new log file will be automatically generated based on the physical path.

Examples

The following example creates a new SqlConnectionStringBuilder instance, and sets the AttachDBFilename property in order to specify the name of an attached data file.

Visual Basic

Imports System.Data.SqlClient

Module Module1
    Sub Main()
        Try
            Dim connectString As String = _
             "Server=(local);" & _
             "Integrated Security=True"
            Dim builder As New SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)
            Console.WriteLine("AttachDBFileName={0}", _
             builder.AttachDBFilename)
            builder.AttachDBFilename = "C:\MyDatabase.mdf"
            Console.WriteLine("Modified: " & builder.ConnectionString)

            Using connection As New SqlConnection(builder.ConnectionString)
                connection.Open()
                ' Now use the open connection.
                Console.WriteLine("Database = " & connection.Database)
            End Using

            Console.WriteLine("Press any key to finish.")
            Console.ReadLine()

        Catch ex As Exception
            Console.WriteLine(ex.Message)
        End Try
    End Sub
End Module

using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString =
                "Server=(local);" +
                "Integrated Security=true";
            SqlConnectionStringBuilder builder =
                new SqlConnectionStringBuilder(connectString);
            Console.WriteLine("Original: " + builder.ConnectionString);
            Console.WriteLine("AttachDBFileName={0}", builder.AttachDBFilename);

            builder.AttachDBFilename = @"C:\MyDatabase.mdf";
            Console.WriteLine("Modified: " + builder.ConnectionString);

            using (SqlConnection connection = new SqlConnection(builder.ConnectionString))
            {
                connection.Open();
                // Now use the open connection.
                Console.WriteLine("Database = " + connection.Database);
            }
            Console.WriteLine("Press any key to finish.");
            Console.ReadLine();
        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }
}

Platforms

Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

The .NET Framework and .NET Compact Framework do not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Version Information