Dokumentacja interfejsu API ODBC

Dotyczy:SQL ServerAzure SQL DatabaseAzure SQL Managed Instance

Interfejs API ODBC udostępnia standardowy zestaw funkcji do nawiązywania połączenia ze źródłami danych, wykonywania instrukcji SQL i pobierania wyników. Każda funkcja jest funkcją języka programowania C z opisami, które obejmują przeznaczenie, wersję ODBC, składnię, argumenty, wartości zwracane, diagnostykę i przykłady kodu.

Standardowy poziom zgodności interfejsu wiersza polecenia może być jednym z następujących elementów: ISO 92, Open Group, ODBC lub Deprecated. Funkcja oznaczona jako zgodna z normą ISO 92 jest również wyświetlana w grupie Open Group w wersji 1, ponieważ Open Group jest czystym nadzbiorem ISO 92. Funkcja oznaczona jako zgodna ze standardem Open Group jest również wyświetlana w wersji ODBC 3.x, ponieważ ODBC 3.x jest czystym nadzbiorem open group w wersji 1. Funkcja oznaczona jako zgodna ze standardem ODBC nie jest wyświetlana w obu standardach. Funkcja oznaczona jako przestarzała została uznana za przestarzałą w wersji ODBC 3.x.

Opis funkcji SQLGetDiagField opisuje sposób obsługi informacji diagnostycznych. Tekst skojarzony z wartościami SQLSTATE zawiera opis warunku, ale nie określa określonego tekstu.

Uwaga / Notatka

Aby uzyskać informacje dotyczące funkcji ODBC specyficzne dla sterownika, zobacz sekcję dotyczącą sterownika.

Obsługa alokacji i zarządzania

Te funkcje przydzielają i zwalniają dojścia dla środowisk, połączeń, instrukcji i deskryptorów. Dojścia są podstawowym mechanizmem śledzenia stanu w aplikacjach ODBC.

Funkcja	Description
Sqlallochandle	Przydziela dojście środowiska, połączenia, instrukcji lub deskryptora. Jest to funkcja ODBC 3.x, która zastępuje przestarzałe funkcje alokacji.
Sqlfreehandle	Zwalnia środowisko, połączenie, instrukcję lub deskryptor do obsługi i wydania skojarzonych zasobów.
SQLAllocConnect	Przydziela uchwyt połączenia. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLAllocHandle polecenia .
SQLAllocEnv	Przydziela dojście środowiska. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLAllocHandle polecenia .
SQLAllocStmt	Przydziela uchwyt instrukcji. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLAllocHandle polecenia .
SQLFreeConnect	Zwalnia uchwyt połączenia. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLFreeHandle polecenia .
SQLFreeEnv	Zwalnia uchwyt środowiska. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLFreeHandle polecenia .
Sqlfreestmt	Zatrzymuje przetwarzanie instrukcji, zamyka skojarzone kursory, odrzuca oczekujące wyniki i opcjonalnie zwalnia zasoby skojarzone z uchwytem instrukcji.

Funkcje połączenia

Te funkcje ustanawiają połączenia ze źródłami danych i zarządzają nimi. Obsługują różne metody połączenia, w tym standardowe połączenia, okna dialogowe specyficzne dla sterownika i przeglądanie iteracyjne.

Funkcja	Description
Sqlconnect	Ustanawia połączenie ze źródłem danych przy użyciu nazwy źródła danych, identyfikatora użytkownika i hasła.
Sqldriverconnect	Ustanawia połączenie przy użyciu parametrów połączenia. Obsługuje okna dialogowe specyficzne dla sterownika, aby uzyskać dodatkowe informacje o połączeniu.
Sqlbrowseconnect	Obsługuje iteracyjną metodę odnajdywania i wyliczania atrybutów wymaganych do nawiązania połączenia ze źródłem danych.
SQLDisconnect	Zamyka połączenie ze źródłem danych i zwalnia skojarzone zasoby.
SQLDataSources	Zwraca listę dostępnych źródeł danych. Wywołany menedżer sterowników, a nie określony sterownik.
SQLDrivers	Zwraca listę zainstalowanych sterowników i ich atrybutów. Wezwał menedżera sterowników.

Przygotowywanie i wykonywanie instrukcji

Te funkcje przygotowują i wykonują instrukcje SQL. Funkcja ODBC obsługuje zarówno bezpośrednie wykonywanie, jak i przygotowane wykonanie, a przygotowanie wykonania zapewnia lepszą wydajność dla wielokrotnie wykonywanych instrukcji.

