SqlConnectionStringBuilder.InitialCatalog Property

Note: This property is new in the .NET Framework version 2.0.

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
'Usage
Dim instance As SqlConnectionStringBuilder
Dim value As String

value = instance.InitialCatalog

instance.InitialCatalog = value
/** @property */
public String get_InitialCatalog ()

/** @property */
public void set_InitialCatalog (String value)

public function get InitialCatalog () : String

public function set InitialCatalog (value : String)

Property Value

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

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

If the value passed in is null when you try to set the property, the InitialCatalog property is reset. If the value has not been set and the developer tries to retrieve the property, the return value is String.Empty.

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

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

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

.NET Framework

Supported in: 2.0

Community Additions

ADD
Show: