SQLTables İşlevi

Uygunluk
Tanıtılan Sürüm: ODBC 1.0 Standartlar Uyumu: Open Group

Özet
SQLTables , belirli bir veri kaynağında depolanan tablo, katalog veya şema isimleri ve tablo türlerinin listesini döndürür. Sürücü bilgileri sonuç kümesi olarak döndürür.

Syntax

  
SQLRETURN SQLTables(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      CatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      SchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      TableName,  
     SQLSMALLINT    NameLength3,  
     SQLCHAR *      TableType,  
     SQLSMALLINT    NameLength4);  

Arguments

StatementHandle
[Giriş] Alınan sonuçlar için ifade kullanıcı adı.

Catalogname
[Giriş] Katalog adı. KatalogName argümanı, SQL_ODBC_VERSION ortam özteniteliği SQL_OV_ODBC3 ise arama desenlerini kabul eder; SQL_OV_ODBC2 ayarlanmışsa arama desenlerini kabul etmez. Bir sürücü bazı tablolar için katalogları desteklerken diğerleri için desteklemiyorsa, örneğin sürücü farklı DBMS'lerden veri alırsa, katalogları olmayan tabloları boş bir dizi ("") gösterir.

Eğer SQL_ATTR_METADATA_ID ifadesi özniteliği SQL_TRUE olarak ayarlanmışsa, CatalogName tanımlayıcı olarak ele alınır ve durumu anlamlı değildir. Eğer SQL_FALSE ise, CatalogName bir desen değeri argümanıdır; kelime kelimesi kelimesine ele alınır ve durumu önemlidir. Daha fazla bilgi için bkz. Katalog İşlevleri'ndeki Bağımsız Değişkenler.

NameLength1
[Giriş] *CatalogName'nin karakterlerindeki uzunluk.

Şema Adı
[Giriş] Şema adları için dizi arama örünü. Bir sürücü bazı tablolar için şemaları desteklerken diğerleri için desteklemiyorsa, örneğin sürücü farklı DBMS'lerden veri alırsa, boş bir dizi ("") şemasız tabloları gösterir.

SQL_ATTR_METADATA_ID ifadesi özniteliği SQL_TRUE olarak ayarlanmışsa, SchemaName tanımlayıcı olarak kabul edilir ve durumu anlamlı değildir. Eğer SQL_FALSE ise, SchemaName bir desen değeri argümanıdır; kelime kelimesi kelimesine ele alınır ve durumu önemlidir.

NameLength2
[Giriş] *SchemaName'nin karakterlerindeki uzunluk.

Tablo Adı
[Giriş] Tablo adları için dizi arama deseni.

Eğer SQL_ATTR_METADATA_ID ifadesi özniteliği SQL_TRUE olarak ayarlanmışsa, TableName tanımlayıcı olarak ele alınır ve durumu anlamlı değildir. Eğer SQL_FALSE ise, TableName bir desen değeri argümanıdır; kelime kelimesi kelimesine ele alınır ve durumu önemlidir.

NameLength3
[Giriş] *TableName'in karakterlerindeki uzunluk.

Tablo Türü
[Giriş] Eşleşecek tablo türlerinin listesi.

SQL_ATTR_METADATA_ID ifadesi özniteliğinin TableType argümanı üzerinde hiçbir etkisi olmadığını unutmayın. TableType , SQL_ATTR_METADATA_ID ayarı ne olursa olsun bir değer listesi argümanıdır.

NameLength4
[Giriş] *TableType karakterlerindeki uzunluk.

İadeler

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR ya da SQL_INVALID_HANDLE.

Diagnostics

SQLTables SQL_ERROR veya SQL_SUCCESS_WITH_INFO döndürdüğünde, ilişkili bir SQLSTATE değeri, SQL_HANDLE_STMT HandleType ve HandleType of StatementHandle ile SQLGetDiagRec çağrılarak elde edilebilir. Aşağıdaki tablo, genellikle SQLTables tarafından duygulanan SQLSTATE değerlerini listeler ve her birini bu fonksiyonun bağlamında açıklar; "(DM)" gösterimi, Sürücü Yöneticisi tarafından döndürülen SQLSTATE açıklamalarından önce gelir. Aksi belirtilmediği sürece, her SQLSTATE değeriyle ilişkili dönüş kodu SQL_ERROR.

Comments

SQLTables, istenen aralıktaki tüm tabloları listeler. Bir kullanıcı, bu tablolardan herhangi birine SEÇ ayrıcalığına sahip olabilir veya olmayabilir. Erişilebilirliği kontrol etmek için bir uygulama şunları yapabilir:

