Referensi ODBC API

Berlaku untuk:SQL Server Azure SQL Database Azure SQL Managed Instance

ODBC API menyediakan serangkaian fungsi standar untuk menyambungkan ke sumber data, menjalankan pernyataan SQL, dan mengambil hasil. Setiap fungsi adalah fungsi bahasa pemrograman C dengan deskripsi yang mencakup tujuan, versi ODBC, sintaksis, argumen, nilai pengembalian, diagnostik, dan contoh kode.

Tingkat kesesuaian CLI standar dapat berupa salah satu hal berikut: ISO 92, Open Group, ODBC, atau Tidak digunakan lagi. Fungsi yang ditandai sebagai ISO 92-conformant juga muncul di Open Group versi 1, karena Open Group adalah superset murni ISO 92. Fungsi yang ditandai sebagai Open Group-compliant juga muncul di ODBC 3.x, karena ODBC 3.x adalah superset murni dari Open Group versi 1. Fungsi yang ditandai sebagai patuh ODBC tidak muncul di salah satu standar. Fungsi yang ditandai sebagai tidak digunakan lagi tidak digunakan lagi di ODBC 3.x.

Deskripsi fungsi SQLGetDiagField menjelaskan cara menangani informasi diagnostik. Teks yang terkait dengan nilai SQLSTATE memberikan deskripsi kondisi tetapi tidak meresepkan teks tertentu.

Nota

Untuk informasi khusus driver tentang fungsi ODBC, lihat bagian untuk driver.

Menangani alokasi dan manajemen

Fungsi-fungsi ini mengalokasikan dan menangani gratis untuk lingkungan, koneksi, pernyataan, dan deskriptor. Handel adalah mekanisme utama untuk melacak status dalam aplikasi ODBC.

Function	Description
SQLAllocHandle	Mengalokasikan lingkungan, koneksi, pernyataan, atau handel deskriptor. Ini adalah fungsi ODBC 3.x yang menggantikan fungsi alokasi yang tidak digunakan lagi.
SQLFreeHandle	Membebaskan lingkungan, koneksi, pernyataan, atau pegangan deskriptor dan merilis sumber daya terkait.
SQLAllocConnect	Mengalokasikan handel koneksi. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLAllocHandle` sebagai gantinya.
SQLAllocEnv	Mengalokasikan handel lingkungan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLAllocHandle` sebagai gantinya.
SQLAllocStmt	Mengalokasikan handel pernyataan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLAllocHandle` sebagai gantinya.
SQLFreeConnect	Mengosongkan handel koneksi. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLFreeHandle` sebagai gantinya.
SQLFreeEnv	Membebaskan handel lingkungan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLFreeHandle` sebagai gantinya.
SQLFreeStmt	Menghentikan pemrosesan pernyataan, menutup kursor terkait, membuang hasil yang tertunda, dan secara opsional membebaskan sumber daya yang terkait dengan handel pernyataan.

Fungsi koneksi

Fungsi-fungsi ini membuat dan mengelola koneksi ke sumber data. Mereka mendukung berbagai metode koneksi termasuk koneksi standar, dialog khusus driver, dan penjelajahan berulang.

Function	Description
SQLConnect	Membuat koneksi ke sumber data menggunakan nama sumber data, ID pengguna, dan kata sandi.
SQLDriverConnect	Membuat koneksi menggunakan string koneksi. Mendukung dialog khusus driver untuk informasi koneksi tambahan.
SQLBrowseConnect	Mendukung metode berulang untuk menemukan dan menghitung atribut yang diperlukan untuk terhubung ke sumber data.
SQLDisconnect	Menutup koneksi ke sumber data dan merilis sumber daya terkait.
SQLDataSources	Mengembalikan daftar sumber data yang tersedia. Dipanggil pada Driver Manager, bukan driver tertentu.
SQLDrivers	Mengembalikan daftar driver yang diinstal dan atributnya. Dipanggil pada Driver Manager.

Persiapan dan eksekusi pernyataan

Fungsi-fungsi ini menyiapkan dan menjalankan pernyataan SQL. ODBC mendukung eksekusi langsung dan eksekusi yang disiapkan, dengan eksekusi yang disiapkan menawarkan performa yang lebih baik untuk pernyataan yang dijalankan berulang kali.

Function	Description
SQLPrepare	Menyiapkan pernyataan SQL untuk eksekusi nanti. Sumber data mengkompilasi dan mengoptimalkan pernyataan.
SQLExecute	Menjalankan pernyataan yang disiapkan. Panggil `SQLPrepare` sebelum memanggil fungsi ini.
SQLExecDirect	Menyiapkan dan menjalankan pernyataan SQL dalam satu panggilan. Gunakan untuk pernyataan yang dijalankan hanya sekali.
SQLNativeSql	Mengembalikan string SQL seperti yang dimodifikasi oleh driver, memperlihatkan bagaimana driver menerjemahkan sintaks ODBC SQL.
SQLCancel	Membatalkan pemrosesan pada pernyataan. Dapat membatalkan fungsi eksekusi asinkron atau fungsi yang berjalan pada utas lain.
SQLCancelHandle	Membatalkan pemrosesan pada koneksi atau pernyataan. Lebih fleksibel daripada `SQLCancel` membatalkan fungsi koneksi.
SQLCompleteAsync	Menentukan kapan fungsi asinkron selesai. Digunakan dengan pemrosesan asinkron berbasis pemberitahuan.

Pengikatan parameter

Fungsi-fungsi ini mengikat variabel aplikasi ke penanda parameter dalam pernyataan SQL. Parameter mengaktifkan nilai dinamis dalam pernyataan yang disiapkan.

Function	Description
SQLBindParameter	Mengikat variabel aplikasi ke penanda parameter dalam pernyataan SQL. Mendukung parameter input, output, dan input/output.
SQLNumParams	Mengembalikan jumlah parameter dalam pernyataan SQL.
SQLDescribeParam	Mengembalikan deskripsi penanda parameter, termasuk jenis data, ukuran, dan presisi.
SQLParamData	Digunakan dengan `SQLPutData` untuk menyediakan data parameter pada waktu eksekusi. Mengembalikan parameter yang membutuhkan data.
SQLPutData	Mengirim sebagian atau semua nilai data untuk parameter pada waktu eksekusi. Mendukung data besar dalam gugus.
SQLSetParam	Mengikat parameter. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLBindParameter` sebagai gantinya.
SQLParamOptions	Mengatur opsi untuk array parameter. Tidak digunakan lagi di ODBC 3.x; gunakan atribut pernyataan sebagai gantinya.

