Referenční informace k rozhraní API ODBC

platí pro: SQL Server Azure SQL DatabaseAzure SQL Managed Instance

Rozhraní ODBC API poskytuje standardní sadu funkcí pro připojení ke zdrojům dat, spouštění příkazů SQL a načítání výsledků. Každá funkce je funkce programovacího jazyka C s popisy, které zahrnují účel, verzi ODBC, syntaxi, argumenty, návratové hodnoty, diagnostiku a příklady kódu.

Standardní úroveň shody rozhraní příkazového řádku může být jedna z následujících možností: ISO 92, Otevřená skupina, ODBC nebo Zastaralé. Funkce označená jako shoda ISO 92 se také zobrazí ve verzi 1 open group, protože Open Group je čistě nadmnožina ISO 92. V rozhraní ODBC 3.x se také zobrazí funkce označená jako kompatibilní se skupinami Open Group, protože ODBC 3.x je čistě nadmnožina open group verze 1. Funkce označená jako kompatibilní se standardem ODBC se nezobrazuje. Funkce označená jako zastaralá byla v odbc 3.x zastaralá.

Popis funkce SQLGetDiagField popisuje, jak zpracovávat diagnostické informace. Text přidružený k hodnotám SQLSTATE poskytuje popis podmínky, ale předepisuje konkrétní text.

Poznámka:

Informace o funkcích ODBC specifické pro ovladač naleznete v části pro ovladač.

Zpracování přidělování a správy

Tyto funkce přidělují a uvolní popisovače pro prostředí, připojení, příkazy a popisovače. Popisovače jsou primárním mechanismem pro sledování stavu v aplikacích ODBC.

Funkce	Description
SQLAllocHandle	Přidělí prostředí, připojení, příkaz nebo popisovač popisovače. Toto je funkce ODBC 3.x, která nahrazuje zastaralé funkce přidělování.
SQLFreeHandle	Uvolní prostředí, připojení, příkaz nebo popisovač popisovače a uvolní přidružené prostředky.
SQLAllocConnect	Přidělí popisovač připojení. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLAllocHandle .
SQLAllocEnv	Přidělí popisovač prostředí. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLAllocHandle .
SQLAllocStmt	Přidělí popisovač příkazu. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLAllocHandle .
SQLFreeConnect	Uvolní popisovač připojení. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLFreeHandle .
SQLFreeEnv	Uvolní popisovač prostředí. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLFreeHandle .
Sqlfreestmt	Zastaví zpracování příkazů, zavře přidružené kurzory, zahodí čekající výsledky a volitelně uvolní prostředky přidružené k popisovači příkazu.

Funkce připojení

Tyto funkce vytvářejí a spravují připojení ke zdrojům dat. Podporují různé metody připojení, včetně standardních připojení, dialogových oken specifických pro ovladače a iterativního procházení.

Funkce	Description
Sqlconnect	Vytvoří připojení ke zdroji dat pomocí názvu zdroje dat, ID uživatele a hesla.
Sqldriverconnect	Vytvoří připojení pomocí připojovacího řetězce. Podporuje dialogy specifické pro ovladače pro další informace o připojení.
Sqlbrowseconnect	Podporuje iterativní metodu zjišťování a výčet atributů potřebných pro připojení ke zdroji dat.
SQLDisconnect	Zavře připojení ke zdroji dat a uvolní přidružené prostředky.
SQLDataSources	Vrátí seznam dostupných zdrojů dat. Volal na správce ovladačů, ne na konkrétní ovladač.
SQLDrivers	Vrátí seznam nainstalovaných ovladačů a jejich atributů. Volal na správce ovladačů.

Příprava a spouštění příkazů

Tyto funkce připraví a spustí příkazy SQL. Rozhraní ODBC podporuje přímé spouštění i připravené spouštění, přičemž připravené spouštění nabízí lepší výkon pro opakovaně spouštěné příkazy.

Funkce	Description
Sqlprepare	Připraví příkaz SQL pro pozdější spuštění. Zdroj dat kompiluje a optimalizuje příkaz.
Sqlexecute	Spustí připravený příkaz. Volání SQLPrepare před voláním této funkce
Sqlexecdirect	Připraví a spustí příkaz SQL v jednom volání. Příkazy se používají pouze jednou.
SQLNativeSql	Vrátí řetězec SQL upravený ovladačem, který ukazuje, jak ovladač překládá syntaxi ODBC SQL.
SQLCancel	Zruší zpracování příkazu. Může zrušit asynchronně spuštěnou funkci nebo funkci spuštěnou v jiném vlákně.
SQLCancelHandle	Zruší zpracování připojení nebo příkazu. Flexibilnější než SQLCancel zrušení funkcí připojení.
SQLCompleteAsync	Určuje, kdy se asynchronní funkce dokončí. Používá se s asynchronním zpracováním založeným na oznámeních.

