Aracılığıyla paylaş

ODBC API başvurusu

Şunlar için geçerlidir:SQL ServerAzure SQL VeritabanıAzure SQL Yönetilen Örneği

ODBC API'sinde veri kaynaklarına bağlanmak, SQL deyimlerini yürütmek ve sonuçları almak için standart bir işlev kümesi sağlanır. Her işlev amaç, ODBC sürümü, söz dizimi, bağımsız değişkenler, dönüş değerleri, tanılamalar ve kod örnekleri içeren açıklamalara sahip bir C programlama dili işlevidir.

Standart CLI uyumluluk düzeyi şunlardan biri olabilir: ISO 92, Açık Grup, ODBC veya Kullanım Dışı. Open Group, ISO 92'nin saf üst kümesi olduğundan, ISO 92 uyumlu olarak etiketlenen bir işlev Open Group sürüm 1'de de görünür. ODBC 3.x, Açık Grup sürüm 1'in saf üst kümesi olduğundan, Açık Grup uyumlu olarak etiketlenmiş bir işlev ODBC 3.x'te de görünür. ODBC uyumlu olarak etiketlenen bir işlev iki standartta da görünmez. Kullanım dışı olarak etiketlenen bir işlev ODBC 3.x'te kullanım dışı bırakıldı.

SQLGetDiagField işlev açıklaması, tanılama bilgilerinin nasıl işleneceğini açıklar. SQLSTATE değerleriyle ilişkili metin, koşulun açıklamasını sağlar ancak belirli bir metin yazmaz.

Uyarı

ODBC işlevleri hakkında sürücüye özgü bilgiler için sürücünün bölümüne bakın.

Ayırma ve yönetimi işleme

Bu işlevler ortamlar, bağlantılar, deyimler ve tanımlayıcılar için tanıtıcılar ayırır ve serbesttir. Tanıtıcılar, ODBC uygulamalarında durumu izlemeye yönelik birincil mekanizmadır.

İşlev Description
Sqlallochandle Ortam, bağlantı, deyim veya tanımlayıcı tanıtıcısı ayırır. Bu, kullanım dışı bırakılan ayırma işlevlerinin yerini alan ODBC 3.x işlevidir.
Sqlfreehandle Bir ortamı, bağlantıyı, deyimi veya tanımlayıcı tanıtıcıyı serbest bırakır ve ilişkili kaynakları serbest bırakır.
SQLAllocConnect Bir bağlantı tanıtıcısı ayırır. ODBC 3.x'te kullanım dışı; yerine kullanın SQLAllocHandle .
SQLAllocEnv Bir ortam tanıtıcısı ayırır. ODBC 3.x'te kullanım dışı; yerine kullanın SQLAllocHandle .
SQLAllocStmt Bir deyim tanıtıcısı ayırır. ODBC 3.x'te kullanım dışı; yerine kullanın SQLAllocHandle .
SQLFreeConnect Bağlantı tutamacını serbesttir. ODBC 3.x'te kullanım dışı; yerine kullanın SQLFreeHandle .
SQLFreeEnv Ortam tutamacını serbestleştirir. ODBC 3.x'te kullanım dışı; yerine kullanın SQLFreeHandle .
Sqlfreestmt Deyim işlemeyi durdurur, ilişkili imleçleri kapatır, bekleyen sonuçları atar ve isteğe bağlı olarak bir deyim tanıtıcısıyla ilişkili kaynakları serbest bırakır.

Bağlantı işlevleri

Bu işlevler, veri kaynaklarına yönelik bağlantılar kurar ve yönetir. Standart bağlantılar, sürücüye özgü iletişim kutuları ve yinelemeli göz atma gibi çeşitli bağlantı yöntemlerini destekler.

