SQLTables-Funktion

Konformität
Version eingeführt: ODBC 1.0 Standards Compliance: Open Group

Zusammenfassung
SQLTables gibt die Liste der Tabellen-, Katalog- oder Schemanamen und Tabellentypen zurück, die in einer bestimmten Datenquelle gespeichert sind. Der Treiber gibt die Informationen als Resultset zurück.

Syntax

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

Argumente

StatementHandle
[Eingabe] Anweisungshandle für abgerufene Ergebnisse.

Catalogname
[Eingabe] Katalogname. Das CatalogName-Argument akzeptiert Suchmuster, wenn das SQL_ODBC_VERSION-Umgebungsattribut SQL_OV_ODBC3 ist. Es akzeptiert keine Suchmuster, wenn SQL_OV_ODBC2 festgelegt ist. Wenn ein Treiber Kataloge für einige Tabellen, aber nicht für andere unterstützt, z. B. wenn ein Treiber Daten aus verschiedenen Datenbankdatenbanken abruft, gibt eine leere Zeichenfolge ("") die Tabellen an, die keine Kataloge enthalten.

Wenn das Attribut der SQL_ATTR_METADATA_ID-Anweisung auf SQL_TRUE festgelegt ist, wird CatalogName als Bezeichner behandelt, und die Groß- und Kleinschreibung ist nicht signifikant. Wenn es SQL_FALSE ist, ist CatalogName ein Musterwertargument. es wird wörtlich behandelt, und sein Fall ist von Bedeutung. Weitere Informationen finden Sie unter Argumente in Katalogfunktionen.

NameLength1
[Eingabe] Länge in Zeichen von *CatalogName.

Schemaname
[Eingabe] Zeichenfolgensuchmuster für Schemanamen. Wenn ein Treiber Schemas für einige Tabellen, aber nicht für andere unterstützt, z. B. wenn der Treiber Daten aus verschiedenen Datenbankdatenbanken abruft, gibt eine leere Zeichenfolge ("") die Tabellen ohne Schemas an.

Wenn das Attribut SQL_ATTR_METADATA_ID-Anweisung auf SQL_TRUE festgelegt ist, wird SchemaName als Bezeichner behandelt, und die Groß- und Kleinschreibung ist nicht signifikant. Wenn es SQL_FALSE ist, ist SchemaName ein Musterwertargument. es wird wörtlich behandelt, und sein Fall ist von Bedeutung.

NameLength2
[Eingabe] Länge in Zeichen von *SchemaName.

TableName
[Eingabe] Zeichenfolgensuchmuster für Tabellennamen.

Wenn das Attribut SQL_ATTR_METADATA_ID-Anweisung auf SQL_TRUE festgelegt ist, wird TableName als Bezeichner behandelt, und die Groß- und Kleinschreibung ist nicht signifikant. Wenn es SQL_FALSE ist, ist TableName ein Musterwertargument. es wird wörtlich behandelt, und sein Fall ist von Bedeutung.

NameLength3
[Eingabe] Länge in Zeichen von *TableName.

TableType
[Eingabe] Liste der zu übereinstimmenden Tabellentypen.

Beachten Sie, dass das Attribut SQL_ATTR_METADATA_ID-Anweisung keine Auswirkungen auf das TableType-Argument hat. TableType ist ein Wertlistenargument, unabhängig von der Einstellung von SQL_ATTR_METADATA_ID.

NameLength4
[Eingabe] Länge in Zeichen von *TableType.

Gibt zurück

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR oder SQL_INVALID_HANDLE.

Diagnose

Wenn SQLTables SQL_ERROR oder SQL_SUCCESS_WITH_INFO zurückgibt, kann ein zugeordneter SQLSTATE-Wert abgerufen werden, indem SQLGetDiagRec mit einem HandleType von SQL_HANDLE_STMT und einem Handle of StatementHandle aufgerufen wird. In der folgenden Tabelle sind die SQLSTATE-Werte aufgeführt, die normalerweise von SQLTables zurückgegeben werden, und die einzelnen Werte werden im Kontext dieser Funktion erläutert. die Notation "(DM)" geht den Beschreibungen von SQLSTATEs voran, die vom Treiber-Manager zurückgegeben werden. Der rückgabecode, der jedem SQLSTATE-Wert zugeordnet ist, ist SQL_ERROR, sofern nicht anders angegeben.

Kommentare

SQLTables listet alle Tabellen im angeforderten Bereich auf. Ein Benutzer kann über SELECT-Berechtigungen für eine dieser Tabellen verfügen oder nicht. Um die Barrierefreiheit zu überprüfen, kann eine Anwendung:

• Rufen Sie SQLGetInfo auf , und überprüfen Sie den SQL_ACCESSIBLE_TABLES Informationstyp.

• Rufen Sie SQLTablePrivileges auf , um die Berechtigungen für jede Tabelle zu überprüfen.

Andernfalls muss die Anwendung in der Lage sein, eine Situation zu behandeln, in der der Benutzer eine Tabelle auswählt, für die KEINE SELECT-Berechtigungen gewährt werden.

Die Argumente SchemaName und TableName akzeptieren Suchmuster. Das Argument CatalogName akzeptiert Suchmuster, wenn das SQL_ODBC_VERSION-Umgebungsattribut SQL_OV_ODBC3 ist. Es akzeptiert keine Suchmuster, wenn SQL_OV_ODBC2 festgelegt ist. Wenn SQL_OV_ODBC3 festgelegt ist, erfordert ein ODBC 3*.x*-Treiber, dass Wildcardzeichen im CatalogName-Argument mit Escapezeichen versehen werden, damit sie wörtlich behandelt werden. Weitere Informationen zu gültigen Suchmustern finden Sie unter Musterwertargumente.

Um die Enumeration von Katalogen, Schemas und Tabellentypen zu unterstützen, werden die folgenden speziellen Semantiken für die Argumente CatalogName, SchemaName, TableName und TableType von SQLTables definiert:

• Wenn CatalogName SQL_ALL_CATALOGS und SchemaName und TableName leere Zeichenfolgen sind, enthält das Resultset eine Liste gültiger Kataloge für die Datenquelle. (Alle Spalten mit Ausnahme der spalte TABLE_CAT enthalten NULLs.)

• Wenn SchemaName SQL_ALL_SCHEMAS und CatalogName und TableName leere Zeichenfolgen sind, enthält das Resultset eine Liste gültiger Schemas für die Datenquelle. (Alle Spalten mit Ausnahme der spalte TABLE_SCHEM enthalten NULLs.)

• Wenn TableType SQL_ALL_TABLE_TYPES und CatalogName, SchemaName und TableName leere Zeichenfolgen sind, enthält das Resultset eine Liste gültiger Tabellentypen für die Datenquelle. (Alle Spalten mit Ausnahme der spalte TABLE_TYPE enthalten NULLs.)

Wenn TableType keine leere Zeichenfolge ist, muss es eine Liste mit durch Trennzeichen getrennten Werten für die relevanten Typen enthalten. Jeder Wert kann in einfache Anführungszeichen (') oder ohne Anführungszeichen eingeschlossen werden, z. B. "TABLE", "VIEW" oder "TABLE, VIEW". Eine Anwendung sollte den Tabellentyp immer in Großbuchstaben angeben. Der Treiber sollte den Tabellentyp in jeden Fall konvertieren, der von der Datenquelle benötigt wird. Wenn die Datenquelle einen angegebenen Tabellentyp nicht unterstützt, gibt SQLTables keine Ergebnisse für diesen Typ zurück.

SQLTables gibt die Ergebnisse als Standardresultset zurück, geordnet nach TABLE_TYPE, TABLE_CAT, TABLE_SCHEM und TABLE_NAME. Informationen dazu, wie diese Informationen verwendet werden können, finden Sie unter Verwendung von Katalogdaten.

Um die tatsächliche Länge der spalten TABLE_CAT, TABLE_SCHEM und TABLE_NAME zu bestimmen, kann eine Anwendung SQLGetInfo mit den Informationstypen SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN und SQL_MAX_TABLE_NAME_LEN aufrufen.

Die folgenden Spalten wurden für ODBC 3*.x* umbenannt. Die Änderungen des Spaltennamens wirken sich nicht auf die Abwärtskompatibilität aus, da Anwendungen anhand der Spaltennummer gebunden werden.

In der folgenden Tabelle sind die Spalten im Resultset aufgeführt. Zusätzliche Spalten über Spalte 5 (ANMERKUNGEN) hinaus können vom Treiber definiert werden. Eine Anwendung sollte Zugriff auf treiberspezifische Spalten erhalten, indem sie vom Ende des Resultsets heruntergezählt wird, anstatt eine explizite Ordnungsposition anzugeben. Weitere Informationen finden Sie unter Von Katalogfunktionen zurückgegebene Daten.

Beispiel

Der folgende Beispielcode gibt keine Handles und Verbindungen frei. Codebeispiele zum Freigeben von Handles und Anweisungen finden Sie unter SQLFreeHandle-Funktion und SQLFreeStmt-Funktion .

// 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 );  
}  

Verwandte Funktionen

Weitere Informationen

ODBC-API-Referenz
ODBC-Headerdateien