Přiřazení parametrů

Tyto funkce sváže proměnné aplikace se značkami parametrů v příkazech SQL. Parametry umožňují dynamické hodnoty v připravených příkazech.

Funkce	Description
Sqlbindparameter	Vytvoří vazbu proměnné aplikace na značku parametru v příkazu SQL. Podporuje vstupní, výstupní a vstupní a výstupní parametry.
SQLNumParams	Vrátí počet parametrů v příkazu SQL.
Sqldescribeparam	Vrátí popis značky parametru, včetně datového typu, velikosti a přesnosti.
Sqlparamdata	SQLPutData Používá se k zadávání dat parametrů v době provádění. Vrátí parametr, který potřebuje data.
Sqlputdata	Odešle část nebo celou datovou hodnotu parametru v době spuštění. Podporuje velká data v blocích dat.
SQLSetParam	Vytvoří vazbu parametru. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLBindParameter .
SQLParamOptions	Nastaví možnosti pro pole parametrů. Zastaralé v rozhraní ODBC 3.x; místo toho použijte atributy příkazu use.

Vazba a načtení sady výsledků

Tyto funkce sváže vyrovnávací paměti aplikace s cílem nastavit sloupce sady výsledků a načítat data z výsledků dotazu.

Funkce	Description
Sqlbindcol	Vytvoří vazbu proměnné aplikace na sloupec sady výsledků pro následné operace načtení.
SqlFetch	Načte další sadu řádků dat ze sady výsledků do vázaných sloupců.
Sqlfetchscroll	Načte zadanou sadu řádků ze sady výsledků. Podporuje posouvání na první, poslední, další, předchozí, absolutní a relativní pozice.
Sqlgetdata	Načte data pro jeden sloupec za SQLFetch nebo SQLFetchScroll. Užitečné pro velká data nebo nevázané sloupce.
SQLExtendedFetch	Načte zadanou sadu řádků dat. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLFetchScroll .
Sqlmoreresults	Určuje, zda jsou pro příkaz k dispozici další výsledky, a přejde na další sadu výsledků.
SQLRowCount	Vrátí počet řádků ovlivněných příkazem UPDATE, INSERT nebo DELETE.

Operace kurzoru

Tyto funkce spravují chování kurzoru, umístění a hromadné operace na sadách řádků.

Funkce	Description
Sqlsetpos	Nastaví pozici kurzoru v sadě řádků a umožňuje aplikacím aktualizovat, aktualizovat nebo odstranit data v dané pozici.
SQLBulkOperations	Provádí operace hromadného vložení, aktualizace, odstranění nebo načítání podle záložek u sad řádků.
SQLCloseCursor	Zavře kurzor otevřený na příkazu a zahodí čekající výsledky.
SQLGetCursorName	Vrátí název kurzoru přidružený k příkazu.
SQLSetCursorName	Určuje název kurzoru pro umístěné příkazy UPDATE a DELETE.
SQLSetScrollOptions	Nastaví možnosti chování kurzoru. Zastaralé v rozhraní ODBC 3.x; místo toho použijte atributy příkazu use.

Funkce katalogu

Tyto funkce načítají metadata o struktuře databáze, včetně tabulek, sloupců, indexů, oprávnění a uložených procedur.

Funkce	Description
Sqltables	Vrátí seznam názvů tabulek ve zdroji dat. Podporuje filtrování podle katalogu, schématu a typu tabulky.
Sqlcolumns	Vrátí seznam názvů sloupců a jejich atributů pro zadané tabulky.
SQLPrimaryKeys	Vrátí sloupce, které tvoří primární klíč tabulky.
SQLForeignKeys	Vrátí cizí klíče v tabulce nebo cizích klíčích v jiných tabulkách, které odkazují na primární klíč tabulky.
SQLStatistics	Vrátí statistiku o tabulce a seznamu indexů přidružených k tabulce.
Sqlspecialcolumns	Vrátí sloupce, které jednoznačně identifikují řádek nebo sloupce, které se automaticky aktualizují při aktualizaci libovolné hodnoty v řádku.
SQLColumnPrivileges	Vrátí seznam sloupců a přidružených oprávnění pro tabulku.
SQLTablePrivileges	Vrátí seznam tabulek a oprávnění přidružená ke každé tabulce.
SQLProcedures	Vrátí seznam názvů uložených procedur ve zdroji dat.
Sqlprocedurecolumns	Vrátí seznam vstupních/výstupních parametrů a sloupců v sadě výsledků pro zadané procedury.
Sqlgettypeinfo	Vrátí informace o datových typech podporovaných zdrojem dat.

