SqlConnectionStringBuilder Klas

Definitie

Naamruimte:: System.Data.SqlClient

Assembly:: System.Data.dll

Belangrijk

Bepaalde informatie heeft betrekking op een voorlopige productversie die aanzienlijk kan worden gewijzigd voordat deze wordt uitgebracht. Microsoft biedt geen enkele expliciete of impliciete garanties met betrekking tot de informatie die hier wordt verstrekt.

Biedt een eenvoudige manier om de inhoud van verbindingsreeksen te maken en te beheren die door de SqlConnection klasse worden gebruikt.

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

Overname: Object

DbConnectionStringBuilder
SqlConnectionStringBuilder

Kenmerken: TypeConverterAttribute

Voorbeelden

De volgende consoletoepassing bouwt verbindingsreeksen voor een SQL Server-database. De code maakt gebruik van de klasse SqlConnectionStringBuilder om de verbindingsreeks te maken. Het voorbeeld parseert vervolgens de verbindingsreeks en demonstreert verschillende manieren om de inhoud ervan te bewerken.

// 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

Opmerkingen

Met de opbouwfunctie voor verbindingsreeks kunnen ontwikkelaars programmatisch syntactisch juiste verbindingsreeksen maken en bestaande verbindingsreeksen parseren en herbouwen, met behulp van eigenschappen en methoden van de klasse. De verbindingsreeks builder biedt sterk getypte eigenschappen die overeenkomen met de bekende sleutel-/waardeparen die zijn toegestaan door SQL Server. Als u verbindingsreeksen wilt maken als onderdeel van uw app, kunt u de SqlConnectionStringBuilder klasse gebruiken om verbindingsreeksen te maken en te wijzigen. De klasse maakt het ook eenvoudig om verbindingsreeksen te beheren die zijn opgeslagen in een toepassingsconfiguratiebestand.

SqlConnectionStringBuilder voert controles uit op geldige sleutel-/waardeparen. Daarom kunt u deze klasse niet gebruiken om ongeldige verbindingsreeksen te maken; Als u ongeldige paren probeert toe te voegen, wordt er een uitzondering gegenereerd. De klasse onderhoudt een vaste verzameling synoniemen en kan vertalen van een synoniem naar de bijbehorende bekende sleutelnaam.

Wanneer u bijvoorbeeld de Item eigenschap gebruikt om een waarde op te halen, kunt u een tekenreeks opgeven die een synoniem bevat voor de sleutel die u nodig hebt. U kunt bijvoorbeeld 'Netwerkadres', 'addr' of een ander acceptabel synoniem opgeven voor deze sleutel binnen een verbindingsreeks wanneer u een lid gebruikt waarvoor een tekenreeks is vereist die de sleutelnaam bevat, zoals de eigenschap Item[String] of de methode Remove. Zie de ConnectionString eigenschap voor een volledige lijst met acceptabele synoniemen.