Funkcja	Description
Sqlprepare	Przygotowuje instrukcję SQL do późniejszego wykonania. Źródło danych kompiluje i optymalizuje instrukcję .
Sqlexecute	Wykonuje przygotowaną instrukcję. Przed wywołaniem tej funkcji wywołaj metodę SQLPrepare .
Sqlexecdirect	Przygotowuje i wykonuje instrukcję SQL w jednym wywołaniu. Użyj polecenia dla instrukcji wykonanych tylko raz.
SQLNativeSql	Zwraca ciąg SQL zmodyfikowany przez sterownik, pokazujący, jak sterownik tłumaczy składnię ODBC SQL.
Sqlcancel	Anuluje przetwarzanie w instrukcji. Może anulować asynchronicznie wykonującą funkcję lub funkcję działającą w innym wątku.
SQLCancelHandle	Anuluje przetwarzanie na połączeniu lub instrukcji. Bardziej elastyczne niż SQLCancel w przypadku anulowania funkcji połączenia.
SQLCompleteAsync	Określa, kiedy funkcja asynchroniczna jest wykonywana. Używany z przetwarzaniem asynchronicznym opartym na powiadomieniach.

Wiązanie parametrów

Te funkcje wiążą zmienne aplikacji ze znacznikami parametrów w instrukcjach SQL. Parametry umożliwiają dynamiczne wartości w przygotowanych instrukcjach.

Funkcja	Description
Sqlbindparameter	Wiąże zmienną aplikacji ze znacznikiem parametru w instrukcji SQL. Obsługuje parametry wejściowe, wyjściowe i wejściowe/wyjściowe.
SQLNumParams	Zwraca liczbę parametrów w instrukcji SQL.
Sqldescribeparam	Zwraca opis znacznika parametru, w tym typ danych, rozmiar i precyzję.
Sqlparamdata	SQLPutData Służy do dostarczania danych parametrów w czasie wykonywania. Zwraca parametr wymagający danych.
Sqlputdata	Wysyła część lub całą wartość danych dla parametru w czasie wykonywania. Obsługuje duże dane we fragmentach.
SQLSetParam	Tworzy powiązanie parametru. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLBindParameter polecenia .
SQLParamOptions	Ustawia opcje dla tablic parametrów. Przestarzałe w odBC 3.x; Zamiast tego użyj atrybutów instrukcji.

Powiązanie i pobieranie zestawu wyników

Te funkcje wiążą bufory aplikacji z kolumnami zestawu wyników i pobierają dane z wyników zapytania.

Funkcja	Description
Sqlbindcol	Wiąże zmienną aplikacji z kolumną zestawu wyników dla kolejnych operacji pobierania.
Sqlfetch	Pobiera następny zestaw wierszy danych z zestawu wyników do powiązanych kolumn.
Sqlfetchscroll	Pobiera określony zestaw wierszy z zestawu wyników. Obsługuje przewijanie do pozycji pierwszej, ostatniej, następnej, wcześniejszej, bezwzględnej i względnej.
Sqlgetdata	Pobiera dane dla pojedynczej kolumny po SQLFetch lub SQLFetchScroll. Przydatne w przypadku dużych danych lub niezwiązanych kolumn.
SqlExtendedFetch	Pobiera określony zestaw wierszy danych. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLFetchScroll polecenia .
Sqlmoreresults	Określa, czy więcej wyników jest dostępnych w instrukcji i przechodzi do następnego zestawu wyników.
Sqlrowcount	Zwraca liczbę wierszy, których dotyczy instrukcja UPDATE, INSERT lub DELETE.

Operacje kursora

Te funkcje zarządzają zachowaniem kursora, pozycjonowaniem i operacjami zbiorczym w zestawach wierszy.

Funkcja	Description
Sqlsetpos	Ustawia położenie kursora w zestawie wierszy i umożliwia aplikacjom odświeżanie, aktualizowanie lub usuwanie danych w tej pozycji.
Sqlbulkoperations	Wykonuje operacje wstawiania zbiorczego, aktualizowania, usuwania lub pobierania według zakładek w zestawach wierszy.
SQLCloseCursor	Zamyka kursor otwarty na instrukcji i odrzuca oczekujące wyniki.
Sqlgetcursorname	Zwraca nazwę kursora skojarzona z instrukcją .
SQLSetCursorName	Określa nazwę kursora dla umieszczonych instrukcji UPDATE i DELETE.
SQLSetScrollOptions	Ustawia opcje zachowania kursora. Przestarzałe w odBC 3.x; Zamiast tego użyj atrybutów instrukcji.

Funkcje wykazu

Te funkcje pobierają metadane dotyczące struktury bazy danych, w tym tabele, kolumny, indeksy, uprawnienia i procedury składowane.