İşlev Description
Sqlconnect Veri kaynağı adı, kullanıcı kimliği ve parola kullanarak bir veri kaynağına bağlantı kurar.
Sqldriverconnect Bağlantı dizesi kullanarak bağlantı kurar. Ek bağlantı bilgileri için sürücüye özgü iletişim kutularını destekler.
Sqlbrowseconnect Bir veri kaynağına bağlanmak için gereken öznitelikleri bulmak ve numaralandırmak için yinelemeli bir yöntemi destekler.
SQLDisconnect Bir veri kaynağına bağlantıyı kapatır ve ilişkili kaynakları serbest bırakır.
SQLDataSources Kullanılabilir veri kaynaklarının listesini döndürür. Belirli bir sürücüde değil, Sürücü Yöneticisi'ne çağrılır.
SQLDrivers Yüklü sürücülerin ve özniteliklerinin listesini döndürür. Sürücü Yöneticisi'ne çağrıldı.

Deyim hazırlama ve yürütme

Bu işlevler SQL deyimlerini hazırlar ve yürütür. ODBC, hem doğrudan yürütmeyi hem de hazırlanmış yürütmeyi destekler ve sürekli yürütülen deyimler için daha iyi performans sunan hazırlanmış yürütmeyi destekler.

İşlev Description
Sqlprepare Sql deyimini daha sonra yürütülmeye hazırlar. Veri kaynağı deyimini derler ve iyileştirir.
Sqlexecute Hazırlanmış bir deyimi yürütür. Bu işlevi çağırmadan önce çağır SQLPrepare .
Sqlexecdirect Bir SQL deyimini tek bir çağrıda hazırlar ve yürütür. Yalnızca bir kez yürütülen deyimler için kullanın.
SQLNativeSql Sürücünün ODBC SQL söz dizimini nasıl çevirdiği gösteren SQL dizesini sürücü tarafından değiştirildiği şekilde döndürür.
SQLCancel Bir deyim üzerinde işlemeyi iptal eder. Zaman uyumsuz olarak yürütülen bir işlevi veya başka bir iş parçacığında çalışan bir işlevi iptal edebilir.
SQLCancelHandle Bir bağlantı veya deyim üzerinde işlemeyi iptal eder. Bağlantı işlevlerini iptal etmekten daha SQLCancel esnektir.
SQLCompleteAsync Zaman uyumsuz bir işlevin ne zaman tamamleneceğini belirler. Bildirim tabanlı zaman uyumsuz işleme ile kullanılır.

Parametre bağlama

Bu işlevler, uygulama değişkenlerini SQL deyimlerindeki parametre işaretçilerine bağlar. Parametreler, hazırlanan deyimlerde dinamik değerleri etkinleştirir.

İşlev Description
Sqlbindparameter Uygulama değişkenlerini SQL deyimindeki parametre işaretçisine bağlar. Giriş, çıkış ve giriş/çıkış parametrelerini destekler.
SQLNumParams SQL deyimindeki parametre sayısını döndürür.
Sqldescribeparam Veri türü, boyut ve duyarlık gibi parametre işaretçisinin açıklamasını döndürür.
Sqlparamdata yürütme zamanında parametre verilerini sağlamak için ile kullanılır SQLPutData . Verilere ihtiyaç duyan parametreyi döndürür.
Sqlputdata Yürütme zamanında bir parametre için veri değerinin bir bölümünü veya tamamını gönderir. Öbekler halinde büyük verileri destekler.
SQLSetParam Bir parametre bağlar. ODBC 3.x'te kullanım dışı; yerine kullanın SQLBindParameter .
SQLParamOptions Parametre dizileri için seçenekleri ayarlar. ODBC 3.x'te kullanım dışı; bunun yerine deyimi özniteliklerini kullanın.

Sonuç kümesi bağlama ve alma

Bu işlevler uygulama arabelleklerini sonuç kümesi sütunlarına bağlar ve sorgu sonuçlarından veri alır.

