ODBC API-referens

gäller för:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

ODBC-API:et innehåller en standarduppsättning funktioner för att ansluta till datakällor, köra SQL-instruktioner och hämta resultat. Varje funktion är en C-programmeringsspråkfunktion med beskrivningar som inkluderar syfte, ODBC-version, syntax, argument, returvärden, diagnostik och kodexempel.

Standard-CLI-överensstämmelsenivån kan vara något av följande: ISO 92, Öppen grupp, ODBC eller Inaktuell. En funktion som är taggad som ISO 92-konform visas också i Open Group version 1, eftersom Open Group är en ren supermängd av ISO 92. En funktion som är taggad som Open Group-kompatibel visas också i ODBC 3.x, eftersom ODBC 3.x är en ren superuppsättning av Open Group version 1. En funktion som är taggad som ODBC-kompatibel visas inte i någon av standarderna. En funktion som har taggats som inaktuell har inaktuell i ODBC 3.x.

Funktionsbeskrivningen för SQLGetDiagField beskriver hur du hanterar diagnostikinformation. Texten som är associerad med SQLSTATE-värden innehåller en beskrivning av villkoret men föreskriver inte specifik text.

Anmärkning

Information om ODBC-funktioner finns i avsnittet för drivrutinen.

Hantera allokering och hantering

Dessa funktioner allokerar och kostnadsfria referenser för miljöer, anslutningar, instruktioner och beskrivningar. Referenser är den primära mekanismen för spårningstillstånd i ODBC-program.

Funktion	Description
SQLAllocHandle	Allokerar en miljö, anslutning, instruktion eller beskrivande handtag. Det här är funktionen ODBC 3.x som ersätter de inaktuella allokeringsfunktionerna.
SQLFreeHandle	Frigör en miljö, anslutning, instruktion eller beskrivande handtag och versioner av associerade resurser.
SQLAllocConnect	Allokerar ett anslutningshandtag. Inaktuell i ODBC 3.x; använd SQLAllocHandle i stället.
SQLAllocEnv	Allokerar en miljöreferens. Inaktuell i ODBC 3.x; använd SQLAllocHandle i stället.
SQLAllocStmt	Allokerar ett instruktionshandtag. Inaktuell i ODBC 3.x; använd SQLAllocHandle i stället.
SQLFreeConnect	Frigör ett anslutningshandtag. Inaktuell i ODBC 3.x; använd SQLFreeHandle i stället.
SQLFreeEnv	Frigör ett miljöhandtag. Inaktuell i ODBC 3.x; använd SQLFreeHandle i stället.
SQLFreeStmt	Stoppar instruktionsbearbetning, stänger associerade markörer, tar bort väntande resultat och frigör eventuellt resurser som är associerade med en instruktionsreferens.

Anslutningsfunktioner

Dessa funktioner upprättar och hanterar anslutningar till datakällor. De stöder olika anslutningsmetoder, inklusive standardanslutningar, drivrutinsspecifika dialogrutor och iterativ surfning.

Funktion	Description
SQLConnect	Upprättar en anslutning till en datakälla med datakällans namn, användar-ID och lösenord.
SQLDriverConnect	Upprättar en anslutning med hjälp av en anslutningssträng. Stöder drivrutinsspecifika dialogrutor för ytterligare anslutningsinformation.
SQLBrowseConnect	Stöder en iterativ metod för att identifiera och räkna upp de attribut som behövs för att ansluta till en datakälla.
SQLDisconnect	Stänger en anslutning till en datakälla och släpper associerade resurser.
SQLDataSources	Returnerar en lista över tillgängliga datakällor. Anropade Driver Manager, inte en specifik drivrutin.
SQLDrivers	Returnerar en lista över installerade drivrutiner och deras attribut. Anropade drivrutinshanteraren.

Förberedelse och körning av instruktion

Dessa funktioner förbereder och kör SQL-instruktioner. ODBC stöder både direkt körning och förberedd körning, med förberedd körning som ger bättre prestanda för upprepade utförda instruktioner.

Funktion	Description
SQLPrepare	Förbereder en SQL-instruktion för senare körning. Datakällan kompilerar och optimerar -instruktionen.
SQLExecute	Kör en förberedd instruktion. Anropa SQLPrepare innan du anropar den här funktionen.
SQLExecDirect	Förbereder och kör en SQL-instruktion i ett enda anrop. Använd endast för -instruktioner som körs en gång.
SQLNativeSql	Returnerar SQL-strängen som ändrats av drivrutinen och visar hur drivrutinen översätter ODBC SQL-syntax.
SQLCancel	Avbryter bearbetningen av en -instruktion. Kan avbryta en funktion som körs asynkront eller en funktion som körs på en annan tråd.
SQLCancelHandle	Avbryter bearbetningen av en anslutning eller instruktion. Mer flexibelt än SQLCancel för att avbryta anslutningsfunktioner.
SQLCompleteAsync	Avgör när en asynkron funktion slutförs. Används med meddelandebaserad asynkron bearbetning.