• SQLGetInfo'yu arayın ve SQL_ACCESSIBLE_TABLES bilgi tipini kontrol edin.

• Her tablonun ayrıcalıklarını kontrol etmek için SQLTablePrivileges'i çağırın.

Aksi takdirde, uygulama, kullanıcının SELECT ayrıcalıklarının verilmediği bir tabloyu seçtiği bir durumu yönetebilmelidir.

SchemaName ve TableName argümanları arama desenlerini kabul eder. KatalogName argümanı, SQL_ODBC_VERSION ortam özteniteliği SQL_OV_ODBC3 ise arama desenlerini kabul eder; SQL_OV_ODBC2 ayarlanmışsa arama desenlerini kabul etmez. Eğer SQL_OV_ODBC3 ayarlanmışsa, bir ODBC 3*.x* sürücüsü, CatalogName argümanındaki joker karakterlerin kelimesi kelimesine muamele alınması için kaçış yapmasını gerektirir. Geçerli arama desenleri hakkında daha fazla bilgi için Pattern Value Argümanları'na bakınız.

Kataloglar, şemalar ve tablo türlerinin sayımı desteklemek için, SQLTables'ınCatalogName, SchemaName, TableName ve TableType argümanları için aşağıdaki özel anlamanlamlar tanımlanmıştır:

• Eğer CatalogName SQL_ALL_CATALOGS ve SchemaName ile TableName boş dizilerleyse, sonuç kümesi veri kaynağı için geçerli katalogların bir listesini içerir. (TABLE_CAT sütunu hariç tüm sütunlarda NULL bulunur.)

• Eğer SchemaName SQL_ALL_SCHEMAS ve CatalogName ile TableName boş dizilerleyse, sonuç kümesi veri kaynağı için geçerli şemaların bir listesini içerir. (TABLE_SCHEM sütunu hariç tüm sütunlarda NULL bulunur.)

• Eğer TableType SQL_ALL_TABLE_TYPES ise ve CatalogName,SchemaName ve TableName boş dizilerleyse, sonuç kümesi veri kaynağı için geçerli tablo türlerinin bir listesini içerir. (TABLE_TYPE sütun hariç tüm sütunlarda NULL bulunur.)

