SqlConnectionStringBuilder Klasa

Definicja

Przestrzeń nazw:

System.Data.SqlClient

Zestaw:

System.Data.SqlClient.dll

Pakiet:

System.Data.SqlClient v4.8.6

Zapewnia prosty sposób tworzenia zawartości parametrów połączenia używanych przez klasę SqlConnection i zarządzania nimi.

public ref class SqlConnectionStringBuilder sealed : System::Data::Common::DbConnectionStringBuilder

public sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

type SqlConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class SqlConnectionStringBuilder
Inherits DbConnectionStringBuilder

Dziedziczenie

Object

DbConnectionStringBuilder

SqlConnectionStringBuilder

Przykłady

Poniższa aplikacja konsolowa tworzy parametry połączenia dla bazy danych SQL Server. Kod używa SqlConnectionStringBuilder klasy do utworzenia parametry połączenia, a następnie przekazuje ConnectionString właściwość SqlConnectionStringBuilder wystąpienia do konstruktora klasy połączenia. Przykład analizuje również istniejącą parametry połączenia i demonstruje różne sposoby manipulowania zawartością parametry połączenia.

Uwaga

Ten przykład zawiera hasło, które pokazuje, jak SqlConnectionStringBuilder działa z parametrami połączenia. W aplikacjach zalecamy użycie uwierzytelniania systemu Windows. Jeśli musisz użyć hasła, nie dołączaj w aplikacji trwale zakodowanego hasła.

using System.Data;
using System.Data.SqlClient;

class Program
{
    static void Main()
    {
        // Create a new SqlConnectionStringBuilder and
        // initialize it with a few name/value pairs.
        SqlConnectionStringBuilder builder =
            new SqlConnectionStringBuilder(GetConnectionString());

        // The input connection string used the
        // Server key, but the new connection string uses
        // the well-known Data Source key instead.
        Console.WriteLine(builder.ConnectionString);

        // Pass the SqlConnectionStringBuilder an existing
        // connection string, and you can retrieve and
        // modify any of the elements.
        builder.ConnectionString = "server=(local);user id=ab;" +
            "password= a!Pass113;initial catalog=AdventureWorks";

        // Now that the connection string has been parsed,
        // you can work with individual items.
        Console.WriteLine(builder.Password);
        builder.Password = "new@1Password";
        builder.AsynchronousProcessing = true;

        // You can refer to connection keys using strings,
        // as well. When you use this technique (the default
        // Item property in Visual Basic, or the indexer in C#),
        // you can specify any synonym for the connection string key
        // name.
        builder["Server"] = ".";
        builder["Connect Timeout"] = 1000;
        builder["Trusted_Connection"] = true;
        Console.WriteLine(builder.ConnectionString);

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

    private static string GetConnectionString()
    {
        // To avoid storing the connection string in your code,
        // you can retrieve it from a configuration file.
        return "Server=(local);Integrated Security=SSPI;" +
            "Initial Catalog=AdventureWorks";
    }
}

Imports System.Data.SqlClient

Module Module1
    Sub Main()
        ' Create a new SqlConnectionStringBuilder and
        ' initialize it with a few name/value pairs:
        Dim builder As New SqlConnectionStringBuilder(GetConnectionString())

        ' The input connection string used the 
        ' Server key, but the new connection string uses
        ' the well-known Data Source key instead.
        Console.WriteLine(builder.ConnectionString)

        ' Pass the SqlConnectionStringBuilder an existing 
        ' connection string, and you can retrieve and
        ' modify any of the elements.
        builder.ConnectionString = _
            "server=(local);user id=ab;" & _
            "password=a!Pass113;initial catalog=AdventureWorks"
        ' Now that the connection string has been parsed,
        ' you can work with individual items.
        Console.WriteLine(builder.Password)
        builder.Password = "new@1Password"
        builder.AsynchronousProcessing = True

        ' You can refer to connection keys using strings, 
        ' as well. When you use this technique (the default
        ' Item property in Visual Basic, or the indexer in C#)
        ' you can specify any synonym for the connection string key
        ' name.
        builder("Server") = "."
        builder("Connect Timeout") = 1000

        ' The Item property is the default for the class, 
        ' and setting the Item property adds the value to the 
        ' dictionary, if necessary. 
        builder.Item("Trusted_Connection") = True
        Console.WriteLine(builder.ConnectionString)

        Console.WriteLine("Press Enter to finish.")
        Console.ReadLine()
    End Sub

