SqlConnectionStringBuilder Osztály

Definíció

Névtér:

System.Data.SqlClient

Szerelvény:

System.Data.dll

Egyszerű módot kínál az osztály által SqlConnection használt kapcsolati sztringek tartalmának létrehozására és kezelésére.

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

[System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))]
public sealed class SqlConnectionStringBuilder : System.Data.Common.DbConnectionStringBuilder

[<System.ComponentModel.TypeConverter(typeof(System.Data.SqlClient.SqlConnectionStringBuilder+SqlConnectionStringBuilderConverter))>]
type SqlConnectionStringBuilder = class
    inherit DbConnectionStringBuilder

Public NotInheritable Class SqlConnectionStringBuilder
Inherits DbConnectionStringBuilder

Öröklődés

Object

DbConnectionStringBuilder

SqlConnectionStringBuilder

Attribútumok

TypeConverterAttribute

Példák

Az alábbi konzolalkalmazás kapcsolati sztringeket hoz létre egy SQL Server-adatbázishoz. A kód a SqlConnectionStringBuilder osztályt használja a kapcsolati karakterlánc létrehozásához. A példa ezután elemzi a kapcsolati karakterlánc, és bemutatja a tartalom manipulálásának különböző módjait.

// Create a new SqlConnectionStringBuilder and
// initialize it with a few name/value pairs.
SqlConnectionStringBuilder builder = new(
    "Server=(local);Integrated Security=true;" +
    "Initial Catalog=AdventureWorks"
    );

// The input connection string used the
// Server key, but the new connection string uses
// the well-known Data Source key instead.
Console.WriteLine($"Original connection string: '{builder.ConnectionString}'");

// Now that the connection string has been parsed,
// you can work with individual items.
Console.WriteLine($"Initial catalog: '{builder.InitialCatalog}'");
builder.InitialCatalog = "Northwind";
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($"Modified connection string: '{builder.ConnectionString}'");

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(
            "Server=(local);Integrated Security=true;" &
            "Initial Catalog=AdventureWorks"
            )

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

        ' Now that the connection string has been parsed,
        ' you can work with individual items.
        Console.WriteLine("Initial catalog: " + builder.InitialCatalog)
        builder.InitialCatalog = "Northwind"
        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("Modified connection string: " + builder.ConnectionString)
    End Sub
End Module

Megjegyzések

A kapcsolati karakterlánc szerkesztő lehetővé teszi a fejlesztők számára a szintaktikailag helyes kapcsolati sztringek programozott létrehozását, valamint a meglévő kapcsolati sztringek elemzését és újraépítését az osztály tulajdonságainak és metódusainak használatával. A kapcsolati karakterlánc-szerkesztő az SQL Server által engedélyezett ismert kulcs-érték pároknak megfelelő, erősen beírt tulajdonságokat biztosít. Ha az alkalmazás részeként létre kell hoznia kapcsolati sztringeket, az SqlConnectionStringBuilder osztály használatával létrehozhat és módosíthat kapcsolati sztringeket. Az osztály megkönnyíti az alkalmazáskonfigurációs fájlban tárolt kapcsolati sztringek kezelését is.

SqlConnectionStringBuilder érvényes kulcs/érték párok ellenőrzését végzi el. Ezért nem használhatja ezt az osztályt érvénytelen kapcsolati sztringek létrehozásához; Érvénytelen párok hozzáadásának kísérlete kivételt eredményez. Az osztály fenntartja a szinonimák rögzített gyűjteményét, és szinonimából lefordíthatja a megfelelő jól ismert kulcsnevet.

Ha például a Item tulajdonságot használja egy érték lekéréséhez, megadhat egy sztringet, amely a szükséges kulcs szinonimáit tartalmazza. Megadhat például "Hálózati cím", "addr" vagy bármely más elfogadható szinonimát a kulcshoz egy kapcsolati karakterlánc belül, ha olyan tagot használ, amely a kulcs nevét tartalmazó sztringet igényel, például a Item[String] tulajdonságot vagy a Remove metódust. Az elfogadható szinonimák teljes listáját a ConnectionString tulajdonságban találja.