İşlev Description
Sqlbindcol Sonraki getirme işlemleri için bir uygulama değişkenini sonuç kümesi sütununa bağlar.
Sqlfetch Sonuç kümesinden sonraki veri satır kümesini ilişkili sütunlara getirir.
Sqlfetchscroll Belirtilen satır kümesini bir sonuç kümesinden getirir. İlk, son, sonraki, önceki, mutlak ve göreli konumlara kaydırmayı destekler.
Sqlgetdata veya SQLFetchScrollsonrasındaki SQLFetch tek bir sütunun verilerini alır. Büyük veriler veya ilişkisiz sütunlar için kullanışlıdır.
SQLExtendedFetch Belirtilen veri satır kümesini getirir. ODBC 3.x'te kullanım dışı; yerine kullanın SQLFetchScroll .
Sqlmoreresults Bir deyimde daha fazla sonuç bulunup bulunmadığını belirler ve sonraki sonuç kümesine ilerler.
Sqlrowcount UPDATE, INSERT veya DELETE deyiminden etkilenen satır sayısını döndürür.

İmleç işlemleri

Bu işlevler satır kümelerinde imleç davranışını, konumlandırmayı ve toplu işlemleri yönetir.

İşlev Description
Sqlsetpos bir satır kümesi içinde imleç konumunu ayarlar ve uygulamaların bu konumdaki verileri yenilemesine, güncelleştirmesine veya silmesine izin verir.
Sqlbulkoperations Satır kümelerinde toplu ekleme, güncelleştirme, silme veya yer işareti getirme işlemleri gerçekleştirir.
SQLCloseCursor Bir deyimde açılmış olan bir imleci kapatır ve bekleyen sonuçları atar.
Sqlgetcursorname Bir deyimle ilişkilendirilmiş imleç adını döndürür.
SQLSetCursorName Konumlandırılmış UPDATE ve DELETE deyimleri için bir imleç adı belirtir.
SQLSetScrollOptions İmleç davranışı seçeneklerini ayarlar. ODBC 3.x'te kullanım dışı; bunun yerine deyimi özniteliklerini kullanın.

Katalog işlevleri

Bu işlevler tablolar, sütunlar, dizinler, ayrıcalıklar ve saklı yordamlar dahil olmak üzere veritabanı yapısıyla ilgili meta verileri alır.

İşlev Description
Sqltables Veri kaynağındaki tablo adlarının listesini döndürür. Katalog, şema ve tablo türüne göre filtrelemeyi destekler.
Sqlcolumns Belirtilen tablolar için sütun adlarının ve özniteliklerinin listesini döndürür.
Sqlprimarykeys Bir tablonun birincil anahtarını oluşturan sütunları döndürür.
SQLForeignKeys Bir tablodaki yabancı anahtarları veya tablonun birincil anahtarına başvuran diğer tablolardaki yabancı anahtarları döndürür.
SQLStatistics Tablo hakkındaki istatistikleri ve tabloyla ilişkili dizinlerin listesini döndürür.
Sqlspecialcolumns Satırdaki herhangi bir değer güncelleştirildiğinde otomatik olarak güncelleştirilen bir satırı veya sütunları benzersiz olarak tanımlayan sütunları döndürür.
Sqlcolumnprivileges Bir tablo için sütunların ve ilişkili ayrıcalıkların listesini döndürür.
SQLTablePrivileges Tabloların listesini ve her tabloyla ilişkili ayrıcalıkları döndürür.
Sqlprocedures Veri kaynağındaki saklı yordam adlarının listesini döndürür.
Sqlprocedurecolumns Belirtilen yordamlar için sonuç kümesindeki giriş/çıkış parametrelerinin ve sütunlarının listesini döndürür.
SQLGetTypeInfo Veri kaynağı tarafından desteklenen veri türleri hakkında bilgi döndürür.

Tanımlayıcı işlemleri

Bu işlevler tanımlayıcı değerlerini alır ve ayarlar. Tanımlayıcılar parametreler ve sonuç kümesi sütunları hakkında meta veriler içerir.

İşlev Description
Sqlgetdescfield Tanımlayıcı kaydının tek bir alanının değerini döndürür.
SQLGetDescRec Tek bir çağrıda tanımlayıcı kaydının birden çok alanını döndürür.
SQLSetDescField Tanımlayıcı kaydının tek bir alanının değerini ayarlar.
Sqlsetdescrec Bir tanımlayıcı kaydının birden çok alanını tek bir çağrıda ayarlar.
SQLCopyDesc Tanımlayıcı bilgilerini bir tanımlayıcı tutamacından diğerine kopyalar.

