Fungsi SQLProcedures
Kesesuaian
Versi Diperkenalkan: Kepatuhan Standar ODBC 1.0: ODBC
Ringkasan
SQLProcedures mengembalikan daftar nama prosedur yang disimpan dalam sumber data tertentu. Prosedur adalah istilah generik yang digunakan untuk menjelaskan objek yang dapat dieksekusi, atau entitas bernama yang dapat dipanggil menggunakan parameter input dan output. Untuk informasi selengkapnya tentang prosedur, lihat Prosedur.
Sintaks
SQLRETURN SQLProcedures(
SQLHSTMT StatementHandle,
SQLCHAR * CatalogName,
SQLSMALLINT NameLength1,
SQLCHAR * SchemaName,
SQLSMALLINT NameLength2,
SQLCHAR * ProcName,
SQLSMALLINT NameLength3);
Argumen
StatementHandle
[Input] Handel pernyataan.
CatalogName
[Input] Katalog prosedur. Jika driver mendukung katalog untuk beberapa tabel tetapi tidak untuk yang lain, seperti ketika driver mengambil data dari DBMS yang berbeda, string kosong ("") menunjukkan tabel yang tidak memiliki katalog. CatalogName tidak boleh berisi pola pencarian string.
Jika atribut pernyataan SQL_ATTR_METADATA_ID diatur ke SQL_TRUE, CatalogName diperlakukan sebagai pengidentifikasi dan kasusnya tidak signifikan. Jika SQL_FALSE, CatalogName adalah argumen biasa; itu diperlakukan secara harfiah, dan kasusnya signifikan. Untuk informasi selengkapnya, lihat Argumen di Fungsi Katalog.
NameLength1
[Input] Panjang karakter *CatalogName.
SchemaName
[Input] Pola pencarian string untuk nama skema prosedur. Jika driver mendukung skema untuk beberapa prosedur tetapi tidak untuk yang lain, seperti ketika driver mengambil data dari DBMS yang berbeda, string kosong ("") menunjukkan prosedur yang tidak memiliki skema.
Jika atribut pernyataan SQL_ATTR_METADATA_ID diatur ke SQL_TRUE, SchemaName diperlakukan sebagai pengidentifikasi dan kasusnya tidak signifikan. Jika SQL_FALSE, SchemaName adalah argumen nilai pola; itu diperlakukan secara harfiah, dan kasusnya signifikan.
NameLength2
[Input] Panjang karakter *SchemaName.
ProcName
[Input] Pola pencarian string untuk nama prosedur.
Jika atribut pernyataan SQL_ATTR_METADATA_ID diatur ke SQL_TRUE, ProcName diperlakukan sebagai pengidentifikasi dan kasusnya tidak signifikan. Jika SQL_FALSE, ProcName adalah argumen nilai pola; itu diperlakukan secara harfiah, dan kasusnya signifikan.
NameLength3
[Input] Panjang karakter *ProcName.
Kembali
SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR, atau SQL_INVALID_HANDLE.
Diagnostik
Saat SQLProcedures mengembalikan SQL_ERROR atau SQL_SUCCESS_WITH_INFO, nilai SQLSTATE terkait dapat diperoleh dengan memanggil SQLGetDiagRec dengan HandleType SQL_HANDLE_STMT dan Handle of StatementHandle. Tabel berikut mencantumkan nilai SQLSTATE yang umumnya dikembalikan oleh SQLProcedures dan menjelaskan masing-masing dalam konteks fungsi ini; notasi "(DM)" mendahului deskripsi SQLSTATEs yang dikembalikan oleh Driver Manager. Kode pengembalian yang terkait dengan setiap nilai SQLSTATE SQL_ERROR, kecuali disebutkan sebaliknya.
| SQLSTATE | Kesalahan | Deskripsi |
|---|---|---|
| 01000 | Peringatan umum | Pesan informasi khusus driver. (Fungsi mengembalikan SQL_SUCCESS_WITH_INFO.) |
| 08S01 | Kegagalan tautan komunikasi | Tautan komunikasi antara driver dan sumber data tempat driver tersambung gagal sebelum fungsi selesai diproses. |
| 24000 | Status kursor tidak valid | Kursor terbuka pada StatementHandle, dan SQLFetch atau SQLFetchScroll telah dipanggil. Kesalahan ini dikembalikan oleh Driver Manager jika SQLFetch atau SQLFetchScroll belum mengembalikan SQL_NO_DATA, dan dikembalikan oleh driver jika SQLFetch atau SQLFetchScroll telah mengembalikan SQL_NO_DATA. Kursor terbuka pada StatementHandle, tetapi SQLFetch atau SQLFetchScroll belum dipanggil. |
| 40001 | Kegagalan serialisasi | Transaksi digulung balik karena kebuntuan sumber daya dengan transaksi lain. |
| 40003 | Penyelesaian pernyataan tidak diketahui | Koneksi terkait gagal selama eksekusi fungsi ini, dan status transaksi tidak dapat ditentukan. |
| HY000 | Kesalahan umum | Terjadi kesalahan yang tidak ada SQLSTATE tertentu dan tidak ada SQLSTATE khusus implementasi yang ditentukan. Pesan kesalahan yang dikembalikan oleh SQLGetDiagRec di buffer *MessageText menjelaskan kesalahan dan penyebabnya. |
| HY001 | Kesalahan alokasi memori | Driver tidak dapat mengalokasikan memori yang diperlukan untuk mendukung eksekusi atau penyelesaian fungsi. |
| HY008 | Operasi dibatalkan | Pemrosesan asinkron diaktifkan untuk StatementHandle. Fungsi ini dipanggil, dan sebelum selesai dieksekusi, SQLCancel atau SQLCancelHandle dipanggil pada StatementHandle. Kemudian fungsi dipanggil lagi pada StatementHandle. Fungsi ini dipanggil, dan sebelum selesai dieksekusi, SQLCancel atau SQLCancelHandle dipanggil pada StatementHandle dari utas yang berbeda dalam aplikasi multithread. |
| HY009 | Penggunaan pointer null tidak valid | Atribut pernyataan SQL_ATTR_METADATA_ID diatur ke SQL_TRUE, argumen CatalogName adalah pointer null, dan infoType SQL_CATALOG_NAME mengembalikan bahwa nama katalog didukung. (DM) Atribut pernyataan SQL_ATTR_METADATA_ID diatur ke SQL_TRUE, dan argumen SchemaName atau ProcName adalah pointer null. |
| HY010 | Kesalahan urutan fungsi | (DM) Fungsi eksekusi asinkron dipanggil untuk handel koneksi yang terkait dengan StatementHandle. Fungsi asinkron ini masih dijalankan ketika fungsi ini dipanggil. (DM) SQLExecute, SQLExecDirect, atau SQLMoreResults dipanggil untuk StatementHandle dan dikembalikan SQL_PARAM_DATA_AVAILABLE. Fungsi ini dipanggil sebelum data diambil untuk semua parameter yang dialirkan. (DM) Fungsi eksekusi asinkron (bukan yang ini) dipanggil untuk StatementHandle dan masih dijalankan ketika fungsi ini dipanggil. (DM) SQLExecute, SQLExecDirect, SQLBulkOperations, atau SQLSetPos dipanggil untuk StatementHandle dan dikembalikan SQL_NEED_DATA. Fungsi ini dipanggil sebelum data dikirim untuk semua parameter atau kolom data-at-execution. |
| HY013 | Kesalahan manajemen memori | Panggilan fungsi tidak dapat diproses karena objek memori yang mendasar tidak dapat diakses, mungkin karena kondisi memori yang rendah. |
| HY090 | String atau panjang buffer tidak valid | (DM) Nilai salah satu argumen panjang nama kurang dari 0 tetapi tidak sama dengan SQL_NTS. Nilai salah satu argumen panjang nama melebihi nilai panjang maksimum untuk nama yang sesuai. |
| HY117 | Koneksi ditangguhkan karena status transaksi yang tidak diketahui. Hanya fungsi putuskan sambungan dan baca-saja yang diizinkan. | (DM) Untuk informasi selengkapnya tentang status ditangguhkan, lihat Fungsi SQLEndTran. |
| HYC00 | Fitur opsional tidak diimplementasikan | Katalog prosedur ditentukan, dan driver atau sumber data tidak mendukung katalog. Skema prosedur ditentukan, dan driver atau sumber data tidak mendukung skema. Pola pencarian string ditentukan untuk skema prosedur atau nama prosedur, dan sumber data tidak mendukung pola pencarian untuk satu atau beberapa argumen tersebut. Kombinasi pengaturan saat ini dari atribut pernyataan SQL_ATTR_CONCURRENCY dan SQL_ATTR_CURSOR_TYPE tidak didukung oleh driver atau sumber data. Atribut pernyataan SQL_ATTR_USE_BOOKMARKS diatur ke SQL_UB_VARIABLE, dan atribut pernyataan SQL_ATTR_CURSOR_TYPE diatur ke jenis kursor yang drivernya tidak mendukung marka buku. |
| HYT00 | Waktu habis kedaluwarsa | Periode batas waktu kueri kedaluwarsa sebelum sumber data mengembalikan kumpulan hasil yang diminta. Periode batas waktu diatur melalui SQLSetStmtAttr, SQL_ATTR_QUERY_TIMEOUT. |
| HYT01 | Kesalahan waktu habis koneksi kedaluwarsa | Periode batas waktu koneksi kedaluwarsa sebelum sumber data merespons permintaan. Periode batas waktu koneksi diatur melalui SQLSetConnectAttr, SQL_ATTR_CONNECTION_TIMEOUT. |
| IM001 | Driver tidak mendukung fungsi ini | (DM) Driver yang terkait dengan StatementHandle tidak mendukung fungsi ini. |
| IM017 | Polling dinonaktifkan dalam mode pemberitahuan asinkron | Setiap kali model pemberitahuan digunakan, polling dinonaktifkan. |
| IM018 | SQLCompleteAsync belum dipanggil untuk menyelesaikan operasi asinkron sebelumnya pada handel ini. | Jika panggilan fungsi sebelumnya pada handel mengembalikan SQL_STILL_EXECUTING dan jika mode pemberitahuan diaktifkan, SQLCompleteAsync harus dipanggil pada handel untuk melakukan pasca-pemrosesan dan menyelesaikan operasi. |
Komentar
SQLProcedures mencantumkan semua prosedur dalam rentang yang diminta. Pengguna mungkin atau mungkin tidak memiliki izin untuk menjalankan salah satu prosedur ini. Untuk memeriksa aksesibilitas, aplikasi dapat memanggil SQLGetInfo dan memeriksa nilai informasi SQL_ACCESSIBLE_PROCEDURES. Jika tidak, aplikasi harus dapat menangani situasi di mana pengguna memilih prosedur yang tidak dapat dijalankannya. Untuk informasi tentang bagaimana informasi ini dapat digunakan, lihat Prosedur.
Catatan
Untuk informasi selengkapnya tentang penggunaan umum, argumen, dan data fungsi katalog ODBC yang dikembalikan, lihat Fungsi Katalog.
SQLProcedures mengembalikan hasil sebagai hasil standar yang ditetapkan, diurutkan berdasarkan PROCEDURE_CAT, PROCEDURE_SCHEMA, dan PROCEDURE_NAME.
Catatan
SQLProcedures mungkin tidak mengembalikan semua prosedur. Aplikasi dapat menggunakan prosedur yang valid, terlepas dari apakah itu dikembalikan oleh SQLProcedures.
Kolom berikut telah diganti namanya menjadi ODBC 3*.x*. Perubahan nama kolom tidak memengaruhi kompatibilitas mundur karena aplikasi mengikat dengan nomor kolom.
| Kolom ODBC 2.0 | Kolom ODBC 3*.x* |
|---|---|
| PROCEDURE_QUALIFIER | PROCEDURE_CAT |
| _OWNER PROSEDUR | _SCHEM PROSEDUR |
Untuk menentukan panjang aktual kolom PROCEDURE_CAT, PROCEDURE_SCHEM, dan PROCEDURE_NAME, aplikasi dapat memanggil SQLGetInfo dengan opsi SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, dan SQL_MAX_PROCEDURE_NAME_LEN.
Tabel berikut mencantumkan kolom dalam tataan hasil. Kolom tambahan di luar kolom 8 (PROCEDURE_TYPE) dapat ditentukan oleh driver. Aplikasi harus mendapatkan akses ke kolom khusus driver dengan menghitung mundur dari akhir tataan hasil daripada menentukan posisi ordinal eksplisit. Untuk informasi selengkapnya, lihat Data yang Dikembalikan oleh Fungsi Katalog.
| Nama kolom | Nomor kolom | Jenis Data | Komentar |
|---|---|---|---|
| PROCEDURE_CAT (ODBC 2.0) | 1 | Varchar | Pengidentifikasi katalog prosedur; NULL jika tidak berlaku untuk sumber data. Jika driver mendukung katalog untuk beberapa prosedur tetapi tidak untuk yang lain, seperti ketika driver mengambil data dari DBMS yang berbeda, driver mengembalikan string kosong ("") untuk prosedur yang tidak memiliki katalog. |
| PROCEDURE_SCHEM (ODBC 2.0) | 2 | Varchar | Pengidentifikasi skema prosedur; NULL jika tidak berlaku untuk sumber data. Jika driver mendukung skema untuk beberapa prosedur tetapi tidak untuk yang lain, seperti ketika driver mengambil data dari DBMS yang berbeda, driver mengembalikan string kosong ("") untuk prosedur yang tidak memiliki skema. |
| PROCEDURE_NAME (ODBC 2.0) | 3 | Varchar bukan NULL | Pengidentifikasi prosedur. |
| NUM_INPUT_PARAMS (ODBC 2.0) | 4 | T/A | Disiapkan untuk penggunaan masa mendatang. Aplikasi tidak boleh mengandalkan data yang dikembalikan dalam kolom hasil ini. |
| NUM_OUTPUT_PARAMS (ODBC 2.0) | 5 | T/A | Disiapkan untuk penggunaan masa mendatang. Aplikasi tidak boleh mengandalkan data yang dikembalikan dalam kolom hasil ini. |
| NUM_RESULT_SETS (ODBC 2.0) | 6 | T/A | Disiapkan untuk penggunaan masa mendatang. Aplikasi tidak boleh mengandalkan data yang dikembalikan dalam kolom hasil ini. |
| KETERANGAN (ODBC 2.0) | 7 | Varchar | Deskripsi prosedur. |
| PROCEDURE_TYPE (ODBC 2.0) | 8 | Smallint | Menentukan jenis prosedur: SQL_PT_UNKNOWN: Tidak dapat ditentukan apakah prosedur mengembalikan nilai. SQL_PT_PROCEDURE: Objek yang dikembalikan adalah prosedur; artinya, tidak memiliki nilai pengembalian. SQL_PT_FUNCTION: Objek yang dikembalikan adalah fungsi; artinya, ia memiliki nilai pengembalian. |
Argumen SchemaName dan ProcName menerima pola pencarian. Untuk informasi selengkapnya tentang pola pencarian yang valid, lihat Argumen Nilai Pola.
Contoh Kode
Lihat Panggilan Prosedur.
Fungsi Terkait
| Untuk informasi tentang | Lihat |
|---|---|
| Mengikat buffer ke kolom dalam tataan hasil | Fungsi SQLBindCol |
| Membatalkan pemrosesan pernyataan | Fungsi SQLCancel |
| Mengambil satu baris atau blok data dalam arah terusan saja | Fungsi SQLFetch |
| Mengambil blok data atau menggulir melalui kumpulan hasil | Fungsi SQLFetchScroll |
| Mengembalikan informasi tentang driver atau sumber data | Fungsi SQLGetInfo |
| Mengembalikan parameter dan kolom tataan hasil prosedur | Fungsi SQLProcedureColumns |
| Sintaks untuk memanggil prosedur tersimpan | Pernyataan Eksekusi |
Lihat Juga
Saran dan Komentar
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat: https://aka.ms/ContentUserFeedback.
Kirim dan lihat umpan balik untuk