Pengikatan dan pengambilan tataan hasil

Fungsi-fungsi ini mengikat buffer aplikasi ke kolom tataan hasil dan mengambil data dari hasil kueri.

Function	Description
SQLBindCol	Mengikat variabel aplikasi ke kolom kumpulan hasil untuk operasi pengambilan berikutnya.
SQLFetch	Mengambil kumpulan baris data berikutnya dari hasil yang diatur ke dalam kolom terikat.
SQLFetchScroll	Mengambil set baris yang ditentukan dari kumpulan hasil. Mendukung pengguliran ke posisi pertama, terakhir, berikutnya, sebelumnya, absolut, dan relatif.
SQLGetData	Mengambil data untuk satu kolom setelah `SQLFetch` atau `SQLFetchScroll`. Berguna untuk data besar atau kolom yang tidak terikat.
SQLExtendedFetch	Mengambil kumpulan baris data yang ditentukan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLFetchScroll` sebagai gantinya.
SQLMoreResults	Menentukan apakah lebih banyak hasil tersedia pada pernyataan dan melanjutkan ke tataan hasil berikutnya.
SQLRowCount	Mengembalikan jumlah baris yang dipengaruhi oleh pernyataan UPDATE, INSERT, atau DELETE.

Operasi kursor

Fungsi-fungsi ini mengelola perilaku kursor, penempatan, dan operasi massal pada set baris.

Function	Description
SQLSetPos	Mengatur posisi kursor dalam set baris dan memungkinkan aplikasi untuk menyegarkan, memperbarui, atau menghapus data pada posisi tersebut.
SQLBulkOperations	Melakukan operasi sisipkan, perbarui, hapus, atau ambil berdasarkan bookmark secara massal pada set baris.
SQLCloseCursor	Menutup kursor yang telah dibuka pada pernyataan dan membuang hasil yang tertunda.
SQLGetCursorName	Mengembalikan nama kursor yang terkait dengan pernyataan.
SQLSetCursorName	Menentukan nama kursor untuk pernyataan UPDATE dan DELETE yang diposisikan.
SQLSetScrollOptions	Mengatur opsi untuk perilaku kursor. Tidak digunakan lagi di ODBC 3.x; gunakan atribut pernyataan sebagai gantinya.

Fungsi katalog

Fungsi-fungsi ini mengambil metadata tentang struktur database, termasuk tabel, kolom, indeks, hak istimewa, dan prosedur tersimpan.

Function	Description
SQLTables	Mengembalikan daftar nama tabel di sumber data. Mendukung pemfilteran menurut katalog, skema, dan jenis tabel.
SQLColumns	Mengembalikan daftar nama kolom dan atributnya untuk tabel tertentu.
SQLPrimaryKeys	Mengembalikan kolom yang membentuk kunci utama untuk tabel.
SQLForeignKeys	Mengembalikan kunci asing dalam tabel atau kunci asing dalam tabel lain yang mereferensikan kunci primer tabel.
SQLStatistics	Mengembalikan statistik tentang tabel dan daftar indeks yang terkait dengannya.
SQLSpecialColumns	Mengembalikan kolom yang secara unik mengidentifikasi baris atau kolom yang diperbarui secara otomatis saat nilai apa pun dalam baris diperbarui.
SQLColumnPrivileges	Mengembalikan daftar kolom dan hak istimewa terkait untuk tabel.
SQLTablePrivileges	Mengembalikan daftar tabel dan hak istimewa yang terkait dengan setiap tabel.
SQLProcedures	Mengembalikan daftar nama prosedur tersimpan di sumber data.
SQLProcedureColumns	Mengembalikan daftar parameter input/output dan kolom dalam tataan hasil untuk prosedur yang ditentukan.
SQLGetTypeInfo	Mengembalikan informasi tentang jenis data yang didukung oleh sumber data.

Operasi deskriptor

Fungsi-fungsi ini mendapatkan dan mengatur nilai deskriptor. Deskriptor berisi metadata tentang parameter dan kolom tataan hasil.

Function	Description
SQLGetDescField	Mengembalikan nilai dari satu bidang rekaman deskriptor.
SQLGetDescRec	Mengembalikan beberapa bidang rekaman deskriptor dalam satu panggilan.
SQLSetDescField	Mengatur nilai satu bidang rekaman deskriptor.
SQLSetDescRec	Mengatur beberapa bidang catatan deskriptor dalam satu panggilan.
SQLCopyDesc	Menyalin informasi deskriptor dari satu handel deskriptor ke pendeskripsi lain.

Fungsi atribut

Fungsi-fungsi ini mendapatkan dan mengatur atribut untuk lingkungan, koneksi, dan pernyataan. Atribut mengontrol berbagai aspek perilaku ODBC.

Function	Description
SQLSetEnvAttr	Mengatur atribut lingkungan yang memengaruhi semua koneksi di bawah lingkungan tersebut.
SQLGetEnvAttr	Mengembalikan nilai atribut lingkungan.
SQLSetConnectAttr	Mengatur atribut koneksi yang memengaruhi koneksi dan pernyataan di dalamnya.
SQLGetConnectAttr	Mengembalikan nilai atribut koneksi.
SQLSetStmtAttr	Mengatur atribut pernyataan. Termasuk kursor, batas waktu kueri, dan pengaturan parameter.
SQLGetStmtAttr	Mengembalikan nilai atribut pernyataan.
SQLSetConnectOption	Mengatur opsi koneksi. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLSetConnectAttr` sebagai gantinya.
SQLGetConnectOption	Mengembalikan nilai opsi koneksi. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLGetConnectAttr` sebagai gantinya.
SQLSetStmtOption	Mengatur opsi pernyataan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLSetStmtAttr` sebagai gantinya.
SQLGetStmtOption	Mengembalikan nilai opsi pernyataan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLGetStmtAttr` sebagai gantinya.

Fungsi diagnostik dan informasi

Fungsi-fungsi ini mengambil informasi diagnostik, pesan kesalahan, kemampuan driver, dan informasi sumber data.

Function	Description
SQLGetDiagField	Mengembalikan nilai bidang dalam rekaman diagnostik yang berisi informasi kesalahan, peringatan, dan status.
SQLGetDiagRec	Mengembalikan beberapa bidang catatan diagnostik yang umum digunakan, termasuk SQLSTATE, kode kesalahan asli, dan teks pesan.
SQLError	Mengembalikan informasi kesalahan. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLGetDiagRec` sebagai gantinya.
SQLGetFunctions	Mengembalikan informasi tentang apakah driver mendukung fungsi ODBC tertentu.
SQLGetInfo	Mengembalikan informasi umum tentang driver dan sumber data, termasuk fitur dan kemampuan yang didukung.

Metadata tataan hasil

Fungsi-fungsi ini mengembalikan informasi tentang struktur tataan hasil.

Function	Description
SQLNumResultCols	Mengembalikan jumlah kolom dalam tataan hasil.
SQLDescribeCol	Mengembalikan nama kolom, jenis data, presisi, skala, dan nullability untuk kolom tataan hasil.
SQLColAttribute	Mengembalikan informasi deskriptor untuk kolom dalam tataan hasil. Lebih fleksibel daripada `SQLDescribeCol`.
SQLColAttributes	Mengembalikan atribut untuk kolom. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLColAttribute` sebagai gantinya.

Manajemen transaksi

Fungsi-fungsi ini mengelola batas transaksi, mengontrol kapan perubahan diterapkan atau digulung balik.

Function	Description
SQLEndTran	Menerapkan atau menggulung balik transaksi. Dapat berlaku untuk semua koneksi pada lingkungan atau satu koneksi.
SQLTransact	Menerapkan atau menggulung balik transaksi. Tidak digunakan lagi di ODBC 3.x; gunakan `SQLEndTran` sebagai gantinya.

Saran dan Komentar

Apakah halaman ini membantu?

Last updated on 2026-02-10