SqlConnectionStringBuilder.InitialCatalog Property

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

[System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlInitialCatalogConverter))]
public string InitialCatalog { get; set; }

public string InitialCatalog { get; set; }

[<System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlInitialCatalogConverter))>]
member this.InitialCatalog : string with get, set

member this.InitialCatalog : string with get, set

Public Property InitialCatalog As String

Property Value

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

Attributes

TypeConverterAttribute

Exceptions

Examples

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.

using Microsoft.Data.SqlClient;

class Program
{
    static void Main()
    {
        try
        {
            string connectString = "Data Source=(local);" +
                "Integrated Security=true";

            SqlConnectionStringBuilder builder =
                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 (SqlConnection connection =
                new SqlConnection(builder.ConnectionString))
            {
                connection.Open();
                // Now use the open connection.
                Console.WriteLine("Database = " + connection.Database);
            }

        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }

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

Remarks

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

The database name can be 128 characters or less.

Applies to