Export (0) Print
Expand All

SqlConnectionStringBuilder.InitialCatalog Property

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

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

'Declaration
Public Property InitialCatalog As String

Property Value

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

ExceptionCondition
ArgumentNullException

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()
        Try 
            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)
                connection.Open()
                ' Now use the open connection.
                Console.WriteLine("Database = " & connection.Database)
            End Using 

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

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft