DSN- en verbindingsreeks-zoekwoorden en attributen

Dit artikel geeft een overzicht van de trefwoorden die de Microsoft ODBC Driver for SQL Server accepteert in databronnamen (DSN's) en verbindingsreeksen. Het geeft ook verbindingsattributen voor SQLSetConnectAttr en SQLGetConnectAttr.

Kies een DSN- of DSN-loze verbinding

Voor richtlijnen bij het kiezen van verbindingsmethoden, authenticatie, encryptie, routering, nieuwe pogingen en applicatieinstellingen, zie ODBC-verbindingen configureren naar Microsoft SQL. Gebruik dit artikel om exacte trefwoorden en verbindingsattributen op te zoeken.

Ondersteunde DSN- en verbindingsreeks-sleutelwoorden en verbindingsattributen

De volgende tabel geeft een overzicht van de beschikbare trefwoorden en attributen voor elk platform (L: Linux; M: macOS; W: Windows). Selecteer het trefwoord of kenmerk voor meer informatie.

DSN / verbindingsreeks trefwoord Verbindingsattribuut Platform
Addr LMW
Adres LMW
AnsiNPW SQL_COPT_SS_ANSI_NPW LMW
APP LMW
ApplicationIntent SQL_COPT_SS_APPLICATION_INTENT LMW
AttachDBFileName SQL_COPT_SS_ATTACHDBFILENAME LMW
Authentication SQL_COPT_SS_AUTHENTICATION LMW
AutoTranslate SQL_COPT_SS_TRANSLATE LMW
ClientCertificate LMW
ClientKey LMW
ColumnEncryption SQL_COPT_SS_COLUMN_ENCRYPTION LMW
ConcatNullYieldsNull (v18.6 en latere versies) SQL_COPT_SS_CONCAT_NULL LMW
ConnectRetryCount SQL_COPT_SS_CONNECT_RETRY_COUNT LMW
ConnectRetryInterval SQL_COPT_SS_CONNECT_RETRY_INTERVAL LMW
ConnectTimeout (v18.7 en latere versies) SQL_ATTR_LOGIN_TIMEOUT LMW
Database SQL_ATTR_CURRENT_CATALOG LMW
Description LMW
Stuurprogramma LMW
DSN LMW
Versleutelen SQL_COPT_SS_ENCRYPT LMW
Failover_Partner SQL_COPT_SS_FAILOVER_PARTNER W
FailoverPartner (v18.7 en latere versies) SQL_COPT_SS_FAILOVER_PARTNER W
FailoverPartnerSPN SQL_COPT_SS_FAILOVER_PARTNER_SPN W
FileDSN LMW
GetDataExtensions (v18.0 en latere versies) SQL_COPT_SS_GETDATA_EXTENSIONS LMW
HostnameInCertificate (v18.0 en latere versies) LMW
IpAddressPreference (v18.1 en latere versies) LMW
KeepAlive (v17.4 en latere versies; DSN alleen vóór 17.8) LMW
KeepAliveInterval (v17.4 en latere versies; DSN alleen vóór 17.8) LMW
KeystoreAuthenticatie LMW
KeystorePrincipalId LMW
KeystoreSecret LMW
Language LMW
LongAsMax (v18.0 en latere versies) SQL_COPT_SS_LONGASMAX LMW
MARS_Connection SQL_COPT_SS_MARS_ENABLED LMW
MultipleActiveResultSets (v18.7 en latere versies) SQL_COPT_SS_MARS_ENABLED LMW
MultiSubnetFailover SQL_COPT_SS_MULTISUBNET_FAILOVER LMW
Net LMW
Netwerk LMW
PacketSize (Driver 18.7) SQL_ATTR_PACKET_SIZE LMW
PWD LMW
QueryLog_On SQL_COPT_SS_PERF_QUERY W
QueryLogFile SQL_COPT_SS_PERF_QUERY_LOG W
QueryLogTime SQL_COPT_SS_PERF_QUERY_INTERVAL W
QuotedId SQL_COPT_SS_QUOTED_IDENT LMW
Regionaal LMW
Replication LMW
RetryExec (18.1 en latere versies) LMW
SaveFile LMW
Server LMW
ServerCertificate (v18.1 en latere versies) LMW
ServerSPN SQL_COPT_SS_SERVER_SPN LMW
StatsLog_On SQL_COPT_SS_PERF_DATA W
StatsLogFile SQL_COPT_SS_PERF_DATA_LOG W
TransparentNetworkIPResolution SQL_COPT_SS_TNIR LMW
Trusted_Connection SQL_COPT_SS_INTEGRATED_SECURITY LMW
TrustServerCertificate SQL_COPT_SS_TRUST_SERVER_CERTIFICATE LMW
UID LMW
UseFMTONLY LMW
vectorTypeSupport (v18.6.1.1 en latere versies) SQL_COPT_SS_VECTOR_TYPE_SUPPORT LMW
WorkstationID (v18.7 en latere versies) LMW
WSID LMW
SQL_ATTR_ACCESS_MODE
(SQL_ACCESS_MODE)
LMW
SQL_ATTR_ASYNC_DBC_EVENT W
SQL_ATTR_ASYNC_DBC_FUNCTIONS_ENABLE W
SQL_ATTR_ASYNC_DBC_PCALLBACK W
SQL_ATTR_ASYNC_DBC_PCONTEXT W
SQL_ATTR_ASYNC_ENABLE W
SQL_ATTR_AUTO_IPD LMW
SQL_ATTR_AUTOCOMMIT
(SQL_AUTOCOMMIT)
LMW
SQL_ATTR_CONNECTION_DEAD LMW
SQL_ATTR_CONNECTION_TIMEOUT LMW
SQL_ATTR_DBC_INFO_TOKEN W
SQL_ATTR_LOGIN_TIMEOUT
(SQL_LOGIN_TIMEOUT)
LMW
SQL_ATTR_METADATA_ID LMW
SQL_ATTR_ODBC_CURSORS
(SQL_ODBC_CURSORS)
LMW
SQL_ATTR_PACKET_SIZE
(SQL_PACKET_SIZE)
LMW
SQL_ATTR_QUIET_MODE
(SQL_QUIET_MODE)
LMW
SQL_ATTR_RESET_CONNECTION
(SQL_COPT_SS_RESET_CONNECTION)
LMW
SQL_ATTR_TRACE
(SQL_OPT_TRACE)
LMW
SQL_ATTR_TRACEFILE
(SQL_OPT_TRACEFILE)
LMW
SQL_ATTR_TRANSLATE_LIB
(SQL_TRANSLATE_DLL)
LMW
SQL_ATTR_TRANSLATE_OPTION
(SQL_TRANSLATE_OPTION)
LMW
SQL_ATTR_TXN_ISOLATION
(SQL_TXN_ISOLATION)
LMW
SQL_COPT_SS_ACCESS_TOKEN LMW
SQL_COPT_SS_ANSI_OEM W
SQL_COPT_SS_AUTOBEGINTXN LMW
SQL_COPT_SS_BCP LMW
SQL_COPT_SS_BROWSE_CACHE_DATA LMW
SQL_COPT_SS_BROWSE_CONNECT LMW
SQL_COPT_SS_BROWSE_SERVER LMW
SQL_COPT_SS_CEKEYSTOREDATA LMW
SQL_COPT_SS_CEKEYSTOREPROVIDER LMW
SQL_COPT_SS_CLIENT_CONNECTION_ID LMW
SQL_COPT_SS_CONNECTION_DEAD LMW
SQL_COPT_SS_DATACLASSIFICATION_VERSION (v17.4.2 en latere versies) LMW
SQL_COPT_SS_ENLIST_IN_DTC W
SQL_COPT_SS_ENLIST_IN_XA LMW
SQL_COPT_SS_FALLBACK_CONNECT LMW
SQL_COPT_SS_INTEGRATED_AUTHENTICATION_METHOD LMW
SQL_COPT_SS_MUTUALLY_AUTHENTICATED LMW
SQL_COPT_SS_OLDPWD LMW
SQL_COPT_SS_PERF_DATA_LOG_NOW W
SQL_COPT_SS_PRESERVE_CURSORS LMW
SQL_COPT_SS_SPID (v17.5 en latere versies) LMW
SQL_COPT_SS_TXN_ISOLATION LMW
SQL_COPT_SS_USER_DATA LMW
SQL_COPT_SS_WARN_ON_CP_ERROR LMW

SQL_ATTR_DBC_INFO_TOKEN is gereserveerd voor verbindingspooling met ondersteuning voor Windows Driver Manager. Applicaties stellen dit attribuut niet in.

Hier zijn enkele verbindingsreeks-zoekwoorden en verbindingsattributen die niet zijn gedocumenteerd in Using Connection String Keywords with SQL Server Native Client, SQLSetConnectAttr en SQLSetConnectAttr Function.

Description

Beschrijft de gegevensbron.

SQL_COPT_SS_ANSI_OEM

Beheerst de conversie tussen Windows- en original equipment manufacturer (OEM)-codepagina's.

Kenmerkwaarde Description
SQL_AO_OFF (standaard) De vertaling is nog niet klaar.
SQL_AO_ON Vertaling is voltooid.

SQL_COPT_SS_AUTOBEGINTXN

Vanaf versie 17.6, terwijl autocommmit uit staat, gebruik je deze optie om automatisch BEGIN TRANSACTION na ROLLBACK of COMMITte bedienen.

Kenmerkwaarde Description
SQL_AUTOBEGINTXN_ON (standaard) Automatisch BEGIN TRANSACTION na ROLLBACK of COMMIT.
SQL_AUTOBEGINTXN_OFF Geen automatische BEGIN TRANSACTION na ROLLBACK of COMMIT.

SQL_COPT_SS_FALLBACK_CONNECT

Regelt het gebruik van SQL Server fallback-verbindingen. Deze optie wordt niet langer ondersteund.

Kenmerkwaarde Description
SQL_FB_OFF (standaard) Schakelt fallbackverbindingen uit.
SQL_FB_ON Maakt fallbackverbindingen mogelijk.

Nieuwe verbindingsreeks-sleutelwoorden en verbindingsattributen

De volgende secties beschrijven het gedrag van trefwoorden, verbindingsattributen en hun geaccepteerde waarden. Bestuurdersspecifieke beperkingen worden vermeld bij de betreffende optie.

Verbindingsstring-sleutelwoordunificatie

Vanaf versie 18.7 ondersteunt de ODBC-driver voor SQL Server extra verbindingsreeks-trefwoorden die overeenkomen met eigendomsnamen in de Microsoft.Data.SqlClient dataprovider. Deze ondersteuning vermindert het hernoemen van trefwoorden bij het overschakelen tussen Microsoft SQL-dataproviders en stuurprogramma's. Elke provider heeft nog steeds zijn eigen ondersteunde trefwoorden en waarden.

Trefwoordaliasen

Elke alias configureert dezelfde optie als het equivalente ODBC-sleutelwoord:

Alias Equivalent ODBC-trefwoord Description
MultipleActiveResultSets MARS_Connection Zet meerdere actieve resultaatsets (MARS) aan of uit. Ondersteunt Yes of No.
WorkstationID WSID Stelt de werkstation-ID in, meestal de netwerknaam van de computer die de applicatie draait. HOST_NAME() geeft deze waarde terug.
FailoverPartner Failover_Partner Specificeert de failover-partnerserver voor databasespiegeling. Alleen ondersteund op Windows.

Opmerking

In versie 18.7 MultipleActiveResultSets accepteert Yes of No, maar niet True of False.

De bestuurder past de volgende regels toe op deze aliasen:

  • Niet hoofdlettergevoelig: De driver vergelijkt aliassen ongeacht hoofdletters. Gedraagt zich bijvoorbeeld multipleactiveresultsets hetzelfde als MultipleActiveResultSets.
  • Eerste keer wint: Een alias en het equivalente ODBC-trefwoord configureren dezelfde optie. Als een verbindingsreeks beide bevat, gebruikt de driver de eerste waarde en negeert daaropvolgende waarden voor die optie.
  • Alleen invoer: De driver accepteert aliassen als invoer. Wanneer het een output verbindingsreeks retourneert of de instelling naar een databronnaam (DSN) schrijft, gebruikt het het equivalente ODBC-sleutelwoord.
  • Platformondersteuning: De driver ondersteunt MultipleActiveResultSets en WorkstationID op Windows, Linux en macOS. De driver ondersteunt FailoverPartner en Failover_Partner alleen op Windows.

ConnectTimeout trefwoord

Het ConnectTimeout trefwoord configureert dezelfde inlogtime-out als het SQL_ATTR_LOGIN_TIMEOUT verbindingsatribuut. Applicaties kunnen de time-out in de verbindingsreeks specificeren in plaats van SQLSetConnectAttr aan te roepen.

Als een applicatie expliciet stelt SQL_ATTR_LOGIN_TIMEOUT voordat een verbindingsfunctie wordt aanroepen, krijgt het connection-attribuut voorrang boven de waarde van de ConnectTimeout verbindingsreeks.

  • Eenheden en standaard: De waarde geeft het aantal seconden aan dat wordt gewacht totdat de aanmelding is voltooid. De standaardwaarde is 15 seconden.
  • Geen time-out: Een waarde van 0 geeft het stuurprogramma aan om onbeperkt te wachten.
  • Maximum en begrenzing: De maximale waarde is 65534. Wanneer je een negatieve waarde aangeeft, een waarde groter dan 65534, of een waarde die het ondersteunde numerieke bereik overschrijdt, gebruikt 65534de driver . Als de driver de waarde klemt en de verbinding anders slaagt, geeft de driver een waarschuwing 01S02 (SQL_SUCCESS_WITH_INFOOptie waarde gewijzigd) terug.
  • Validatie: De driver verwerpt lege en niet-numerieke waarden.
  • DSN-ondersteuning: Op Windows kunnen applicaties ConnectTimeout opslaan en ophalen in een gegevensbronnaam (DSN).
  • Platformondersteuning: De driver ondersteunt ConnectTimeout op Windows, Linux en macOS.

Example

De volgende verbindingsreeks gebruikt de uniforme trefwoordspellingen. Vervang <server>, <database>, <user_id> en <password> met uw eigen waarden. Gebruik voor Azure SQL Database <server>.database.windows.net als hostnaam:

Driver={ODBC Driver 18 for SQL Server};Server=tcp:<server>;Database=<database>;UID=<user_id>;PWD=<password>;Encrypt=yes;TrustServerCertificate=no;MultipleActiveResultSets=Yes;WorkstationID=app-node-01;ConnectTimeout=30;

De aliassen in de voorgaande verbindingsreeks configureren dezelfde opties als de oorspronkelijke ODBC-sleutelwoorden in de volgende verbindingsreeks:

Driver={ODBC Driver 18 for SQL Server};Server=tcp:<server>;Database=<database>;UID=<user_id>;PWD=<password>;Encrypt=yes;TrustServerCertificate=no;MARS_Connection=Yes;WSID=app-node-01;

Beide strings schakelen MARS in en stellen de werkstation-ID in op app-node-01. De eerste reeks wacht ook tot 30 seconden tot het inloggen voltooid is. ConnectTimeout heeft geen gelijkwaardig trefwoord in Driver 17 of in eerdere releases van Driver 18. Om hun inlogtijdslimiet in te stellen, roept u SQLSetConnectAttr aan met SQL_ATTR_LOGIN_TIMEOUT.

Authenticatie - SQL_COPT_SS_AUTHENTICATION

Stelt de authenticatiemodus voor de verbinding in. Voor meer informatie, zie Gebruik Microsoft Entra ID met de ODBC-driver.

Trefwoordwaarde Kenmerkwaarde Description
SQL_AU_NONE (standaard) Zonder een expliciet ingesteld attribuut bepalen andere verbindingsinstellingen de authenticatie. Het expliciet instellen van dit attribuut overschrijft de Authentication selectie van de DSN of verbindingsreeks.
SqlPassword SQL_AU_PASSWORD SQL-authenticatie met gebruikersnaam en wachtwoord.
ActiveDirectoryIntegrated SQL_AU_AD_INTEGRATED Geïntegreerde Microsoft Entra-verificatie.
ActiveDirectoryInteractive SQL_AU_AD_INTERACTIVE Microsoft Entra interactieve authenticatie.
ActiveDirectoryMsi SQL_AU_AD_MSI Door Microsoft Entra beheerde identiteitsverificatie. Voor een door gebruiker toegewezen identiteit, stel UID deze in op de client-ID op Azure App Service of Azure Container Instances; gebruik de object-ID op andere ondersteunde hosts. Laat UID weg voor een systeemtoegewezen identiteit.
ActiveDirectoryServicePrincipal SQL_AU_AD_SPA Verificatie van microsoft Entra-service-principal. UID is ingesteld op de client-ID van de serviceprincipal. PWD is ingesteld op het clientgeheim.
ActiveDirectoryPassword SQL_AU_AD_PASSWORD Verouderde Microsoft Entra-gebruikersnaam- en wachtwoordauthenticatie. Voor meer informatie, zie ActiveDirectoryPassword-deprecatie.
SQL_AU_RESET Verwijdert een expliciet ingestelde authenticatie-attribuut zodat de Authentication instelling van de DSN of verbindingsreeks opnieuw kan worden toegepast.

Opmerking

Wanneer u het trefwoord of attribuut Authentication gebruikt, stelt u Encrypt expliciet in in de verbindingsreeks, DSN of het verbindingskenmerk. Voor gedrag en standaardinstellingen, zie Encrypt.

ColumnEncryption - SQL_COPT_SS_COLUMN_ENCRYPTION

Besturingselementen voor transparante kolomversleuteling (Always Encrypted). Zie Always Encrypted gebruiken met het ODBC-stuurprogramma voor SQL Servervoor meer informatie.

Trefwoordwaarde Kenmerkwaarde Description
Enabled SQL_CE_ENABLED Hiermee schakelt u Always Encrypted in.
Disabled (standaard) SQL_CE_DISABLED Schakelt Always Encrypted uit.
SQL_CE_RESULTSETONLY Hiermee schakelt u alleen ontsleuteling in (resultaten en retourwaarden).

ConcatNullYieldsNull - SQL_COPT_SS_CONCAT_NULL

Beheerst de ISO-behandeling van NULL bij het samenvoegen van tekenreeksen. Zie SET CONCAT_NULL_YIELDS_NULL voor meer informatie.

Trefwoordwaarde Kenmerkwaarde Description
Yes (standaard) SQL_CN_ON NULL samenvoegen levert NULL op.
No SQL_CN_OFF NULL Samenvoeging levert een string op.

Versleutelen

Specificeert of verbindingen Transport Layer Security (TLS)-encryptie gebruiken over het netwerk. Driver 17 accepteert yes en no. Driver 18 accepteert mandatory ook als synoniem voor yes, optional als synoniem voor no, en strict, dat Tabular Data Stream (TDS) 8.0-encryptie selecteert en geen equivalent van Driver 17 heeft.

Driver 18 staat standaard op yes. Driver 17 staat normaal gesproken standaard op no, maar staat standaard op yes wanneer een niet-lege Authentication instelling of een toegangstoken wordt opgegeven. Stel expliciet in Encrypt in plaats van te vertrouwen op deze authenticatie-afhankelijke standaardinstellingen.

Ongeacht de instelling voor Encrypt, worden de aanmeldingsreferenties van de server (gebruikersnaam en wachtwoord) altijd versleuteld.

De Encrypt, TrustServerCertificate, en server-side Force Encryption instellingen bepalen of verbindingen over het netwerk versleuteld zijn. In de volgende tabellen ziet u het effect van deze instellingen.

ODBC Driver 18 en latere versies

Versleutelingsinstelling Servercertificaat vertrouwen Serverversleuteling afdwingen Result
Nee. Nee. Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden niet versleuteld.
Nee. Yes Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden niet versleuteld.
Yes Nee. Nee. Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Yes Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Nee. Nee. Yes Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Nee. Yes Yes Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Nee. Yes Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Yes Yes Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Streng - - TrustServerCertificate wordt genegeerd. Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.

Opmerking

De Strict waarde is alleen beschikbaar tegen servers die TDS 8.0-verbindingen ondersteunen.

ODBC Driver 17 en eerdere versies

Versleutelingsinstelling Servercertificaat vertrouwen Serverversleuteling afdwingen Result
Nee. Nee. Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden niet versleuteld.
Nee. Yes Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden niet versleuteld.
Yes Nee. Nee. Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Yes Nee. Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Nee. Nee. Yes Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Nee. Yes Yes Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Nee. Yes Servercertificaat wordt gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.
Yes Yes Yes Servercertificaat wordt niet gecontroleerd.
Gegevens die worden verzonden tussen client en server, worden versleuteld.

TransparentNetworkIPResolution - SQL_COPT_SS_TNIR

Beheert de functie Transparent Network IP Resolution, een legacy multi-IP fallback voor de ODBC-driver. Deze instelling heeft geen invloed op de verbindingsvolgorde als MultiSubnetFailover=Yes, wat de aanbevolen instelling is voor Azure SQL Database, Azure SQL Managed Instance, SQL-database in Microsoft Fabric, listeners voor beschikbaarheidsgroepen en failoverclusterexemplaren. Voor meer informatie raadpleegt u Transparante netwerk-IP-resolutie gebruiken met het ODBC-stuurprogramma of Hoge beschikbaarheid en noodherstel.

Trefwoordwaarde Kenmerkwaarde Description
Enabled (standaard) SQL_IS_ON Maakt transparante IP-resolutie in het netwerk mogelijk.
Disabled SQL_IS_OFF Schakelt transparante IP-resolutie van het netwerk uit.

UseFMTONLY

Beheert het gebruik van SET FMTONLY voor metadata bij verbinding met SQL Server 2012 en latere versies.

Trefwoordwaarde Description
No (standaard) Gebruik sp_describe_first_result_set voor metagegevens indien beschikbaar.
Yes Gebruiken SET FMTONLY voor metagegevens.

Replication

Specificeert het gebruik van een replicatie-login op ODBC Driver versie 17.8 en latere versies.

Trefwoordwaarde Description
No (standaard) Replicatie-login wordt niet gebruikt.
Yes Triggers met de NOT FOR REPLICATION optie worden niet geactiveerd op de verbinding.

PacketSize

Driver 18.7 ondersteunt het gebruik van PacketSize om de netwerkpakketgrootte in bytes op te vragen. De onderhandelde grootte kan afwijken van de gevraagde waarde. Gebruik SQL_ATTR_PACKET_SIZE om het bijbehorende verbindingsatribuut in te stellen of de onderhandelde grootte op te halen. Voor attributlimieten en gedrag, zie SQLSetConnectAttr. Driver 17-applicaties gebruiken het attribuut in plaats van het PacketSize trefwoord.

RetryExec

Configureerbare herprobeerlogica is beschikbaar in Driver 18.1 en latere versies. Driver 17 ondersteunt RetryExecniet. Schakel het in met het verbindingsreeks-trefwoord RetryExec en een lijst met regels die de heruitvoering van SQLExecDirect en SQLExecute regelen.

Na een uitvoeringsfout selecteert de driver de eerste regel waarvan de foutenlijst die foutcode bevat. Vervolgens controleert het het queryvoorvoegsel van die regel tegen de inkomende opdrachttekst voor SQLExecDirect of de voorbereide tekst voor SQLExecute. Als het voorvoegsel niet overeenkomt, probeert de driver het commando niet opnieuw of gaat hij niet verder naar latere regels. Een latere match-all-regel is geen terugval voor een foutcode die al in een eerdere regel is vermeld.

Probeer alleen bewerkingen opnieuw die veilig kunnen worden herhaald. Een herpoging kan een opdracht meer dan eens uitvoeren, en een verbindingsfout bewijst niet dat een eerdere schrijfopdracht niet is voltooid.

De waarde van het RetryExec trefwoord is een lijst van herhalingsregels die met puntkomma gescheiden zijn.
RetryExec={rule1;rule2}

Een regel voor opnieuw proberen is als volgt: <errormatch>:<retrypolicy>:<querymatch>

  • Foutovereenstemming: Een lijst met foutcodes die door komma gescheiden zijn, zoals 1000,2000.

  • Herpogingsbeleid: Het aantal herpogingen gevolgd door de initiële vertraging in seconden. Zo 3,10+7 staat het drie pogingen toe na de eerste uitvoering, met vertragingen van 10, 17 en 24 seconden: in totaal vier executies als elke poging mislukt. Zonder +, verdubbelt de vertraging bij elke herhaling. Een trailing + zonder increment gebruikt de initiële vertraging als increment.

  • Query match: Het voorvoegsel van de opdrachttekst. Een leeg prefix geldt voor alle commando's. Bijvoorbeeld, SELECT komt overeen met commando's die beginnen met SELECT.

Het combineren van alle drie de componenten voor gebruik in een verbindingsreeks:

RetryExec={1000,2000:3,10+7:SELECT}

Voor fouten 1000 en 2000 op een commando dat begint met SELECT, staat deze regel drie pogingen toe, na 10, 17 en 24 seconden.

Voorbeelden

40501,40540:4,5

Voor fouten 40501 en 40540, probeer tot vier keer opnieuw, met een initiële vertraging van 5 seconden, en exponentiële verdubbeling tussen elke poging. Deze regel is van toepassing op alle query's.

49919:2,10+:CREATE

Voor fout 49919 bij een query die begint met CREATE, probeer je hooguit twee keer opnieuw, eerst na 10 seconden, en daarna 20 seconden.

49918,40501,10928:5,10+5:SELECT c1

Voor fouten 49918, 40501, en 10928 bij queries die beginnen met SELECT c1, probeer je tot vijf keer opnieuw, wacht 10 seconden bij de eerste poging en verhoog daarna de wachttijd met 5 seconden.

Specificeer de voorgaande drie regels samen in de verbindingsreeks als volgt:

RetryExec={49918,40501,10928:5,10+5:SELECT c1;49919:2,10+:CREATE;40501,40540:4,5}

In deze combinatie selecteert error 40501 de eerste regel en herhaalt alleen commando's die beginnen met SELECT c1. De definitieve regel biedt geen back-up voor andere commando's die mislukken met 40501. Om het definitieve beleid toe te passen op alle commando's met die foutmelding, verwijder 40501 uit de foutenlijst van de eerste regel. Geef de voorkeur aan niet-overlappende foutenlijsten wanneer elke code één beleid nodig heeft.

Klantcertificaat

Specificeert het certificaat voor authenticatie met loopback-verbindingen. Deze optie is alleen beschikbaar in SQL Server on Linux. De opties zijn:

Optiewaarde Description
sha1:<hash_value> De ODBC-driver gebruikt de Secure Hash Algorithm 1 (SHA-1) hash om een certificaat te vinden in de Windows Certificate Store.
subject:<subject> De ODBC-driver gebruikt het onderwerp om een certificaat te vinden in de Windows Certificate Store.
file:<file_location>[,password:<password>] Het ODBC-stuurprogramma maakt gebruik van een certificaatbestand.

Als het certificaat in Personal Information Exchange (PFX)-formaat is en de privésleutel is met een wachtwoord beveiligd, voeg dan het password trefwoord toe. Voor certificaten in Privacy Enhanced Mail (PEM) en Distinguished Encoding Rules (DER)-formaten, voeg het ClientKey trefwoord toe.

ClientKey

Specificeert de bestandslocatie van de privésleutel voor PEM of DER certificaten die door het ClientCertificate attribuut worden gespecificeerd. Formaat:

Optiewaarde Description
file:<file_location>[,password:<password>] Specificeert de locatie van het privésleutelbestand.

Als het privésleutelbestand met een wachtwoord beveiligd is, voeg dan het password trefwoord toe. Als het wachtwoord tekens , bevat, voeg dan direct na elk teken een extra , teken toe. Als het wachtwoord bijvoorbeeld isa,b,c, is het ontsnapte wachtwoord in de verbindingsreeks a,,b,,c.

HostnameInCertificate

Specificeert de hostnaam die verwacht moet worden in het certificaat van de server wanneer encryptie wordt onderhandeld, als deze verschilt van de standaardwaarde afgeleid van Addr, Address, of Server. De HostnameInCertificate optie wordt genegeerd wanneer je de ServerCertificate optie gebruikt.

IpAddressPreference

Vanaf versie 18.1 gebruik je deze optie om het type IP-adres aan te geven dat prioriteit moet geven voor verbindingen.

De mogelijke opties zijn IPv4First, IPv6First, en UsePlatformDefault. UsePlatformDefault Maakt verbinding met adressen in de volgorde waarin ze door de systeemaanroep worden opgegeven om de servernaam op te lossen. De standaardwaarde is IPv4First, wat overeenkomt met het gedrag in eerdere versies.

ServerCertificate

Gebruik deze optie vanaf versie 18.1 alleen met strikte encryptiemodus. Gebruik het ServerCertificate trefwoord om het pad naar een certificaatbestand op te geven dat moet worden gekoppeld aan het TLS-certificaat van de server. Bestandsmatching vervangt de normale hostnaam- en trust-chain-validatie, maar de driver controleert nog steeds de geldigheidsdata van het servercertificaat. Gebruik een certificaatbestand met PEM- of DER-codering. Bestanden met een .cer extensie worden geaccepteerd wanneer ze een van deze coderingen gebruiken. Het servercertificaat moet exact overeenkomen met het certificaat in het opgegeven bestand.

SQL_COPT_SS_ACCESS_TOKEN

Gebruik een Microsoft Entra ID-toegangstoken voor authenticatie. Voor meer informatie, zie Gebruik Microsoft Entra ID met de ODBC-driver.

Kenmerkwaarde Description
NULL (standaard) Er wordt geen toegangstoken geleverd.
ACCESSTOKEN* Aanwijzer naar een toegangstoken.

SQL_COPT_SS_CEKEYSTOREDATA

Communiceert met een geladen keystore-providerbibliotheek. Besturingselementen voor transparante kolomversleuteling (Always Encrypted). Dit kenmerk heeft geen standaardwaarde. Zie Aangepaste sleutelarchiefproviders voor meer informatie.

Kenmerkwaarde Description
CEKEYSTOREDATA * Communicatiegegevensstructuur voor een keystore-providerbibliotheek.

SQL_COPT_SS_CEKEYSTOREPROVIDER

Laadt een sleutelarchiefproviderbibliotheek voor Always Encrypted of haalt de namen van geladen sleutelarchiefproviderbibliotheken op. Zie Aangepaste sleutelarchiefproviders voor meer informatie. Dit kenmerk heeft geen standaardwaarde.

Kenmerkwaarde Description
char * Pad naar een keystore-providerbibliotheek.

SQL_COPT_SS_ENLIST_IN_XA

Om een verbinding te registreren in XA-gedistribueerde transacties, roep SQLSetConnectAttr aan met SQL_COPT_SS_ENLIST_IN_XA en een pointer naar een XACALLPARAM object. Deze optie wordt ondersteund op Windows (versie 17.3 en later), Linux en macOS.

SQLSetConnectAttr(hdbc, SQL_COPT_SS_ENLIST_IN_XA, param, SQL_IS_POINTER);  // XACALLPARAM *param

Om een XA-transactie alleen aan een ODBC-verbinding te koppelen, geeft u TRUE of FALSE met SQL_COPT_SS_ENLIST_IN_XA in plaats van de pointer op bij het aanroepen van SQLSetConnectAttr. Deze instelling is alleen geldig in Windows en kan niet worden gebruikt om XA-bewerkingen op te geven via een clienttoepassing.

SQLSetConnectAttr(hdbc, SQL_COPT_SS_ENLIST_IN_XA, (SQLPOINTER)TRUE, 0);
Waarde Description Platformen
XACALLPARAM object* De aanwijzer naar XACALLPARAM object. Windows, Linux en macOS
TRUE Koppelt de XA-transactie aan de ODBC-verbinding. Alle gerelateerde databaseactiviteiten worden uitgevoerd onder de beveiliging van de XA-transactie. Ramen
FALSE Ontkoppelt de transactie met de ODBC-verbinding. Ramen

Zie XA-transacties gebruiken voor meer informatie over XA-transacties.

SQL_COPT_SS_LONGASMAX

Bepaalt of de driver lange teken- en binaire parameters verzendt als varchar(max), nvarchar(max) en varbinary(max). Driver 18 ondersteunt deze optie; Driver 17 niet.

Kenmerkwaarde Description
SQL_XL_OFF (0, standaard) Zet lange types niet om naar maximale types bij het verzenden.
SQL_XL_ON (1) Converteer lange types naar maximale types bij het verzenden.

Dit zijn numerieke waarden voor SQLSetConnectAttr. Het bijbehorende LongAsMax verbindingsreeks-trefwoord gebruikt No en Yes.

SQL_COPT_SS_SPID

Haalt de sessie-id van de verbinding op. Deze eigenschap is gelijkwaardig aan de Transact-SQL (T-SQL) @@SPID-variabele, behalve dat er geen extra roundtrip naar de server ontstaat.

Kenmerkwaarde Description
DWORD Sessie-id.