Operace popisovače

Tyto funkce získávají a nastavují hodnoty popisovače. Popisovače obsahují metadata o parametrech a sloupcích sady výsledků.

Funkce	Description
Sqlgetdescfield	Vrátí hodnotu jednoho pole záznamu popisovače.
SQLGetDescRec	Vrátí více polí záznamu popisovače v jednom volání.
SQLSetDescField	Nastaví hodnotu jednoho pole záznamu popisovače.
Sqlsetdescrec	Nastaví více polí záznamu popisovače v jednom volání.
SQLCopyDesc	Zkopíruje informace popisovače z jednoho popisovače do jiného.

Funkce atributů

Tyto funkce získávají a nastavují atributy pro prostředí, připojení a příkazy. Atributy řídí různé aspekty chování rozhraní ODBC.

Funkce	Description
SQLSetEnvAttr	Nastaví atribut prostředí, který ovlivní všechna připojení v daném prostředí.
SQLGetEnvAttr	Vrátí hodnotu atributu prostředí.
SQLSetConnectAttr	Nastaví atribut připojení, který ovlivňuje připojení a příkazy v něm.
SQLGetConnectAttr	Vrátí hodnotu atributu připojení.
SQLSetStmtAttr	Nastaví atribut příkazu. Zahrnuje kurzor, časový limit dotazu a nastavení parametrů.
SQLGetStmtAttr	Vrátí hodnotu atributu příkazu.
SQLSetConnectOption	Nastaví možnost připojení. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLSetConnectAttr .
SQLGetConnectOption	Vrátí hodnotu možnosti připojení. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLGetConnectAttr .
SQLSetStmtOption	Nastaví možnost příkazu. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLSetStmtAttr .
SQLGetStmtOption	Vrátí hodnotu možnosti příkazu. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLGetStmtAttr .

Diagnostické a informační funkce

Tyto funkce načítají diagnostické informace, chybové zprávy, možnosti ovladačů a informace o zdroji dat.

Funkce	Description
Sqlgetdiagfield	Vrátí hodnotu pole v diagnostickém záznamu obsahujícím informace o chybě, upozornění a stavu.
SQLGetDiagRec	Vrátí několik běžně používaných polí diagnostického záznamu, včetně SQLSTATE, nativního kódu chyby a textu zprávy.
Chyba SQL	Vrátí informace o chybě. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLGetDiagRec .
FUNKCE SQLGetFunctions	Vrátí informace o tom, zda ovladač podporuje konkrétní funkci ODBC.
Sqlgetinfo	Vrátí obecné informace o ovladači a zdroji dat, včetně podporovaných funkcí a možností.

Metadata sady výsledků

Tyto funkce vrací informace o struktuře sad výsledků.

Funkce	Description
SQLNumResultCols	Vrátí počet sloupců v sadě výsledků.
SQLDescribeCol	Vrátí název sloupce, datový typ, přesnost, měřítko a hodnotu null sloupce sady výsledků.
Sqlcolattribute	Vrátí informace popisovače sloupce v sadě výsledků. Flexibilnější než SQLDescribeCol.
SQLColAttributes	Vrátí atributy pro sloupec. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLColAttribute .

Správa transakcí

Tyto funkce spravují hranice transakcí a řídí, kdy se změny potvrdí nebo vrátí zpět.

Funkce	Description
Sqlendtran	Potvrzení nebo vrácení transakce zpět. Může platit pro všechna připojení v prostředí nebo jednom připojení.
SQLTransact	Potvrzení nebo vrácení transakce zpět. Zastaralé v rozhraní ODBC 3.x; místo toho použijte SQLEndTran .

Související obsah

• Přehled rozhraní ODBC
• Vývoj aplikací
• Referenční dokumentace programátora ODBC