Funkcja	Description
Sqltables	Zwraca listę nazw tabel w źródle danych. Obsługuje filtrowanie według katalogu, schematu i typu tabeli.
Sqlcolumns	Zwraca listę nazw kolumn i ich atrybutów dla określonych tabel.
Sqlprimarykeys	Zwraca kolumny tworzące klucz podstawowy dla tabeli.
Sqlforeignkeys	Zwraca klucze obce w tabeli lub klucza obcego w innych tabelach odwołujących się do klucza podstawowego tabeli.
SqlStatistics	Zwraca statystyki dotyczące tabeli i listę skojarzonych z nią indeksów.
Sqlspecialcolumns	Zwraca kolumny, które jednoznacznie identyfikują wiersz lub kolumny, które są automatycznie aktualizowane po zaktualizowaniu dowolnej wartości w wierszu.
SQLColumnPrivileges	Zwraca listę kolumn i skojarzone uprawnienia dla tabeli.
SQLTablePrivileges	Zwraca listę tabel i uprawnienia skojarzone z każdą tabelą.
Sqlprocedures	Zwraca listę nazw procedur składowanej w źródle danych.
Sqlprocedurecolumns	Zwraca listę parametrów wejściowych/wyjściowych i kolumn w zestawie wyników dla określonych procedur.
Sqlgettypeinfo	Zwraca informacje o typach danych obsługiwanych przez źródło danych.

Operacje deskryptora

Te funkcje pobierają i ustawiają wartości deskryptora. Deskryptory zawierają metadane dotyczące parametrów i kolumn zestawu wyników.

Funkcja	Description
Sqlgetdescfield	Zwraca wartość pojedynczego pola rekordu deskryptora.
SQLGetDescRec	Zwraca wiele pól rekordu deskryptora w jednym wywołaniu.
SQLSetDescField	Ustawia wartość pojedynczego pola rekordu deskryptora.
Sqlsetdescrec	Ustawia wiele pól rekordu deskryptora w jednym wywołaniu.
SQLCopyDesc	Kopiuje informacje deskryptora z jednego uchwytu deskryptora do innego.

Funkcje atrybutów

Te funkcje pobierają i ustawiają atrybuty dla środowisk, połączeń i instrukcji. Atrybuty kontrolują różne aspekty zachowania ODBC.

Funkcja	Description
Sqlzestawenvattr	Ustawia atrybut środowiska, który ma wpływ na wszystkie połączenia w tym środowisku.
SQLGetEnvAttr	Zwraca wartość atrybutu środowiska.
SQLSetConnectAttr	Ustawia atrybut połączenia, który wpływa na połączenie i instrukcje na nim.
Sqlgetconnectattr	Zwraca wartość atrybutu połączenia.
SQLSetStmtAttr	Ustawia atrybut instrukcji. Obejmuje ustawienia kursora, limitu czasu zapytania i parametrów.
SQLGetStmtAttr	Zwraca wartość atrybutu instrukcji.
SQLSetConnectOption	Ustawia opcję połączenia. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLSetConnectAttr polecenia .
SQLGetConnectOption	Zwraca wartość opcji połączenia. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLGetConnectAttr polecenia .
SQLSetStmtOption	Ustawia opcję instrukcji. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLSetStmtAttr polecenia .
SQLGetStmtOption	Zwraca wartość opcji instrukcji. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLGetStmtAttr polecenia .

Funkcje diagnostyczne i informacyjne

Te funkcje pobierają informacje diagnostyczne, komunikaty o błędach, możliwości sterownika i informacje o źródle danych.

Funkcja	Description
Sqlgetdiagfield	Zwraca wartość pola w rekordzie diagnostycznym zawierającym informacje o błędzie, ostrzeżeniu i stanie.
Sqlgetdiagrec	Zwraca kilka często używanych pól rekordu diagnostycznego, w tym SQLSTATE, natywny kod błędu i tekst komunikatu.
Sqlerror	Zwraca informacje o błędzie. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLGetDiagRec polecenia .
Sqlgetfunctions	Zwraca informacje o tym, czy sterownik obsługuje określoną funkcję ODBC.
Sqlgetinfo	Zwraca ogólne informacje o sterowniku i źródle danych, w tym obsługiwane funkcje i możliwości.

Metadane zestawu wyników

Te funkcje zwracają informacje o strukturze zestawów wyników.

Funkcja	Description
Sqlnumresultcols	Zwraca liczbę kolumn w zestawie wyników.
Sqldescribecol	Zwraca nazwę kolumny, typ danych, precyzję, skalę i wartość null dla kolumny zestawu wyników.
Sqlcolattribute	Zwraca informacje deskryptora dla kolumny w zestawie wyników. Bardziej elastyczne niż SQLDescribeCol.
SQLColAttributes	Zwraca atrybuty dla kolumny. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLColAttribute polecenia .

Zarządzanie transakcjami

Te funkcje zarządzają granicami transakcji, kontrolując, kiedy zmiany są zatwierdzane lub cofane.

Funkcja	Description
Sqlendtran	Zatwierdza lub cofa transakcję. Może dotyczyć wszystkich połączeń w środowisku lub jednym połączeniu.
SQLTransact	Zatwierdza lub cofa transakcję. Przestarzałe w odBC 3.x; Zamiast tego użyj SQLEndTran polecenia .

Treści powiązane

• Omówienie ODBC
• Tworzenie aplikacji
• Dokumentacja programisty ODBC