De Item[String] eigenschap verwerkt pogingen om schadelijke vermeldingen in te voegen. De volgende code, met behulp van de standaardeigenschap Item (de indexeerfunctie, in C#), escapet bijvoorbeeld correct aan het geneste sleutel-/waardepaar:

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

Het resultaat is de volgende verbindingsreeks die de ongeldige waarde op een veilige manier verwerkt:

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

Constructors

Name	Description
SqlConnectionStringBuilder()	Initialiseert een nieuw exemplaar van de SqlConnectionStringBuilder klasse.
SqlConnectionStringBuilder(String)	Initialiseert een nieuw exemplaar van de SqlConnectionStringBuilder klasse. De opgegeven verbindingsreeks levert de gegevens voor de interne verbindingsgegevens van het exemplaar.

Eigenschappen

Name	Description
ApplicationIntent	Declareert het workloadtype van de toepassing wanneer u verbinding maakt met een database in een SQL Server beschikbaarheidsgroep. U kunt de waarde van deze eigenschap instellen met ApplicationIntent. Zie SqlClient-ondersteuning voor hoge beschikbaarheid, herstel na noodgevallenvoor meer informatie over sqlClient-ondersteuning voor AlwaysOn-beschikbaarheidsgroepen.
ApplicationName	Hiermee haalt u de naam op van de toepassing die is gekoppeld aan de verbindingsreeks.
AsynchronousProcessing	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of asynchrone verwerking is toegestaan door de verbinding die is gemaakt met behulp van deze verbindingsreeks.
AttachDBFilename	Hiermee wordt een tekenreeks opgehaald of ingesteld die de naam van het primaire gegevensbestand bevat. Dit omvat de volledige padnaam van een koppelbare database.
Authentication	Hiermee haalt u de verificatie van de verbindingsreeks op.
BrowsableConnectionString	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de eigenschap ConnectionString zichtbaar is in Visual Studio ontwerpers. (Overgenomen van DbConnectionStringBuilder)
ColumnEncryptionSetting	Hiermee haalt u de kolomversleutelingsinstellingen voor de verbindingsreeks builder op of stelt u deze in.
ConnectionReset	Verouderd. Obsolete. Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of de verbinding opnieuw wordt ingesteld wanneer deze wordt opgehaald uit de verbindingsgroep.
ConnectionString	Hiermee haalt u de verbindingsreeks op die is gekoppeld aan de DbConnectionStringBuilder. (Overgenomen van DbConnectionStringBuilder)
ConnectRetryCount	Het aantal pogingen om opnieuw verbinding te maken nadat is vastgesteld dat er een niet-actieve verbindingsfout is opgetreden. Dit moet een geheel getal tussen 0 en 255 zijn. De standaardwaarde is 1. Ingesteld op 0 om opnieuw verbinding te maken bij niet-actieve verbindingsfouten uit te schakelen. Er ArgumentException wordt een gegenereerd als deze is ingesteld op een waarde buiten het toegestane bereik.
ConnectRetryInterval	De hoeveelheid tijd (in seconden) tussen elke poging om opnieuw verbinding te maken nadat is vastgesteld dat er een niet-actieve verbindingsfout is opgetreden. Dit moet een geheel getal tussen 1 en 60 zijn. De standaardwaarde is 10 seconden. Er ArgumentException wordt een gegenereerd als deze is ingesteld op een waarde buiten het toegestane bereik.
ConnectTimeout	Haalt de tijdsduur (in seconden) op of stelt deze in om te wachten op een verbinding met de server voordat de poging wordt beëindigd en er een fout wordt gegenereerd.
ContextConnection	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of er een client-/server- of in-process-verbinding met SQL Server moet worden gemaakt.
Count	Hiermee haalt u het huidige aantal sleutels op dat zich in de ConnectionString eigenschap bevindt. (Overgenomen van DbConnectionStringBuilder)
CurrentLanguage	Hiermee haalt u de naam van de SQL Server Language-record op of stelt u deze in.
DataSource	Hiermee haalt u de naam of het netwerkadres op van het exemplaar van SQL Server waarmee u verbinding wilt maken.
EnclaveAttestationUrl	Hiermee haalt u de enclave-attestation-URL op of stelt u deze in voor gebruik met Always Encrypted op basis van enclaves.
Encrypt	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of SQL Server SSL-versleuteling gebruikt voor alle gegevens die worden verzonden tussen de client en de server als er een certificaat is geïnstalleerd op de server.
Enlist	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of de SQL Server verbindingspooler automatisch de verbinding in de huidige transactiecontext van de creatiethread plaatst.
FailoverPartner	Hiermee haalt u de naam of het adres van de partnerserver op waarmee verbinding moet worden gemaakt als de primaire server niet beschikbaar is.
InitialCatalog	Hiermee haalt u de naam op van de database die aan de verbinding is gekoppeld.
IntegratedSecurity	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of gebruikers-id en wachtwoord zijn opgegeven in de verbinding (wanneer `false`) of of de huidige Windows accountreferenties worden gebruikt voor verificatie (wanneer `true`).
IsFixedSize	Hiermee wordt een waarde opgehaald die aangeeft of de grootte van de SqlConnectionStringBuilder waarde vast is.
IsReadOnly	Hiermee wordt een waarde opgehaald die aangeeft of het DbConnectionStringBuilder kenmerk Alleen-lezen is. (Overgenomen van DbConnectionStringBuilder)
Item[String]	Hiermee haalt u de waarde op die is gekoppeld aan de opgegeven sleutel of stelt u deze in. In C# is deze eigenschap de indexeerfunctie.
Keys	Hiermee haalt u een ICollection op met de sleutels in de SqlConnectionStringBuilder.
LoadBalanceTimeout	Hiermee wordt de minimale tijd, in seconden, opgehaald of ingesteld voordat de verbinding in de verbindingsgroep live gaat voordat deze wordt vernietigd.
MaxPoolSize	Hiermee haalt u het maximum aantal verbindingen op dat is toegestaan in de verbindingsgroep voor deze specifieke verbindingsreeks.
MinPoolSize	Hiermee haalt u het minimum aantal verbindingen op dat is toegestaan in de verbindingsgroep voor deze specifieke verbindingsreeks.
MultipleActiveResultSets	Wanneer waar, kan een toepassing meerdere actieve resultatensets (MARS) onderhouden. Wanneer deze onwaar is, moet een toepassing alle resultatensets van de ene batch verwerken of annuleren voordat deze een andere batch op die verbinding kan uitvoeren. Zie Meerdere actieve resultatensets (MARS) voor meer informatie.
MultiSubnetFailover	Als uw toepassing verbinding maakt met een AlwaysOn-beschikbaarheidsgroep (AG) of AlwaysOn Failover Cluster Instance (FCI) op verschillende subnetten, biedt het instellen van MultiSubnetFailover=true snellere detectie en verbinding met de (momenteel) actieve server. Zie SqlClient-ondersteuning voor hoge beschikbaarheid, herstel na noodgevallen voor meer informatie over sqlClient-ondersteuning voor de AlwaysOn-functies.
NetworkLibrary	Hiermee haalt u een tekenreeks op die de naam bevat van de netwerkbibliotheek die wordt gebruikt om een verbinding met de SQL Server tot stand te brengen.
PacketSize	Hiermee haalt u de grootte op in bytes van de netwerkpakketten die worden gebruikt om te communiceren met een exemplaar van SQL Server.
Password	Hiermee haalt u het wachtwoord voor het SQL Server-account op of stelt u dit in.
PersistSecurityInfo	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of beveiligingsgevoelige informatie, zoals het wachtwoord of toegangstoken, moet worden geretourneerd als onderdeel van de verbindingsreeks op een verbinding die is gemaakt met deze SqlConnectionStringBuilder nadat die verbinding ooit in een open status is geweest.
PoolBlockingPeriod	Het gedrag van de blokkeringsperiode voor een verbindingsgroep.
Pooling	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of de verbinding wordt gegroepeerd of expliciet wordt geopend telkens wanneer de verbinding wordt aangevraagd.
Replication	Hiermee wordt een Booleaanse waarde opgehaald of ingesteld die aangeeft of replicatie wordt ondersteund met behulp van de verbinding.
TransactionBinding	Hiermee wordt een tekenreekswaarde opgehaald of ingesteld die aangeeft hoe de verbinding de koppeling onderhoudt met een in de lijst vermelde `System.Transactions` transactie.
TransparentNetworkIPResolution	Wanneer de waarde van deze sleutel is ingesteld `true`op, is de toepassing vereist om alle IP-adressen voor een bepaalde DNS-vermelding op te halen en verbinding te maken met de eerste in de lijst. Als de verbinding niet binnen 0,5 seconden tot stand is gebracht, probeert de toepassing parallel verbinding te maken met alle andere. Wanneer de eerste antwoorden worden beantwoord, wordt de verbinding met het IP-adres van de respondent tot stand gebracht.
TrustServerCertificate	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of het kanaal wordt versleuteld tijdens het omzeilen van de certificaatketen om de vertrouwensrelatie te valideren.
TypeSystemVersion	Hiermee wordt een tekenreekswaarde opgehaald of ingesteld die aangeeft welk type systeem de toepassing verwacht.
UserID	Hiermee wordt de gebruikers-id opgevraagd of ingesteld die moet worden gebruikt bij het maken van verbinding met SQL Server.
UserInstance	Hiermee wordt een waarde opgehaald of ingesteld die aangeeft of de verbinding moet worden omgeleid van het standaardexemplaren SQL Server Express-exemplaar naar een door runtime geïnitieerd exemplaar dat wordt uitgevoerd onder het account van de aanroeper.
Values	Hiermee haalt u een ICollection op met de waarden in de SqlConnectionStringBuilder.
WorkstationID	Hiermee haalt u de naam op van het werkstation dat verbinding maakt met SQL Server.

Methoden

Name	Description
Add(String, Object)	Voegt een vermelding toe met de opgegeven sleutel en waarde in de DbConnectionStringBuilder. (Overgenomen van DbConnectionStringBuilder)
Clear()	Hiermee wist u de inhoud van het SqlConnectionStringBuilder exemplaar.
ClearPropertyDescriptors()	Hiermee wist u de verzameling PropertyDescriptor objecten op de bijbehorende DbConnectionStringBuilder. (Overgenomen van DbConnectionStringBuilder)
ContainsKey(String)	Bepaalt of de SqlConnectionStringBuilder sleutel een specifieke sleutel bevat.
Equals(Object)	Bepaalt of het opgegeven object gelijk is aan het huidige object. (Overgenomen van Object)
EquivalentTo(DbConnectionStringBuilder)	Vergelijkt de verbindingsgegevens in dit DbConnectionStringBuilder object met de verbindingsgegevens in het opgegeven object. (Overgenomen van DbConnectionStringBuilder)
GetHashCode()	Fungeert als de standaardhashfunctie. (Overgenomen van Object)
GetProperties(Hashtable)	Vult een opgegeven Hashtable met informatie over alle eigenschappen van deze DbConnectionStringBuilder. (Overgenomen van DbConnectionStringBuilder)
GetType()	Hiermee haalt u de Type huidige instantie op. (Overgenomen van Object)
MemberwiseClone()	Hiermee maakt u een ondiepe kopie van de huidige Object. (Overgenomen van Object)
Remove(String)	Hiermee verwijdert u de vermelding met de opgegeven sleutel uit het SqlConnectionStringBuilder exemplaar.
ShouldSerialize(String)	Geeft aan of de opgegeven sleutel bestaat in dit SqlConnectionStringBuilder exemplaar.
ToString()	Retourneert de verbindingsreeks die aan deze DbConnectionStringBuilder zijn gekoppeld. (Overgenomen van DbConnectionStringBuilder)
TryGetValue(String, Object)	Hiermee haalt u een waarde op die overeenkomt met de opgegeven sleutel.SqlConnectionStringBuilder

Expliciete interface-implementaties

Name	Description
ICollection.CopyTo(Array, Int32)	Kopieert de elementen van de ICollection elementen naar een Array, beginnend bij een bepaalde Array index. (Overgenomen van DbConnectionStringBuilder)
ICollection.IsSynchronized	Hiermee wordt een waarde opgehaald die aangeeft of de toegang tot de ICollection synchronisatie is gesynchroniseerd (thread safe). (Overgenomen van DbConnectionStringBuilder)
ICollection.SyncRoot	Hiermee haalt u een object op dat kan worden gebruikt om de toegang tot het ICollectionobject te synchroniseren. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetAttributes()	Retourneert een verzameling aangepaste kenmerken voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetClassName()	Retourneert de klassenaam van dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetComponentName()	Retourneert de naam van dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetConverter()	Retourneert een typeconversieprogramma voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultEvent()	Retourneert de standaard gebeurtenis voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetDefaultProperty()	Retourneert de standaardeigenschap voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEditor(Type)	Retourneert een editor van het opgegeven type voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents()	Retourneert de gebeurtenissen voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetEvents(Attribute[])	Retourneert de gebeurtenissen voor dit exemplaar van een onderdeel met behulp van de opgegeven kenmerkmatrix als filter. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties()	Retourneert de eigenschappen voor dit exemplaar van een onderdeel. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetProperties(Attribute[])	Retourneert de eigenschappen voor dit exemplaar van een onderdeel met behulp van de kenmerkmatrix als filter. (Overgenomen van DbConnectionStringBuilder)
ICustomTypeDescriptor.GetPropertyOwner(PropertyDescriptor)	Retourneert een object dat de eigenschap bevat die wordt beschreven door de opgegeven eigenschapsdescriptor. (Overgenomen van DbConnectionStringBuilder)
IDictionary.Add(Object, Object)	Voegt een element met de opgegeven sleutel en waarde toe aan het IDictionary object. (Overgenomen van DbConnectionStringBuilder)
IDictionary.Contains(Object)	Bepaalt of het IDictionary object een element met de opgegeven sleutel bevat. (Overgenomen van DbConnectionStringBuilder)
IDictionary.GetEnumerator()	Retourneert een IDictionaryEnumerator object voor het IDictionary object. (Overgenomen van DbConnectionStringBuilder)
IDictionary.Item[Object]	Hiermee haalt u het element op of stelt u het in met de opgegeven sleutel. (Overgenomen van DbConnectionStringBuilder)
IDictionary.Remove(Object)	Hiermee verwijdert u het element met de opgegeven sleutel uit het IDictionary object. (Overgenomen van DbConnectionStringBuilder)
IEnumerable.GetEnumerator()	Retourneert een enumerator die door een verzameling wordt herhaald. (Overgenomen van DbConnectionStringBuilder)

Extensiemethoden

Name	Description
AsParallel(IEnumerable)	Hiermee schakelt u parallelle uitvoering van een query in.
AsQueryable(IEnumerable)	Converteert een IEnumerable naar een IQueryable.
Cast<TResult>(IEnumerable)	Cast de elementen van een IEnumerable naar het opgegeven type.
OfType<TResult>(IEnumerable)	Hiermee filtert u de elementen van een IEnumerable op basis van een opgegeven type.

Van toepassing op

Zie ook

Feedback

Is deze pagina nuttig?