SqlConnectionStringBuilder.InitialCatalog Property


The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Gets or sets the name of the database associated with the connection.

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

Public Property InitialCatalog As String

Property Value

Type: System.String

The value of the InitialCatalog property, or String.Empty if none has been supplied.

Exception Condition

To set the value to null, use Value.

This property corresponds to the "Initial Catalog" and "database" keys within the connection string.

The following example creates a simple connection string and then uses the SqlConnectionStringBuilder class to add the name of the database to the connection string. The code displays the contents of the InitialCatalog property, just to verify that the class was able to convert from the synonym ("Database") to the appropriate property value.

Imports System.Data.SqlClient

Module Module1
    Sub Main()
            Dim connectString As String = _
             "Data Source=(local);" & _
             "Integrated Security=True"

            Dim builder As New SqlConnectionStringBuilder(connectString)
            Console.WriteLine("Original: " & builder.ConnectionString)

            ' Normally, you could simply set the InitialCatalog
            ' property of the SqlConnectionStringBuilder object. This
            ' example uses the default Item property (the C# indexer)
            ' and the "Database" string, simply to demonstrate that
            ' setting the value in this way results in the same
            ' connection string.
            builder("Database") = "AdventureWorks"
            Console.WriteLine("builder.InitialCatalog = " _
                & builder.InitialCatalog)
            Console.WriteLine("Modified: " & builder.ConnectionString)

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

        Catch ex As Exception
        End Try

        Console.WriteLine("Press any key to finish.")
    End Sub
End Module

.NET Framework
Available since 2.0
Return to top