A Item[String] tulajdonság kezeli a rosszindulatú bejegyzések beszúrására tett kísérleteket. A következő kód például az alapértelmezett Item tulajdonság (az indexelő C#-ban) használatával helyesen menekül a beágyazott kulcs/érték pártól:

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);

Az eredmény a következő kapcsolati karakterlánc, amely biztonságosan kezeli az érvénytelen értéket:

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

Konstruktorok

Name	Description
SqlConnectionStringBuilder()	Inicializálja a SqlConnectionStringBuilder osztály új példányát.
SqlConnectionStringBuilder(String)	Inicializálja a SqlConnectionStringBuilder osztály új példányát. A megadott kapcsolati karakterlánc biztosítják a példány belső kapcsolati adatainak adatait.

Tulajdonságok

Name	Description
ApplicationIntent	Deklarálja az alkalmazás számítási feladatainak típusát, amikor egy SQL Server rendelkezésre állási csoportban lévő adatbázishoz csatlakozik. Ennek a tulajdonságnak az értékét a következővel ApplicationIntentállíthatja be: . Az Always On rendelkezésre állási csoportok SqlClient-támogatásáról további információt a SqlClient magas rendelkezésre állású és vészhelyreállításicímű témakörben talál.
ApplicationName	Lekéri vagy beállítja a kapcsolati karakterlánc társított alkalmazás nevét.
AsynchronousProcessing	Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy a kapcsolati karakterlánc használatával létrehozott kapcsolat engedélyezi-e az aszinkron feldolgozást.
AttachDBFilename	Lekéri vagy beállítja az elsődleges adatfájl nevét tartalmazó sztringet. Ide tartozik egy csatolható adatbázis teljes elérési útja.
Authentication	Lekéri a kapcsolati karakterlánc hitelesítését.
BrowsableConnectionString	Olyan értéket kap vagy állít be, amely jelzi, hogy a ConnectionString tulajdonság látható-e Visual Studio tervezőkben. (Öröklődés forrása DbConnectionStringBuilder)
ColumnEncryptionSetting	Lekéri vagy beállítja a kapcsolati karakterlánc-szerkesztő oszloptitkosítási beállításait.
ConnectionReset	Elavult. Obsolete. Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy a kapcsolat alaphelyzetbe áll-e, amikor a kapcsolatkészletből származik.
ConnectionString	Lekéri vagy beállítja a DbConnectionStringBuilder társított kapcsolati karakterlánc. (Öröklődés forrása DbConnectionStringBuilder)
ConnectRetryCount	Az inaktív kapcsolati hiba azonosítását követően megkísérelt újracsatlakozások száma. Ennek 0 és 255 közötti egész számnak kell lennie. Az alapértelmezett érték 1. Állítsa a 0 értéket az inaktív kapcsolati hibák újracsatlakozásának letiltásához. A ArgumentException rendszer egy olyan értéket ad vissza, amely az engedélyezett tartományon kívüli értékre van állítva.
ConnectRetryInterval	Az egyes újracsatlakozási kísérletek között eltelt idő (másodpercben), miután megállapították, hogy tétlen kapcsolati hiba történt. Ennek 1 és 60 közötti egész számnak kell lennie. Az alapértelmezett érték 10 másodperc. A ArgumentException rendszer egy olyan értéket ad vissza, amely az engedélyezett tartományon kívüli értékre van állítva.
ConnectTimeout	Lekéri vagy beállítja a kiszolgálóhoz való csatlakozás várakozási időtartamát (másodpercben), mielőtt megszakítja a kísérletet, és hibát okozna.
ContextConnection	Lekéri vagy beállít egy értéket, amely jelzi, hogy létre kell-e hozni egy ügyfél-/kiszolgáló- vagy folyamatban lévő kapcsolatot SQL Server.
Count	Lekéri a tulajdonságban ConnectionString található kulcsok aktuális számát. (Öröklődés forrása DbConnectionStringBuilder)
CurrentLanguage	Lekéri vagy beállítja a SQL Server nyelvi rekord nevét.
DataSource	Lekéri vagy beállítja a SQL Server példányának nevét vagy hálózati címét, amelyhez csatlakozni szeretne.
EnclaveAttestationUrl	Lekéri vagy beállítja az enklávé igazolási URL-címét az enklávéalapú Always Encryptedhez.
Encrypt	Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy SQL Server SSL-titkosítást használ-e az ügyfél és a kiszolgáló között küldött összes adathoz, ha a kiszolgáló rendelkezik tanúsítvánnyal.
Enlist	Logikai értéket kap vagy állít be, amely azt jelzi, hogy a SQL Server kapcsolatkészletező automatikusan bevonja-e a kapcsolatot a létrehozási szál aktuális tranzakciós környezetében.
FailoverPartner	Lekéri vagy beállítja a partnerkiszolgáló nevét vagy címét, amelyhez csatlakozni szeretne, ha az elsődleges kiszolgáló le van állítva.
InitialCatalog	Lekéri vagy beállítja a kapcsolathoz társított adatbázis nevét.
IntegratedSecurity	Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy a felhasználóazonosító és a jelszó meg van-e adva a kapcsolatban (false esetén), vagy az aktuális Windows fiók hitelesítő adatait használja-e a hitelesítéshez (true esetén).
IsFixedSize	Olyan értéket kap, amely jelzi, hogy a SqlConnectionStringBuilder méret rögzített-e.
IsReadOnly	Olyan értéket kap, amely jelzi, hogy az DbConnectionStringBuilder írásvédett-e. (Öröklődés forrása DbConnectionStringBuilder)
Item[String]	Lekéri vagy beállítja a megadott kulccsal társított értéket. A C#-ban ez a tulajdonság az indexelő.
Keys	ICollection Lekéri azokat a kulcsokat, amelyek a SqlConnectionStringBuilder.
LoadBalanceTimeout	Másodpercek alatt lekéri vagy beállítja a minimális időt, hogy a kapcsolat a kapcsolatkészletben éljen, mielőtt megsemmisülne.
MaxPoolSize	Lekéri vagy beállítja az adott kapcsolati karakterlánc kapcsolatkészletében engedélyezett kapcsolatok maximális számát.
MinPoolSize	Lekéri vagy beállítja az adott kapcsolati karakterlánc kapcsolatkészletében engedélyezett kapcsolatok minimális számát.
MultipleActiveResultSets	Ha igaz, az alkalmazás több aktív eredményhalmazt (MARS) is képes fenntartani. Ha hamis, az alkalmazásnak egy kötegből kell feldolgoznia vagy megszakítania az összes eredményhalmazt, mielőtt bármilyen más köteget végrehajthat az adott kapcsolaton. További információért lásd a(z) Több aktív eredményhalmaz (MARS).
MultiSubnetFailover	Ha az alkalmazás egy Always On rendelkezésre állási csoporthoz (AG) vagy always on feladatátvevő fürtpéldányhoz (FCI) csatlakozik különböző alhálózatokon, a MultiSubnetFailover=true beállítás gyorsabb észlelést és kapcsolatot biztosít az (jelenleg) aktív kiszolgálóval. Az Always On funkciók SqlClient-támogatásáról további információt az SqlClient magas rendelkezésre állású és vészhelyreállítási támogatása című témakörben talál.
NetworkLibrary	Lekéri vagy beállít egy sztringet, amely a SQL Server való kapcsolat létrehozásához használt hálózati kódtár nevét tartalmazza.
PacketSize	Lekéri vagy beállítja a méretet bájtban a SQL Server egy példányával való kommunikációhoz használt hálózati csomagokban.
Password	Lekéri vagy beállítja a SQL Server-fiók jelszavát.
PersistSecurityInfo	Lekéri vagy beállít egy értéket, amely jelzi, hogy a biztonsági szempontból bizalmas információkat, például a jelszót vagy a hozzáférési jogkivonatot a kapcsolati karakterlánc részeként kell-e visszaadni az ezzel a SqlConnectionStringBuilder kapcsolattal létrehozott kapcsolaton, miután a kapcsolat nyílt állapotban volt.
PoolBlockingPeriod	A kapcsolatkészlet blokkolási időszakának viselkedése.
Pooling	Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy a kapcsolat készletezve vagy explicit módon lesz-e megnyitva minden alkalommal, amikor a kapcsolatot kérik.
Replication	Lekéri vagy beállít egy logikai értéket, amely jelzi, hogy a replikáció támogatott-e a kapcsolat használatával.
TransactionBinding	Lekéri vagy beállít egy sztringértéket, amely jelzi, hogy a kapcsolat hogyan tartja fenn a társítását egy bevont System.Transactions tranzakcióval.
TransparentNetworkIPResolution	Ha ennek a kulcsnak az értéke be van állítva true, az alkalmazásnak le kell kérnie egy adott DNS-bejegyzéshez tartozó összes IP-címet, és meg kell kísérelnie a kapcsolatot a listában szereplő elsővel. Ha a kapcsolat 0,5 másodpercen belül nem jön létre, az alkalmazás megpróbálja párhuzamosan csatlakozni az összes többi felhasználóhoz. Az első válaszok után az alkalmazás létrehozza a kapcsolatot a válaszadó IP-címével.
TrustServerCertificate	Lekéri vagy beállít egy értéket, amely jelzi, hogy a csatorna titkosítva lesz-e, miközben megkerüli a tanúsítványláncot a megbízhatóság ellenőrzéséhez.
TypeSystemVersion	Lekéri vagy beállít egy sztringértéket, amely az alkalmazás által várt típusrendszert jelzi.
UserID	Lekéri vagy beállítja a SQL Server való csatlakozáskor használandó felhasználói azonosítót.
UserInstance	Lekéri vagy beállít egy értéket, amely jelzi, hogy a kapcsolatot átirányítja-e az alapértelmezett SQL Server Express-példányról egy futtatókörnyezet által kezdeményezett példányra, amely a hívó fiókja alatt fut.
Values	ICollection Lekéri a értékét tartalmazó értéket.SqlConnectionStringBuilder
WorkstationID	Lekéri vagy beállítja a SQL Server csatlakozó munkaállomás nevét.