Parameterbindning

Dessa funktioner binder programvariabler till parametermarkörer i SQL-instruktioner. Parametrar aktiverar dynamiska värden i förberedda instruktioner.

Funktion	Description
SQLBindParameter	Binder en programvariabel till en parametermarkör i en SQL-instruktion. Stöder indata-, utdata- och indata-/utdataparametrar.
SQLNumParams	Returnerar antalet parametrar i en SQL-instruktion.
SQLDescribeParam	Returnerar beskrivningen av en parametermarkör, inklusive datatyp, storlek och precision.
SQLParamData	Används med SQLPutData för att ange parameterdata vid körning. Returnerar parametern som behöver data.
SQLPutData	Skickar en del av eller hela ett datavärde för en parameter vid körningstillfället. Stöder stora data i segment.
SQLSetParam	Binder en parameter. Inaktuell i ODBC 3.x; använd SQLBindParameter i stället.
SQLParamOptions	Anger alternativ för parametermatriser. Inaktuell i ODBC 3.x; använd instruktionsattribut i stället.

Bindning och hämtning av resultatuppsättning

Dessa funktioner binder programbuffertar till resultatuppsättningskolumner och hämtar data från frågeresultat.

Funktion	Description
SQLBindCol	Binder en programvariabel till en resultatuppsättningskolumn för efterföljande hämtningsåtgärder.
SQLFetch	Hämtar nästa raduppsättning med data från resultatuppsättningen till bundna kolumner.
SQLFetchScroll	Hämtar den angivna raduppsättningen från en resultatuppsättning. Stöder rullning till första, sista, nästa, tidigare, absoluta och relativa positioner.
SQLGetData	Hämtar data för en enskild kolumn efter SQLFetch eller SQLFetchScroll. Användbart för stora data eller obundna kolumner.
SQLExtendedFetch	Hämtar den angivna raduppsättningen med data. Inaktuell i ODBC 3.x; använd SQLFetchScroll i stället.
SQLMoreResults	Avgör om fler resultat är tillgängliga för en -instruktion och går vidare till nästa resultatuppsättning.
SQLRowCount	Returnerar antalet rader som påverkas av en UPDATE-, INSERT- eller DELETE-instruktion.

Marköråtgärder

Dessa funktioner hanterar markörbeteende, positionering och massåtgärder på raduppsättningar.

Funktion	Description
SQLSetPos	Anger markörens position inom en raduppsättning och gör att program kan uppdatera, uppdatera eller ta bort data på den positionen.
SQLBulkOperations	Utför massåtgärder för att infoga, uppdatera, ta bort eller hämta efter bokmärke på raduppsättningar.
SQLCloseCursor	Stänger en markör som har öppnats på en -instruktion och tar bort väntande resultat.
SQLGetCursorName	Returnerar markörens namn som är associerat med en -instruktion.
SQLSetCursorName	Anger ett markörnamn för positionerade UPDATE- och DELETE-instruktioner.
SQLSetScrollOptions	Anger alternativ för markörbeteende. Inaktuell i ODBC 3.x; använd instruktionsattribut i stället.

Katalogfunktioner

Dessa funktioner hämtar metadata om databasstrukturen, inklusive tabeller, kolumner, index, privilegier och lagrade procedurer.

Funktion	Description
SQLTables	Returnerar en lista med tabellnamn i datakällan. Stöder filtrering efter katalog, schema och tabelltyp.
SQLColumns	Returnerar en lista med kolumnnamn och deras attribut för angivna tabeller.
SQLPrimaryKeys	Returnerar de kolumner som utgör primärnyckeln för en tabell.
SQLForeignKeys	Returnerar sekundärnycklar i en tabell eller sekundärnycklar i andra tabeller som refererar till en tabells primärnyckel.
SQLStatistics	Returnerar statistik om en tabell och en lista över index som är associerade med den.
SQLSpecialColumns	Returnerar kolumner som unikt identifierar en rad eller kolumner som uppdateras automatiskt när ett värde på raden uppdateras.
SQLColumnPrivileges	Returnerar en lista med kolumner och associerade behörigheter för en tabell.
SQLTablePrivileges	Returnerar en lista över tabeller och de behörigheter som är associerade med varje tabell.
SQLProcedures	Returnerar en lista över lagrade procedurnamn i datakällan.
SQLProcedureColumns	Returnerar listan över indata-/utdataparametrar och kolumner i resultatuppsättningen för angivna procedurer.
SQLGetTypeInfo	Returnerar information om datatyper som stöds av datakällan.