Öznitelik işlevleri

Bu işlevler ortamlar, bağlantılar ve deyimler için öznitelikleri alır ve ayarlar. Öznitelikler ODBC davranışının çeşitli yönlerini denetler.

İşlev Description
SQLSetEnvAttr Bu ortam altındaki tüm bağlantıları etkileyen bir ortam özniteliği ayarlar.
SQLGetEnvAttr Ortam özniteliğinin değerini döndürür.
SQLSetConnectAttr Bağlantıyı ve üzerindeki deyimleri etkileyen bir bağlantı özniteliği ayarlar.
Sqlgetconnectattr Bağlantı özniteliğinin değerini döndürür.
SQLSetStmtAttr Deyim özniteliğini ayarlar. İmleç, sorgu zaman aşımı ve parametre ayarlarını içerir.
SQLGetStmtAttr Deyim özniteliğinin değerini döndürür.
SQLSetConnectOption Bir bağlantı seçeneği ayarlar. ODBC 3.x'te kullanım dışı; yerine kullanın SQLSetConnectAttr .
SQLGetConnectOption Bağlantı seçeneğinin değerini döndürür. ODBC 3.x'te kullanım dışı; yerine kullanın SQLGetConnectAttr .
SQLSetStmtOption Bir deyim seçeneği ayarlar. ODBC 3.x'te kullanım dışı; yerine kullanın SQLSetStmtAttr .
SQLGetStmtOption Bir deyim seçeneğinin değerini döndürür. ODBC 3.x'te kullanım dışı; yerine kullanın SQLGetStmtAttr .

Tanılama ve bilgi işlevleri

Bu işlevler tanılama bilgilerini, hata iletilerini, sürücü özelliklerini ve veri kaynağı bilgilerini alır.

İşlev Description
Sqlgetdiagfield Hata, uyarı ve durum bilgilerini içeren bir tanılama kaydındaki alanın değerini döndürür.
Sqlgetdiagrec SQLSTATE, yerel hata kodu ve ileti metni gibi tanılama kaydının yaygın olarak kullanılan birkaç alanını döndürür.
Sqlerror Hata bilgilerini döndürür. ODBC 3.x'te kullanım dışı; yerine kullanın SQLGetDiagRec .
SQLGetFunctions Sürücünün belirli bir ODBC işlevini destekleyip desteklemediği hakkında bilgi döndürür.
Sqlgetınfo Desteklenen özellikler ve özellikler de dahil olmak üzere sürücü ve veri kaynağı hakkındaki genel bilgileri döndürür.

Sonuç kümesi meta verileri

Bu işlevler sonuç kümelerinin yapısı hakkında bilgi döndürür.

İşlev Description
Sqlnumresultcols Sonuç kümesindeki sütun sayısını döndürür.
Sqldescribecol Sonuç kümesi sütunu için sütun adını, veri türünü, duyarlığı, ölçeği ve null atanabilirliği döndürür.
Sqlcolattribute Sonuç kümesindeki bir sütun için tanımlayıcı bilgilerini döndürür. 'den daha SQLDescribeColesnek.
SQLColAttributes Bir sütunun özniteliklerini döndürür. ODBC 3.x'te kullanım dışı; yerine kullanın SQLColAttribute .

İşlem yönetimi

Bu işlevler işlem sınırlarını yönetir ve değişikliklerin ne zaman işlendiğini veya geri alınıp alınıp alınmaması denetlenebilir.

İşlev Description
Sqlendtran bir işlemi işler veya geri alır. Bir ortamdaki veya tek bir bağlantıdaki tüm bağlantılara uygulanabilir.
SQLTransact bir işlemi işler veya geri alır. ODBC 3.x'te kullanım dışı; yerine kullanın SQLEndTran .

İlgili içerik

  • Last updated on