Metódusok

Name	Description
Add(String, Object)	A megadott kulccsal és értékkel rendelkező bejegyzést ad hozzá a DbConnectionStringBuilder. (Öröklődés forrása DbConnectionStringBuilder)
Clear()	Törli a példány tartalmát SqlConnectionStringBuilder .
ClearPropertyDescriptors()	Törli a társított PropertyDescriptorobjektumgyűjteménytDbConnectionStringBuilder. (Öröklődés forrása DbConnectionStringBuilder)
ContainsKey(String)	Meghatározza, hogy a SqlConnectionStringBuilder kulcs tartalmaz-e egy adott kulcsot.
Equals(Object)	Meghatározza, hogy a megadott objektum egyenlő-e az aktuális objektummal. (Öröklődés forrása Object)
EquivalentTo(DbConnectionStringBuilder)	Összehasonlítja az objektum kapcsolati adatait DbConnectionStringBuilder a megadott objektum kapcsolati adataival. (Öröklődés forrása DbConnectionStringBuilder)
GetHashCode()	Ez az alapértelmezett kivonatoló függvény. (Öröklődés forrása Object)
GetProperties(Hashtable)	Kitölti a megadott Hashtable adatokat ennek minden tulajdonságáról DbConnectionStringBuilder. (Öröklődés forrása DbConnectionStringBuilder)
GetType()	Lekéri az Type aktuális példányt. (Öröklődés forrása Object)
MemberwiseClone()	Az aktuális Objectpéldány sekély másolatát hozza létre. (Öröklődés forrása Object)
Remove(String)	Eltávolítja a megadott kulccsal rendelkező bejegyzést a SqlConnectionStringBuilder példányból.
ShouldSerialize(String)	Azt jelzi, hogy a megadott kulcs létezik-e ebben a SqlConnectionStringBuilder példányban.
ToString()	A DbConnectionStringBuilder társított kapcsolati karakterlánc adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
TryGetValue(String, Object)	A megadott kulcsnak megfelelő értéket kér le ebből.SqlConnectionStringBuilder