Beskrivande åtgärder

Dessa funktioner hämtar och anger deskriptorvärden. Deskriptorer innehåller metadata om parametrar och resultatuppsättningskolumner.

Funktion	Description
SQLGetDescField	Returnerar värdet för ett enda fält i en deskriptorpost.
SQLGetDescRec	Returnerar flera fält i en deskriptorpost i ett enda anrop.
SQLSetDescField	Anger värdet för ett enda fält i en deskriptorpost.
SQLSetDescRec	Anger flera fält i en deskriptorpost i ett enda anrop.
SQLCopyDesc	Kopierar beskrivningsinformation från en deskriptorreferens till en annan.

Attributfunktioner

Dessa funktioner hämtar och anger attribut för miljöer, anslutningar och instruktioner. Attribut styr olika aspekter av ODBC-beteende.

Funktion	Description
SQLSetEnvAttr	Anger ett miljöattribut som påverkar alla anslutningar under den miljön.
SQLGetEnvAttr	Returnerar värdet för ett miljöattribut.
SQLSetConnectAttr	Anger ett anslutningsattribut som påverkar anslutningen och -uttrycken på den.
SQLGetConnectAttr	Returnerar värdet för ett anslutningsattribut.
SQLSetStmtAttr	Anger ett instruktionsattribut. Innehåller markör, tidsgräns för frågor och parameterinställningar.
SQLGetStmtAttr	Returnerar värdet för ett instruktionsattribut.
SQLSetConnectOption	Anger ett anslutningsalternativ. Inaktuell i ODBC 3.x; använd SQLSetConnectAttr i stället.
SQLGetConnectOption	Returnerar värdet för ett anslutningsalternativ. Inaktuell i ODBC 3.x; använd SQLGetConnectAttr i stället.
SQLSetStmtOption	Anger ett instruktionsalternativ. Inaktuell i ODBC 3.x; använd SQLSetStmtAttr i stället.
SQLGetStmtOption	Returnerar värdet för ett instruktionsalternativ. Inaktuell i ODBC 3.x; använd SQLGetStmtAttr i stället.

Diagnostik- och informationsfunktioner

Dessa funktioner hämtar diagnostikinformation, felmeddelanden, drivrutinsfunktioner och information om datakällor.

Funktion	Description
SQLGetDiagField	Returnerar värdet för ett fält i en diagnostikpost som innehåller fel-, varnings- och statusinformation.
SQLGetDiagRec	Returnerar flera vanliga fält i en diagnostikpost, inklusive SQLSTATE, intern felkod och meddelandetext.
SQLError	Returnerar felinformation. Inaktuell i ODBC 3.x; använd SQLGetDiagRec i stället.
SQLGetFunctions	Returnerar information om huruvida en drivrutin stöder en specifik ODBC-funktion.
SQLGetInfo	Returnerar allmän information om drivrutinen och datakällan, inklusive funktioner som stöds.

Metadata för resultatuppsättningar

Dessa funktioner returnerar information om strukturen för resultatuppsättningar.

Funktion	Description
SQLNumResultCols	Returnerar antalet kolumner i en resultatuppsättning.
SQLDescribeCol	Returnerar kolumnnamnet, datatypen, precisionen, skalan och nullbarheten för en resultatuppsättningskolumn.
SQLColAttribute	Returnerar beskrivningsinformation för en kolumn i en resultatuppsättning. Mer flexibel än SQLDescribeCol.
SQLColAttributes	Returnerar attribut för en kolumn. Inaktuell i ODBC 3.x; använd SQLColAttribute i stället.

Transaktionshantering

Dessa funktioner hanterar transaktionsgränser, styr när ändringar checkas in eller återställs.

Funktion	Description
SQLEndTran	Genomför eller återställer en transaktion. Kan tillämpas på alla anslutningar i en miljö eller en enda anslutning.
SQLTransact	Genomför eller återställer en transaktion. Inaktuell i ODBC 3.x; använd SQLEndTran i stället.

Relaterat innehåll

• ÖVERSIKT ÖVER ODBC
• Utveckla program
• ODBC-programmerarens referens