    Private Function GetConnectionString() As String
        ' To avoid storing the connection string in your code,
        ' you can retrieve it from a configuration file. 
        Return "Server=(local);Integrated Security=SSPI;" & _
          "Initial Catalog=AdventureWorks"
    End Function
End Module

Uwagi

Konstruktor parametry połączenia umożliwia deweloperom programowe tworzenie składniowo poprawnych parametrów połączenia oraz analizowanie i ponowne kompilowanie istniejących parametrów połączenia przy użyciu właściwości i metod klasy. Konstruktor parametry połączenia udostępnia silnie typizowane właściwości odpowiadające znanym parom klucz/wartość dozwolonym przez SQL Server. Deweloperzy, którzy muszą tworzyć parametry połączenia w ramach aplikacji, mogą używać SqlConnectionStringBuilder klasy do tworzenia i modyfikowania parametrów połączenia. Klasa ułatwia również zarządzanie parametrami połączenia przechowywanymi w pliku konfiguracji aplikacji.

Funkcja SqlConnectionStringBuilder wykonuje testy prawidłowych par klucz/wartość. W związku z tym nie można użyć tej klasy do utworzenia nieprawidłowych parametrów połączenia; Próba dodania nieprawidłowych par zgłosi wyjątek. Klasa utrzymuje stałą kolekcję synonimów i może tłumaczyć się z synonimu na odpowiednią dobrze znaną nazwę klucza.

Jeśli na przykład używasz właściwości Item do pobrania wartości, możesz określić ciąg zawierający dowolny synonim potrzebnego klucza. Można na przykład określić "Adres sieciowy", "addr" lub dowolny inny akceptowalny synonim tego klucza w parametry połączenia, gdy używasz dowolnego elementu członkowskiego wymagającego ciągu zawierającego nazwę klucza, takiego jak właściwość Item lub Remove metoda. Zobacz właściwość , ConnectionString aby uzyskać pełną listę dopuszczalnych synonimów.

Właściwość Item próbuje wstawić złośliwe wpisy. Na przykład poniższy kod, używając domyślnej właściwości Item (indeksator w języku C#) poprawnie ucieka przed zagnieżdżonym parą klucz/wartość:

Dim builder As New System.Data.SqlClient.SqlConnectionStringBuilder
builder("Data Source") = "(local)"
builder("Integrated Security") = True
builder("Initial Catalog") = "AdventureWorks;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)

System.Data.SqlClient.SqlConnectionStringBuilder builder =
  new System.Data.SqlClient.SqlConnectionStringBuilder();
builder["Data Source"] = "(local)";
builder["integrated Security"] = true;
builder["Initial Catalog"] = "AdventureWorks;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);

Wynik jest następujący parametry połączenia, który obsługuje nieprawidłową wartość w bezpieczny sposób:

Source=(local);Initial Catalog="AdventureWorks;NewValue=Bad";
Integrated Security=True

Konstruktory

SqlConnectionStringBuilder()	Inicjuje nowe wystąpienie klasy SqlConnectionStringBuilder.
SqlConnectionStringBuilder(String)	Inicjuje nowe wystąpienie klasy SqlConnectionStringBuilder. Podany parametry połączenia dostarcza dane dla informacji o połączeniu wewnętrznym wystąpienia.

Właściwości

ApplicationIntent	Deklaruje typ obciążenia aplikacji podczas nawiązywania połączenia z bazą danych w grupie dostępności SQL Server. Możesz ustawić wartość tej właściwości za pomocą polecenia ApplicationIntent. Aby uzyskać więcej informacji na temat obsługi klienta SqlClient dla zawsze włączonych grup dostępności, zobacz SqlClient Support for High Availability, Disaster Recovery (Obsługa klienta SqlClient pod kątem wysokiej dostępności i odzyskiwania po awarii).
ApplicationName	Pobiera lub ustawia nazwę aplikacji skojarzonej z parametry połączenia.
AttachDBFilename	Pobiera lub ustawia ciąg zawierający nazwę podstawowego pliku danych. Obejmuje to pełną nazwę ścieżki dołączanej bazy danych.
BrowsableConnectionString	Pobiera lub ustawia wartość wskazującą, czy ConnectionString właściwość jest widoczna dla projektantów programu Visual Studio. (Odziedziczone po DbConnectionStringBuilder)
ConnectionString	Pobiera lub ustawia parametry połączenia skojarzone z elementem DbConnectionStringBuilder. (Odziedziczone po DbConnectionStringBuilder)
ConnectRetryCount	Liczba ponownych połączeń podjęta po zidentyfikowaniu, że wystąpił błąd bezczynności połączenia. Musi to być liczba całkowita z zakresu od 0 do 255. Domyślna wartość wynosi 1. Ustaw wartość 0, aby wyłączyć ponowne nawiązywanie połączenia w przypadku niepowodzeń bezczynności połączenia. Wartość ArgumentException zostanie wyrzucona, jeśli zostanie ustawiona na wartość spoza dozwolonego zakresu.
ConnectRetryInterval	Czas (w sekundach) między każdą ponowną próbą połączenia po zidentyfikowaniu, że wystąpił błąd połączenia bezczynnego. Musi to być liczba całkowita z zakresu od 1 do 60. Wartość domyślna to 10 sekund. Wartość ArgumentException zostanie wyrzucona, jeśli zostanie ustawiona na wartość spoza dozwolonego zakresu.
ConnectTimeout	Pobiera lub ustawia czas (w sekundach) oczekiwania na połączenie z serwerem przed zakończeniem próby i wygenerowaniem błędu.
Count	Pobiera bieżącą liczbę kluczy zawartych we ConnectionString właściwości . (Odziedziczone po DbConnectionStringBuilder)
CurrentLanguage	Pobiera lub ustawia nazwę rekordu języka SQL Server.
DataSource	Pobiera lub ustawia nazwę lub adres sieciowy wystąpienia SQL Server do nawiązania połączenia.
Encrypt	Pobiera lub ustawia wartość logiczną wskazującą, czy SQL Server używa szyfrowania SSL dla wszystkich danych wysyłanych między klientem a serwerem, jeśli serwer ma zainstalowany certyfikat.
Enlist	Pobiera lub ustawia wartość logiczną wskazującą, czy program puli połączeń SQL Server automatycznie zarejestrowa połączenie w bieżącym kontekście transakcji wątku tworzenia.
FailoverPartner	Pobiera lub ustawia nazwę lub adres serwera partnerskiego w celu nawiązania połączenia z serwerem podstawowym, jeśli serwer podstawowy nie działa.
InitialCatalog	Pobiera lub ustawia nazwę bazy danych skojarzonej z połączeniem.
IntegratedSecurity	Pobiera lub ustawia wartość logiczną wskazującą, czy identyfikator użytkownika i hasło są określone w połączeniu (gdy false) lub czy bieżące poświadczenia konta systemu Windows są używane do uwierzytelniania (gdy true).
IsFixedSize	Pobiera wartość wskazującą, czy ma DbConnectionStringBuilder stały rozmiar. (Odziedziczone po DbConnectionStringBuilder)
IsReadOnly	Pobiera wartość wskazującą, czy jest tylko DbConnectionStringBuilder do odczytu. (Odziedziczone po DbConnectionStringBuilder)
Item[String]	Pobiera lub ustawia wartość skojarzona z określonym kluczem. W języku C#ta właściwość jest indeksatorem.
Keys	Pobiera element ICollection zawierający klucze w elemecie SqlConnectionStringBuilder.
LoadBalanceTimeout	Pobiera lub ustawia minimalny czas w sekundach dla połączenia na żywo w puli połączeń przed zniszczeniem.
MaxPoolSize	Pobiera lub ustawia maksymalną liczbę połączeń dozwolonych w puli połączeń dla tej konkretnej parametry połączenia.
MinPoolSize	Pobiera lub ustawia minimalną liczbę połączeń dozwolonych w puli połączeń dla tej konkretnej parametry połączenia.
MultipleActiveResultSets	W przypadku wartości true aplikacja może obsługiwać wiele aktywnych zestawów wyników (MARS). Jeśli wartość false, aplikacja musi przetworzyć lub anulować wszystkie zestawy wyników z jednej partii, zanim będzie mogła wykonać dowolną inną partię na tym połączeniu. Aby uzyskać więcej informacji, zobacz Wiele aktywnych zestawów wyników (MARS).
MultiSubnetFailover	Jeśli aplikacja łączy się z zawsze włączoną grupą dostępności (AG) lub zawsze włączonym wystąpieniem klastra trybu failover (FCI) w różnych podsieciach, ustawienie parametru MultiSubnetFailover=true zapewnia szybsze wykrywanie i nawiązywanie połączenia z (obecnie) aktywnym serwerem. Aby uzyskać więcej informacji na temat obsługi klienta SqlClient dla funkcji Always On, zobacz SqlClient Support for High Availability, Disaster Recovery (Obsługa klienta SqlClient pod kątem wysokiej dostępności i odzyskiwania po awarii).
PacketSize	Pobiera lub ustawia rozmiar w bajtach pakietów sieciowych używanych do komunikowania się z wystąpieniem SQL Server.
Password	Pobiera lub ustawia hasło dla konta SQL Server.
PersistSecurityInfo	Pobiera lub ustawia wartość wskazującą, czy informacje poufne zabezpieczeń, takie jak hasło lub token dostępu, powinny być zwracane w ramach parametry połączenia w połączeniu utworzonym za pomocą tego SqlConnectionStringBuilder połączenia po wystąpieniu tego połączenia w stanie otwierania.
Pooling	Pobiera lub ustawia wartość logiczną wskazującą, czy połączenie zostanie otwarte w puli, czy jawnie otwarte za każdym razem, gdy jest wymagane połączenie.
Replication	Pobiera lub ustawia wartość logiczną wskazującą, czy replikacja jest obsługiwana przy użyciu połączenia.
TransactionBinding	Pobiera lub ustawia wartość parametrów wskazującą sposób zachowania skojarzenia połączenia z transakcją na liście System.Transactions .
TrustServerCertificate	Pobiera lub ustawia wartość wskazującą, czy kanał będzie szyfrowany podczas chodzenia przez łańcuch certyfikatów w celu zweryfikowania zaufania.
TypeSystemVersion	Pobiera lub ustawia wartość ciągu, która wskazuje system typów oczekiwany przez aplikację.
UserID	Pobiera lub ustawia identyfikator użytkownika, który ma być używany podczas nawiązywania połączenia z SQL Server.
UserInstance	Pobiera lub ustawia wartość wskazującą, czy przekierować połączenie z domyślnego wystąpienia SQL Server Express do wystąpienia zainicjowanego przez środowisko uruchomieniowe uruchomione na koncie obiektu wywołującego.
Values	Pobiera element ICollection zawierający wartości w obiekcie SqlConnectionStringBuilder.
WorkstationID	Pobiera lub ustawia nazwę stacji roboczej łączącej się z SQL Server.

Metody

Add(String, Object)	Dodaje wpis z określonym kluczem i wartością do elementu DbConnectionStringBuilder. (Odziedziczone po DbConnectionStringBuilder)
Clear()	Czyści zawartość SqlConnectionStringBuilder wystąpienia.
ClearPropertyDescriptors()	Czyści kolekcję PropertyDescriptor obiektów na skojarzonym obiekcie DbConnectionStringBuilder. (Odziedziczone po DbConnectionStringBuilder)
ContainsKey(String)	Określa, czy element SqlConnectionStringBuilder zawiera określony klucz.
Equals(Object)	Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object)
EquivalentTo(DbConnectionStringBuilder)	Porównuje informacje o połączeniu w tym DbConnectionStringBuilder obiekcie z informacjami o połączeniu w podanym obiekcie. (Odziedziczone po DbConnectionStringBuilder)
GetHashCode()	Służy jako domyślna funkcja skrótu. (Odziedziczone po Object)
GetProperties(Hashtable)	Wypełnia dostarczone Hashtable informacje o wszystkich właściwościach tego DbConnectionStringBuilderobiektu . (Odziedziczone po DbConnectionStringBuilder)
GetType()	Type Pobiera wartość bieżącego wystąpienia. (Odziedziczone po Object)
MemberwiseClone()	Tworzy płytkią kopię bieżącego Objectelementu . (Odziedziczone po Object)
Remove(String)	Usuwa wpis z określonym kluczem z SqlConnectionStringBuilder wystąpienia.
ShouldSerialize(String)	Wskazuje, czy określony klucz istnieje w tym SqlConnectionStringBuilder wystąpieniu.
ToString()	Zwraca parametry połączenia skojarzone z tym DbConnectionStringBuilderelementem . (Odziedziczone po DbConnectionStringBuilder)
TryGetValue(String, Object)	Pobiera wartość odpowiadającą podanemu kluczowi z tego SqlConnectionStringBuilderelementu .

Metody rozszerzania

Zobacz też

• Parametry połączenia (ADO.NET)
• Omówienie ADO.NET