Explicit interfész-implementációk

Name	Description
ICollection.CopyTo(Array, Int32)	Az elemeket ICollection egy adott indextől kezdve másolja Arrayegy adott Array indexbe. (Öröklődés forrása DbConnectionStringBuilder)
ICollection.IsSynchronized	Beolvas egy értéket, amely jelzi, hogy a ICollection hozzáférés szinkronizálva van-e (a szál biztonságos). (Öröklődés forrása DbConnectionStringBuilder)
ICollection.SyncRoot	Lekéri az objektumot, amely a hozzáférés szinkronizálására használható.ICollection (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes()	Egy összetevő jelen példányához tartozó egyéni attribútumok gyűjteményét adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName()	Egy összetevő példányának osztálynevét adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName()	Egy összetevő példányának nevét adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter()	Egy összetevő jelen példányához tartozó típuskonvertert ad vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent()	Egy összetevő jelen példányának alapértelmezett eseményét adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty()	Az összetevő jelen példányának alapértelmezett tulajdonságát adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type)	Egy adott típusú szerkesztőt ad vissza egy összetevő jelen példányához. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents()	Egy összetevő jelen példányának eseményeit adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[])	Egy összetevő jelen példányának eseményeit adja vissza, szűrőként a megadott attribútumtömböt használva. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties()	Egy összetevő jelen példányának tulajdonságait adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[])	Egy összetevő jelen példányának tulajdonságait adja vissza, amely szűrőként használja az attribútumtömböt. (Öröklődés forrása DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	A megadott tulajdonságleíró által leírt tulajdonságot tartalmazó objektumot ad vissza. (Öröklődés forrása DbConnectionStringBuilder)
IDictionary.Add(Object, Object)	Hozzáad egy elemet a megadott kulccsal és értékkel az IDictionary objektumhoz. (Öröklődés forrása DbConnectionStringBuilder)
IDictionary.Contains(Object)	Meghatározza, hogy az IDictionary objektum tartalmaz-e a megadott kulccsal rendelkező elemet. (Öröklődés forrása DbConnectionStringBuilder)
IDictionary.GetEnumerator()	IDictionaryEnumerator Az objektum objektumát IDictionary adja vissza. (Öröklődés forrása DbConnectionStringBuilder)
IDictionary.Item[Object]	Lekéri vagy beállítja az elemet a megadott kulccsal. (Öröklődés forrása DbConnectionStringBuilder)
IDictionary.Remove(Object)	Eltávolítja a megadott kulccsal rendelkező elemet az IDictionary objektumból. (Öröklődés forrása DbConnectionStringBuilder)
IEnumerable.GetEnumerator()	Egy gyűjteményen keresztül iteráló enumerátort ad vissza. (Öröklődés forrása DbConnectionStringBuilder)

Bővítő metódusok

Name	Description
AsParallel(IEnumerable)	Lehetővé teszi a lekérdezés párhuzamosítását.
AsQueryable(IEnumerable)	Átalakítja az egyiket IEnumerableIQueryable.
Cast<TResult>(IEnumerable)	Egy elem elemeit IEnumerable a megadott típusra veti.
OfType<TResult>(IEnumerable)	Egy adott típus alapján szűri IEnumerable egy adott elem elemeit.

Lásd még

• Kapcsolódási sztringek (ADO.NET)
• ADO.NET áttekintése