SqlConnectionStringBuilder Klasa
Definicja
Ważne
Niektóre informacje odnoszą się do produktu w wersji wstępnej, który może zostać znacząco zmodyfikowany przed wydaniem. Firma Microsoft nie udziela żadnych gwarancji, jawnych lub domniemanych, w odniesieniu do informacji podanych w tym miejscu.
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[System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))]
public sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilderpublic sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder[<System.ComponentModel.TypeConverter(typeof(Microsoft.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))>]
type SqlConnectionStringBuilder = class
inherit DbConnectionStringBuildertype SqlConnectionStringBuilder = class
inherit DbConnectionStringBuilderPublic NotInheritable Class SqlConnectionStringBuilder
Inherits DbConnectionStringBuilder- Dziedziczenie
-
SqlConnectionStringBuilder
- Atrybuty
Przykłady
Poniższa aplikacja konsolowa tworzy parametry połączenia dla bazy danych programu 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.
Note
Ten przykład zawiera hasło do zademonstrowania sposobu SqlConnectionStringBuilder działania z parametrami połączenia. W aplikacjach zalecamy użycie uwierzytelniania systemu Windows. Jeśli musisz użyć hasła, nie dołączaj w aplikacji zakodowanego na sztywno hasła.
using Microsoft.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=********;initial catalog=AdventureWorks";
// Now that the connection string has been parsed,
// you can work with individual items.
Console.WriteLine(builder.Password);
builder.Password = "********";
// 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";
}
}
Uwagi
Konstruktor parametrów połączenia umożliwia deweloperom programowe tworzenie syntaktycznie 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 parametrów połączenia udostępnia silnie typizowane właściwości odpowiadające znanym parom klucz/wartość dozwolonym przez program SQL Server. Deweloperzy, którzy muszą tworzyć parametry połączenia w ramach aplikacji, mogą używać SqlConnectionStringBuilder klasy do kompilowania i modyfikowania parametrów połączenia. Klasa ułatwia również zarządzanie parametrami połączenia przechowywanymi w pliku konfiguracji aplikacji.
Funkcja SqlConnectionStringBuilder przeprowadza sprawdzanie 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 dla tego klucza w ramach 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.
Dojście właściwości 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 unika zagnieżdżonej pary klucz/wartość:
Dim builder As New Microsoft.Data.SqlClient.SqlConnectionStringBuilder
builder("Data Source") = "(local)"
builder("Integrated Security") = True
builder("Initial Catalog") = "AdventureWorks;NewValue=Bad"
Console.WriteLine(builder.ConnectionString)
Microsoft.Data.SqlClient.SqlConnectionStringBuilder builder =
new Microsoft.Data.SqlClient.SqlConnectionStringBuilder();
builder["Data Source"] = "(local)";
builder["Integrated Security"] = true;
builder["Initial Catalog"] = "AdventureWorks;NewValue=Bad";
Console.WriteLine(builder.ConnectionString);
Wynikiem są następujące parametry połączenia, które obsługują nieprawidłową wartość w bezpieczny sposób:
Source=(local);Initial Catalog="AdventureWorks;NewValue=Bad";
Integrated Security=True
Konstruktory
| Nazwisko | Opis |
|---|---|
| SqlConnectionStringBuilder() |
Inicjuje nowe wystąpienie klasy SqlConnectionStringBuilder. |
| SqlConnectionStringBuilder(String) |
Inicjuje nowe wystąpienie klasy SqlConnectionStringBuilder. Podane parametry połączenia zawierają dane dla informacji o wewnętrznym połączeniu wystąpienia. |
Właściwości
| Nazwisko | Opis |
|---|---|
| ApplicationIntent |
Deklaruje typ obciążenia aplikacji podczas nawiązywania połączenia z bazą danych w grupie dostępności programu SQL Server. Możesz ustawić wartość tej właściwości przy użyciu 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. |
| ApplicationName |
Pobiera lub ustawia nazwę aplikacji skojarzonej z parametrami połączenia. |
| AsynchronousProcessing |
Przestarzałe.
Obsolete. Pobiera lub ustawia wartość logiczną wskazującą, czy przetwarzanie asynchroniczne jest dozwolone przez połączenie utworzone przy użyciu tych parametrów 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. |
| AttestationProtocol |
Pobiera lub ustawia wartość protokołu zaświadczania. |
| Authentication |
Pobiera lub ustawia metodę uwierzytelniania używaną do nawiązywania połączenia z Microsoft Entra w celu Azure SQL zasobów. |
| ColumnEncryptionSetting |
Pobiera lub ustawia ustawienia szyfrowania kolumn dla konstruktora parametrów połączenia. |
| CommandTimeout |
Domyślny czas oczekiwania (w sekundach) przed zakończeniem próby wykonania polecenia i wygenerowaniem błędu. Wartość domyślna to 30 sekund. |
| ConnectionReset |
Przestarzałe.
Przestarzałe.
Obsolete. Pobiera lub ustawia wartość logiczną wskazującą, czy połączenie jest resetowane podczas pobierania z puli połączeń. |
| 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. Wartość domyślna dla punktów końcowych innych niż Azure wynosi 1. W przypadku Azure SQL punktów końcowych wartość domyślna to 2. Począwszy od wersji 5.x, dla Azure SQL bezserwerowych lub na żądanie punktów końcowych, wartość domyślna to 5, aby poprawić powodzenie połączenia dla połączeń z bezczynnym lub wstrzymanym wystąpieniem. 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 wartość spoza dozwolonego zakresu. |
| ConnectRetryInterval |
Czas (w sekundach) między każdą ponowną próbą nawiązania połączenia po zidentyfikowaniu, że wystąpił błąd bezczynności połączenia. Musi to być liczba całkowita z zakresu od 1 do 60. Wartość domyślna to 10 sekund. |
| ConnectTimeout |
Pobiera lub ustawia czas oczekiwania na połączenie z serwerem (w sekundach) przed zakończeniem próby i wygenerowaniem błędu. |
| ContextConnection |
Przestarzałe.
Obsolete. Pobiera lub ustawia wartość wskazującą, czy należy nawiązać połączenie klienta/serwera, czy w procesie z programem SQL Server. |
| CurrentLanguage |
Pobiera lub ustawia język używany na potrzeby ostrzeżeń lub komunikatów o błędach serwera bazy danych. |
| DataSource |
Pobiera lub ustawia nazwę lub adres sieciowy wystąpienia programu SQL Server do nawiązania połączenia. |
| EnclaveAttestationUrl |
Pobiera lub ustawia adres URL zaświadczania enklawy, który ma być używany z enklawą opartą na funkcji Always Encrypted. |
| Encrypt |
Pobiera lub ustawia SqlConnectionEncryptOption wartość od wersji 5.0 lub Boolean wartości dla wcześniejszych wersji, która wskazuje, czy szyfrowanie TLS jest wymagane dla wszystkich danych wysyłanych między klientem a serwerem. |
| Enlist |
Pobiera lub ustawia wartość logiczną wskazującą, czy pula połączeń SQL Server automatycznie pobiera 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, jeśli serwer podstawowy nie działa. |
| FailoverPartnerSPN |
Pobiera lub ustawia nazwę główną usługi (SPN) partnera trybu failover dla połączenia. |
| HostNameInCertificate |
Pobiera lub ustawia nazwę hosta do użycia podczas weryfikowania certyfikatu serwera dla połączenia. Jeśli nie zostanie określona, nazwa serwera z elementu |
| IdleTimeout |
Pobiera lub ustawia maksymalny czas (w sekundach), przez który połączenie może znajdować się nieużywane (bezczynne) w puli połączeń, zanim zostanie odrzucone. Wartość domyślna to 300 (5 minut). |
| 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 |
| IPAddressPreference |
Pobiera lub ustawia preferencje rodziny adresów IP podczas nawiązywania połączeń TCP. |
| IsFixedSize |
Pobiera wartość wskazującą, czy SqlConnectionStringBuilder ma stały rozmiar. |
| Item[String] |
Pobiera lub ustawia wartość skojarzona z określonym kluczem. W języku C#ta właściwość jest indeksatorem. |
| Keys |
Pobiera ICollection, który zawiera klucze w 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 tych określonych parametrów połączenia. |
| MinPoolSize |
Pobiera lub ustawia minimalną liczbę połączeń dozwolonych w puli połączeń dla tych określonych parametrów 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ę w 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 w różnych podsieciach, ustawienie |
| NetworkLibrary |
Pobiera lub ustawia ciąg zawierający nazwę biblioteki sieciowej używanej do nawiązania połączenia z programem SQL Server. |
| PacketSize |
Pobiera lub ustawia rozmiar w bajtach pakietów sieciowych używanych do komunikowania się z wystąpieniem programu SQL Server. |
| Password |
Pobiera lub ustawia hasło dla konta programu SQL Server. |
| PersistSecurityInfo |
Pobiera lub ustawia wartość logiczną 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 otwarcia. Tę właściwość należy ustawić |
| PoolBlockingPeriod |
Zachowanie okresu blokowania dla puli połączeń. |
| 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. |
| ServerCertificate |
Pobiera lub ustawia ścieżkę do pliku certyfikatu, aby był zgodny z certyfikatem TLS/SSL SQL Server dla połączenia. Akceptowane formaty certyfikatów to PEM, DER i CER. Jeśli zostanie określony, certyfikat SQL Server jest sprawdzany, sprawdzając, czy |
| ServerSPN |
Pobiera lub ustawia nazwę główną usługi (SPN) źródła danych. |
| TransactionBinding |
Pobiera lub ustawia wartość parametrów, która wskazuje sposób, w jaki połączenie utrzymuje skojarzenie z transakcją enlisted |
| TransparentNetworkIPResolution |
Przestarzałe.
Na platformie .NET Framework, gdy wartość tego klucza jest ustawiona na |
| TrustServerCertificate |
Pobiera lub ustawia wartość wskazującą, czy kanał zostanie zaszyfrowany podczas pomijania chodzenia łańcuchem 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 programem SQL Server. |
| UserInstance |
Pobiera lub ustawia wartość wskazującą, czy przekierować połączenie z domyślnego wystąpienia programu 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 programem SQL Server. |
Metody
| Nazwisko | Opis |
|---|---|
| Clear() |
Czyści zawartość SqlConnectionStringBuilder wystąpienia. |
| ContainsKey(String) |
Określa, czy SqlConnectionStringBuilder zawiera określony klucz. |
| Remove(String) |
Usuwa wpis z określonym kluczem z wystąpienia SqlConnectionStringBuilder. |
| ShouldSerialize(String) |
Wskazuje, czy określony klucz istnieje w tym wystąpieniu SqlConnectionStringBuilder. |
| TryGetValue(String, Object) |
Pobiera wartość odpowiadającą podanemu kluczowi z tego SqlConnectionStringBuilder elementu . |