TableType boş bir dizi değilse, ilgi çeken türler için virgülle ayrılmış değerler listesini içermelidir; her değer tek tırnak işareti (') içinde veya tırnak işareti olmadan eklenebilir, örneğin 'TABLE', 'VIEW' veya TABLE, VIEW. Bir uygulama her zaman tablo tipini büyük harflerle belirtmelidir; sürücü, tablo tipini veri kaynağı tarafından ihtiyaç duyulan duruma dönüştürmelidir. Veri kaynağı belirli bir tablo türünü desteklemiyorsa, SQLTables o tür için herhangi bir sonuç getirmez.

SQLTables , sonuçları standart bir sonuç seti olarak, TABLE_TYPE, TABLE_CAT, TABLE_SCHEM ve TABLE_NAME sıralarına göre döndürür. Bu bilgilerin nasıl kullanılabileceğini öğrenmek için bkz. Katalog Verilerinin Kullanımları.

TABLE_CAT, TABLE_SCHEM ve TABLE_NAME sütunlarının gerçek uzunluklarını belirlemek için bir uygulama, SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN ve SQL_MAX_TABLE_NAME_LEN bilgi tipleriyle SQLGetInfo'yu çağırabilir.

Aşağıdaki sütunlar ODBC 3*.x* için yeniden adlandırılmıştır. Sütun adı değişiklikleri, uygulamalar sütun numarasına göre bağlandığı için geriye doğru uyumluluğu etkilemez.

Aşağıdaki tabloda sonuç kümesindeki sütunlar listelenir. 5. sütun (NOTLAR) dışındaki ek sütunlar sürücü tarafından tanımlanabilir. Bir uygulama, açık bir sıralı konum belirtmek yerine sonuç kümesinin sonundan geri sayarak sürücüye özgü sütunlara erişim elde etmelidir. Daha fazla bilgi için bkz. Katalog İşlevleri Tarafından Döndürülen Veriler.

Example

Aşağıdaki örnek kod serbest tutamaçlar ve bağlantılar sağlamaz. Serbest tutamaçlar ve ifadeler için kod örnekleri için SQLFreeHandle Fonksiyonu ve SQLFreeStmt Fonksiyonu'na bakınız.

// SQLTables.cpp  
// compile with: user32.lib odbc32.lib  
#include <windows.h>  
#include <sqlext.h>  
#include <strsafe.h>  
  
// simple helper functions  
int MySQLSuccess(SQLRETURN rc) {  
   return (rc == SQL_SUCCESS || rc == SQL_SUCCESS_WITH_INFO);  
}  
  
struct DataBinding {  
   SQLSMALLINT TargetType;  
   SQLPOINTER TargetValuePtr;  
   SQLINTEGER BufferLength;  
   SQLLEN StrLen_or_Ind;  
};  
  
void printCatalog(const struct DataBinding* catalogResult) {  
   if (catalogResult[0].StrLen_or_Ind != SQL_NULL_DATA)   
      printf("Catalog Name = %s\n", (char *)catalogResult[0].TargetValuePtr);  
}  
  
// remember to disconnect and free memory, and free statements and handles  
int main() {  
   int bufferSize = 1024, i, numCols = 5;  
   struct DataBinding* catalogResult = (struct DataBinding*) malloc( numCols * sizeof(struct DataBinding) );  
   wchar_t* dbName = (wchar_t *)malloc( sizeof(wchar_t)*bufferSize );  
   wchar_t* userName = (wchar_t *)malloc( sizeof(wchar_t)*bufferSize );  
  
   // declare and initialize the environment, connection, statement handles  
   SQLHENV henv = NULL;   // Environment     
   SQLHDBC hdbc = NULL;   // Connection handle  
   SQLHSTMT hstmt = NULL;   // Statement handle  
  
   SQLRETURN retCode;  
   HWND desktopHandle = GetDesktopWindow();   // desktop's window handle  
   SQLWCHAR connStrbuffer[1024];  
   SQLSMALLINT connStrBufferLen;  
  
   retCode = SQLAllocHandle(SQL_HANDLE_ENV, SQL_NULL_HANDLE, &henv);  
   retCode = SQLSetEnvAttr(henv, SQL_ATTR_ODBC_VERSION, (void*)SQL_OV_ODBC3, -1);  
   retCode = SQLAllocHandle(SQL_HANDLE_DBC, henv, &hdbc);  
   retCode = SQLSetConnectAttr(hdbc, SQL_LOGIN_TIMEOUT, (SQLPOINTER)10, 0);  
   retCode = SQLDriverConnect(hdbc, desktopHandle, (SQLCHAR*)"Driver={SQL Server}", SQL_NTS, (SQLCHAR*)connStrbuffer, 1024 + 1, &connStrBufferLen, SQL_DRIVER_PROMPT);  
   retCode = SQLAllocHandle(SQL_HANDLE_STMT, hdbc, &hstmt);  
   retCode = SQLGetInfo(hdbc, SQL_DATABASE_NAME, dbName, (SQLSMALLINT)bufferSize, (SQLSMALLINT *)&bufferSize);  
   retCode = SQLGetInfo(hdbc, SQL_USER_NAME, userName, (SQLSMALLINT)bufferSize, (SQLSMALLINT *)&bufferSize);  
  
   bufferSize = 1024;  
  
   // allocate memory for the binding  
   // free this memory when done  
   for ( i = 0 ; i < numCols ; i++ ) {  
      catalogResult[i].TargetType = SQL_C_CHAR;  
      catalogResult[i].BufferLength = (bufferSize + 1);  
      catalogResult[i].TargetValuePtr = malloc( sizeof(unsigned char)*catalogResult[i].BufferLength );  
   }  
  
   // setup the binding (can be used even if the statement is closed by closeStatementHandle)  
   for ( i = 0 ; i < numCols ; i++ )  
      retCode = SQLBindCol(hstmt, (SQLUSMALLINT)i + 1, catalogResult[i].TargetType, catalogResult[i].TargetValuePtr, catalogResult[i].BufferLength, &(catalogResult[i].StrLen_or_Ind));  
  
   // all catalogs query  
   printf( "A list of names of all catalogs\n" );  
   retCode = SQLTables( hstmt, (SQLCHAR*)SQL_ALL_CATALOGS, SQL_NTS, (SQLCHAR*)"", SQL_NTS, (SQLCHAR*)"", SQL_NTS, (SQLCHAR*)"", SQL_NTS );  
   for ( retCode = SQLFetch(hstmt) ;  MySQLSuccess(retCode) ; retCode = SQLFetch(hstmt) )  
      printCatalog( catalogResult );  
}  

İlgili Fonksiyonlar

Ayrıca Bkz.

ODBC API Referansı
ODBC Üst Bilgi Dosyaları