SqlConnection 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.
Reprezentuje połączenie z bazą danych SQL Server. Klasa ta nie może być dziedziczona.
public ref class SqlConnection sealed : System::ComponentModel::Component, ICloneable, IDisposable, System::Data::IDbConnection
public ref class SqlConnection sealed : System::Data::Common::DbConnection, ICloneable
public sealed class SqlConnection : System.ComponentModel.Component, ICloneable, IDisposable, System.Data.IDbConnection
public sealed class SqlConnection : System.Data.Common.DbConnection, ICloneable
type SqlConnection = class
inherit Component
interface IDbConnection
interface IDisposable
interface ICloneable
type SqlConnection = class
inherit DbConnection
interface ICloneable
Public NotInheritable Class SqlConnection
Inherits Component
Implements ICloneable, IDbConnection, IDisposable
Public NotInheritable Class SqlConnection
Inherits DbConnection
Implements ICloneable
- Dziedziczenie
- Dziedziczenie
- Implementuje
Przykłady
Poniższy przykład tworzy element SqlCommand i .SqlConnection Właściwość SqlConnection jest otwierana i ustawiana jako Connection dla elementu SqlCommand. W tym przykładzie wywołamy metodę ExecuteNonQuery. W tym celu ExecuteNonQuery jest przekazywany sqlConnection i ciąg zapytania, który jest instrukcją Transact-SQL INSERT. Połączenie jest zamykane automatycznie, gdy kod zamyka blok using.
private static void CreateCommand(string queryString,
string connectionString)
{
using (SqlConnection connection = new SqlConnection(
connectionString))
{
SqlCommand command = new SqlCommand(queryString, connection);
command.Connection.Open();
command.ExecuteNonQuery();
}
}
Public Sub CreateCommand(ByVal queryString As String, _
ByVal connectionString As String)
Using connection As New SqlConnection(connectionString)
Dim command As New SqlCommand(queryString, connection)
command.Connection.Open()
command.ExecuteNonQuery()
End Using
End Sub
Uwagi
Obiekt SqlConnection reprezentuje unikatową sesję w źródle danych SQL Server. W przypadku systemu bazy danych klienta/serwera jest on odpowiednikiem połączenia sieciowego z serwerem. SqlConnection jest używany razem z SqlDataAdapter i SqlCommand w celu zwiększenia wydajności podczas nawiązywania połączenia z baza danych programu Microsoft SQL Server. W przypadku wszystkich produktów SQL Server innych firm i innych źródeł danych obsługiwanych przez ole db użyj OleDbConnection.
Podczas tworzenia wystąpienia SqlConnectionprogramu wszystkie właściwości są ustawiane na ich wartości początkowe. Aby uzyskać listę tych wartości, zobacz konstruktor SqlConnection.
Aby uzyskać listę słów kluczowych w parametry połączenia, zobacz ConnectionString.
SqlConnection Jeśli element wykracza poza zakres, nie zostanie zamknięty. W związku z tym należy jawnie zamknąć połączenie przez wywołanie Close metody lub Dispose.
Close i Dispose są funkcjonalnie równoważne. Jeśli wartość Pooling puli połączeń jest ustawiona na true lub yes, połączenie bazowe zostanie zwrócone z powrotem do puli połączeń. Z drugiej strony, jeśli Pooling jest ustawiona wartość false lub no, bazowe połączenie z serwerem jest rzeczywiście zamknięte.
Note
Zdarzenia logowania i wylogowywanie nie będą zgłaszane na serwerze, gdy połączenie zostanie pobrane z puli połączeń lub zwrócone do puli połączeń, ponieważ połączenie nie zostanie faktycznie zamknięte po powrocie do puli połączeń. Aby uzyskać więcej informacji, zobacz SQL Server Connection Pooling (ADO.NET).
Aby upewnić się, że połączenia są zawsze zamknięte, otwórz połączenie wewnątrz using bloku, jak pokazano w poniższym fragmentze kodu. Dzięki temu połączenie zostanie automatycznie zamknięte po zakończeniu bloku przez kod.
Using connection As New SqlConnection(connectionString)
connection.Open()
' Do work here; connection closed on following line.
End Using
using (SqlConnection connection = new SqlConnection(connectionString))
{
connection.Open();
// Do work here; connection closed on following line.
}
Note
Aby wdrożyć aplikacje o wysokiej wydajności, należy użyć buforowania połączeń. W przypadku używania Dostawca danych .NET Framework dla SQL Server nie trzeba włączać buforowania połączeń, ponieważ dostawca zarządza tym automatycznie, chociaż można zmodyfikować niektóre ustawienia. Aby uzyskać więcej informacji, zobacz SQL Server Connection Pooling (ADO.NET).
SqlException Jeśli element jest generowany przez metodę wykonującą SqlCommandelement , SqlConnection pozostaje otwarty, gdy poziom ważności wynosi 19 lub mniej. Gdy poziom ważności wynosi 20 lub więcej, serwer zwykle zamyka SqlConnectionwartość . Użytkownik może jednak ponownie otworzyć połączenie i kontynuować.
Aplikacja, która tworzy wystąpienie SqlConnection obiektu, może wymagać, aby wszystkie wywołania bezpośrednie i pośrednie miały wystarczające uprawnienia do kodu, ustawiając wymagania deklaratywne lub imperatywne zabezpieczeń. SqlConnection sprawia, że wymagania dotyczące zabezpieczeń korzystają z SqlClientPermission obiektu . Użytkownicy mogą sprawdzić, czy ich kod ma wystarczające uprawnienia przy użyciu SqlClientPermissionAttribute obiektu . Użytkownicy i administratorzy mogą również używać Caspol.exe (narzędzia zasad zabezpieczeń dostępu kodu) do modyfikowania zasad zabezpieczeń na poziomie komputera, użytkownika i przedsiębiorstwa. Aby uzyskać więcej informacji, zobacz Zabezpieczenia na platformie .NET. Aby zapoznać się z przykładem użycia wymagań dotyczących zabezpieczeń, zobacz Zabezpieczenia dostępu kodu i ADO.NET.
Aby uzyskać więcej informacji na temat obsługi komunikatów ostrzegawczych i informacyjnych z serwera, zobacz Zdarzenia połączenia. Aby uzyskać więcej informacji na temat błędów i komunikatów o błędach aparatu SQL Server, zobacz Database Engine Zdarzenia i błędy.
Ostrożność
Możesz wymusić użycie protokołu TCP zamiast pamięci udostępnionej. Można to zrobić, prefiksując tcp: do nazwy serwera w parametry połączenia lub możesz użyć hosta lokalnego.
Konstruktory
| Nazwa | Opis |
|---|---|
| SqlConnection() |
Inicjuje nowe wystąpienie klasy SqlConnection. |
| SqlConnection(String, SqlCredential) |
Inicjuje nowe wystąpienie SqlConnection klasy przy użyciu parametrów połączenia, które nie jest używane |
| SqlConnection(String) |
Inicjuje nowe wystąpienie SqlConnection klasy, gdy podane parametry połączenia zawierają parametry połączenia. |
Właściwości
| Nazwa | Opis |
|---|---|
| AccessToken |
Pobiera lub ustawia token dostępu dla połączenia. |
| CanRaiseEvents |
Pobiera wartość wskazującą, czy składnik może zgłosić zdarzenie. (Odziedziczone po Component) |
| ClientConnectionId |
Identyfikator połączenia ostatniej próby połączenia, niezależnie od tego, czy próba zakończyła się powodzeniem, czy niepowodzeniem. |
| ColumnEncryptionKeyCacheTtl |
Pobiera lub ustawia czas wygaśnięcia dla wpisów klucza szyfrowania kolumny w pamięci podręcznej klucza szyfrowania kolumny dla funkcji Always Encrypted . Wartość domyślna to 2 godziny. 0 oznacza brak buforowania w ogóle. |
| ColumnEncryptionQueryMetadataCacheEnabled |
Pobiera lub ustawia wartość wskazującą, czy buforowanie metadanych zapytania jest włączone (true), czy nie (false) dla sparametryzowanych zapytań uruchomionych w bazach danych z włączoną funkcją Always Encrypted . Wartość domyślna to true. |
| ColumnEncryptionTrustedMasterKeyPaths |
Umożliwia ustawienie listy zaufanych ścieżek kluczy dla serwera bazy danych. Jeśli podczas przetwarzania zapytania aplikacji sterownik odbiera ścieżkę klucza, która nie znajduje się na liście, zapytanie zakończy się niepowodzeniem. Ta właściwość zapewnia dodatkową ochronę przed atakami zabezpieczeń, które obejmują naruszone SQL Server dostarczanie fałszywych ścieżek kluczy, co może prowadzić do wycieku poświadczeń magazynu kluczy. |
| ConnectionString |
Pobiera lub ustawia ciąg używany do otwierania bazy danych programu SQL Server. |
| ConnectionTimeout |
Pobiera czas oczekiwania (w sekundach) podczas próby nawiązania połączenia przed zakończeniem próby i wygenerowaniem błędu. |
| Container |
Pobiera element IContainer zawierający element Component. (Odziedziczone po Component) |
| Credential |
Pobiera lub ustawia SqlCredential obiekt dla tego połączenia. |
| Database |
Pobiera nazwę bieżącej bazy danych lub bazy danych do użycia po otwarciu połączenia. |
| DataSource |
Pobiera nazwę wystąpienia programu SQL Server, z którym ma być nawiązane połączenie. |
| DbProviderFactory |
Pobiera element DbProviderFactory dla tego elementu DbConnection. (Odziedziczone po DbConnection) |
| DesignMode |
Pobiera wartość wskazującą, czy Component element jest obecnie w trybie projektowania. (Odziedziczone po Component) |
| Events |
Pobiera listę programów obsługi zdarzeń dołączonych do tego elementu Component. (Odziedziczone po Component) |
| FireInfoMessageEventOnUserErrors |
Pobiera lub ustawia FireInfoMessageEventOnUserErrors właściwość . |
| PacketSize |
Pobiera rozmiar (w bajtach) pakietów sieciowych używanych do komunikowania się z wystąpieniem SQL Server. |
| ServerVersion |
Pobiera ciąg zawierający wersję wystąpienia programu SQL Server, z którym jest połączony klient. |
| Site |
Pobiera lub ustawia ISite dla Component. (Odziedziczone po Component) |
| State |
Wskazuje stan SqlConnection ostatniej operacji sieciowej wykonywanej na połączeniu. |
| StatisticsEnabled |
Gdy jest ustawiona wartość |
| WorkstationId |
Pobiera ciąg identyfikujący klienta bazy danych. |
Metody
| Nazwa | Opis |
|---|---|
| BeginDbTransaction(IsolationLevel) |
Po zastąpieniu w klasie pochodnej uruchamia transakcję bazy danych. (Odziedziczone po DbConnection) |
| BeginTransaction() |
Uruchamia transakcję bazy danych. |
| BeginTransaction(IsolationLevel, String) |
Uruchamia transakcję bazy danych z określonym poziomem izolacji i nazwą transakcji. |
| BeginTransaction(IsolationLevel) |
Uruchamia transakcję bazy danych z określonym poziomem izolacji. |
| BeginTransaction(String) |
Uruchamia transakcję bazy danych o określonej nazwie transakcji. |
| ChangeDatabase(String) |
Zmienia bieżącą bazę danych dla otwartego SqlConnectionpliku . |
| ChangePassword(String, SqlCredential, SecureString) |
Zmienia hasło programu SQL Server dla użytkownika wskazanego w obiekcie SqlCredential. |
| ChangePassword(String, String) |
Zmienia hasło programu SQL Server dla użytkownika wskazanego w parametrach połączenia z określonym nowym hasłem. |
| ClearAllPools() |
Opróżnia pulę połączeń. |
| ClearPool(SqlConnection) |
Opróżnia pulę połączeń skojarzona z określonym połączeniem. |
| Close() |
Zamyka połączenie z bazą danych. Jest to preferowana metoda zamykania dowolnego otwartego połączenia. |
| CreateCommand() |
Tworzy i zwraca SqlCommand obiekt skojarzony z obiektem SqlConnection. |
| CreateDbCommand() |
Po zastąpieniu w klasie pochodnej tworzy i zwraca DbCommand obiekt skojarzony z bieżącym połączeniem. (Odziedziczone po DbConnection) |
| CreateObjRef(Type) |
Tworzy obiekt zawierający wszystkie istotne informacje wymagane do wygenerowania serwera proxy używanego do komunikowania się z obiektem zdalnym. (Odziedziczone po MarshalByRefObject) |
| Dispose() |
Zwalnia wszystkie zasoby używane przez program Component. (Odziedziczone po Component) |
| Dispose(Boolean) |
Zwalnia niezarządzane zasoby używane przez Component program i opcjonalnie zwalnia zarządzane zasoby. (Odziedziczone po Component) |
| EnlistDistributedTransaction(ITransaction) |
Enlists w określonej transakcji jako transakcji rozproszonej. |
| EnlistTransaction(Transaction) |
Enlists w określonej transakcji jako transakcji rozproszonej. |
| Equals(Object) |
Określa, czy dany obiekt jest taki sam, jak bieżący obiekt. (Odziedziczone po Object) |
| GetHashCode() |
Służy jako domyślna funkcja skrótu. (Odziedziczone po Object) |
| GetLifetimeService() |
Pobiera bieżący obiekt usługi okresu istnienia, który kontroluje zasady okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject) |
| GetSchema() |
Zwraca informacje o schemacie dla źródła danych tego SqlConnectionelementu . Aby uzyskać więcej informacji na temat schematu, zobacz SQL Server Kolekcje schematów. |
| GetSchema(String, String[]) |
Zwraca informacje o schemacie dla źródła SqlConnection danych przy użyciu określonego ciągu dla nazwy schematu i określonej tablicy ciągów dla wartości ograniczeń. |
| GetSchema(String) |
Zwraca informacje o schemacie dla źródła SqlConnection danych przy użyciu określonego ciągu dla nazwy schematu. |
| GetService(Type) |
Zwraca obiekt reprezentujący usługę dostarczaną przez Component obiekt lub przez obiekt Container. (Odziedziczone po Component) |
| GetType() |
Pobiera Type bieżącego wystąpienia. (Odziedziczone po Object) |
| InitializeLifetimeService() |
Uzyskuje obiekt usługi okresu istnienia w celu kontrolowania zasad okresu istnienia dla tego wystąpienia. (Odziedziczone po MarshalByRefObject) |
| MemberwiseClone() |
Tworzy płytkią kopię bieżącego Object. (Odziedziczone po Object) |
| MemberwiseClone(Boolean) |
Tworzy płytkią kopię bieżącego MarshalByRefObject obiektu. (Odziedziczone po MarshalByRefObject) |
| OnStateChange(StateChangeEventArgs) |
StateChange Wywołuje zdarzenie. (Odziedziczone po DbConnection) |
| Open() |
Otwiera połączenie bazy danych z ustawieniami właściwości określonymi ConnectionStringprzez . |
| OpenAsync() |
Asynchroniczna wersja Open()programu , która otwiera połączenie bazy danych z ustawieniami określonymi ConnectionStringprzez . Ta metoda wywołuje metodę OpenAsync(CancellationToken) wirtualną z elementem CancellationToken.None. (Odziedziczone po DbConnection) |
| OpenAsync(CancellationToken) |
Asynchroniczna wersja Open()programu , która otwiera połączenie bazy danych z ustawieniami właściwości określonymi ConnectionStringprzez element . Token anulowania może służyć do żądania porzucenia operacji przed upływem limitu czasu połączenia. Wyjątki będą propagowane za pośrednictwem zwróconego zadania. Jeśli limit czasu połączenia upłynie bez pomyślnego nawiązania połączenia, zwrócone zadanie zostanie oznaczone jako uszkodzone z wyjątkiem. Implementacja zwraca zadanie bez blokowania wątku wywołującego dla połączeń w puli i bez puli. |
| RegisterColumnEncryptionKeyStoreProviders(IDictionary<String,SqlColumnEncryptionKeyStoreProvider>) |
Rejestruje dostawców magazynu kluczy szyfrowania kolumn. |
| ResetStatistics() |
Jeśli zbieranie statystyk jest włączone, wszystkie wartości są resetowane do zera. |
| RetrieveStatistics() |
Zwraca kolekcję par wartości nazw statystyk w momencie wywołania metody . |
| ToString() |
Zwraca wartość zawierającą String nazwę Component, jeśli istnieje. Ta metoda nie powinna być zastępowana. (Odziedziczone po Component) |
Zdarzenia
| Nazwa | Opis |
|---|---|
| Disposed |
Występuje, gdy składnik jest usuwany przez wywołanie Dispose() metody . (Odziedziczone po Component) |
| InfoMessage |
Występuje, gdy SQL Server zwraca komunikat ostrzegawczy lub informacyjny. |
| StateChange |
Występuje, gdy stan połączenia ulegnie zmianie. |
| StateChange |
Występuje, gdy stan połączenia ulegnie zmianie. (Odziedziczone po DbConnection) |
Jawne implementacje interfejsu
| Nazwa | Opis |
|---|---|
| ICloneable.Clone() |
Tworzy nowy obiekt, który jest kopią bieżącego wystąpienia. |
| IDbConnection.BeginTransaction() |
Rozpoczyna transakcję bazy danych. |
| IDbConnection.BeginTransaction() |
Rozpoczyna transakcję bazy danych. (Odziedziczone po DbConnection) |
| IDbConnection.BeginTransaction(IsolationLevel) |
Rozpoczyna transakcję bazy danych z określoną IsolationLevel wartością. |
| IDbConnection.BeginTransaction(IsolationLevel) |
Rozpoczyna transakcję bazy danych z określonym poziomem izolacji. (Odziedziczone po DbConnection) |
| IDbConnection.CreateCommand() |
Tworzy i zwraca obiekt Command skojarzony z połączeniem. |
| IDbConnection.CreateCommand() |
Tworzy i zwraca DbCommand obiekt skojarzony z bieżącym połączeniem. (Odziedziczone po DbConnection) |