SQLForeignKeys függvény

Megfelelőség
Bemutatott verzió: ODBC 1.0 Szabványoknak megfelelés: ODBC

Összefoglalás
SQLForeignKeys vissza tud adni:

• A megadott táblázatban található idegen kulcsok listája (a megadott táblázatban lévő oszlopok, amelyek más táblák elsődleges kulcsaira utalnak).

• Egy lista idegen kulcsokról más táblákban, amelyek a megadott táblázatban lévő elsődleges kulcsra utalnak.

Az illesztőprogram minden listát eredményként adja vissza, amely a megadott utasításon van beállítva.

Syntax

  
SQLRETURN SQLForeignKeys(  
     SQLHSTMT       StatementHandle,  
     SQLCHAR *      PKCatalogName,  
     SQLSMALLINT    NameLength1,  
     SQLCHAR *      PKSchemaName,  
     SQLSMALLINT    NameLength2,  
     SQLCHAR *      PKTableName,  
     SQLSMALLINT    NameLength3,  
     SQLCHAR *      FKCatalogName,  
     SQLSMALLINT    NameLength4,  
     SQLCHAR *      FKSchemaName,  
     SQLSMALLINT    NameLength5,  
     SQLCHAR *      FKTableName,  
     SQLSMALLINT    NameLength6);  

Arguments

StatementHandle
[Bemenet] Utasításkezelő.

PKCatalogName
[Bemenet] Elsődleges kulcstáblának a katalógus neve. Ha egy illesztőprogram bizonyos táblákhoz katalógusokat támogat, másoknál nem, például amikor az illesztőprogram adatokat tölt be különböző adatbázisokból, akkor egy üres string ("") jelzi azokat a táblákat, amelyeknek nincs katalógus. A PKCatalogName nem tartalmazhat stringkereső mintát.

Ha a SQL_ATTR_METADATA_ID utasítás attribútuma SQL_TRUE-re van beállítva, a PKCatalogName azonosítóként kezelik, és az esete nem jelentős. Ha SQL_FALSE, akkor a PKCatalogName egy átlagos érv; szó szerint kezelik, és az esete jelentős. További információ: A Catalog Functions argumentumai.

NameLength1
[Bemenet] *PKCatalogNév hossza, karakterekben.

PKSchemaName
[Bemenet] Elsődleges kulcstáblás séma név. Ha egy illesztőprogram támogatja a sémákat bizonyos táblákhoz, de másokhoz nem, például amikor az illeszőr adatokat tölt be különböző adatbázisokból, akkor egy üres string ("") jelzi azokat a táblákat, amelyeknek nincs sémájuk. A PKSchemaName nem tartalmazhat stringkereső mintát.

Ha a SQL_ATTR_METADATA_ID állítás attribútuma SQL_TRUE-re van beállítva, a PKSchemaName azonosítóként kezelik, és az esete nem jelentős. Ha SQL_FALSE, akkor a PKSchemaName egy átlagos érv; szó szerint kezelik, és az esete jelentős.

NameLength2
[Bemenet] *PKSchemaName) hossza karakterekben.

PKTableName
[Bemenet] Elsődleges kulcstábla neve. A PKTableName nem tartalmazhat stringkereső mintát.

Ha a SQL_ATTR_METADATA_ID utasítás attribútuma SQL_TRUE-re van beállítva, a PKTableName azonosítóként kezelhető, és az esete nem jelentős. Ha SQL_FALSE, akkor a PKTableName egy átlagos érv; szó szerint kezelik, és az esete jelentős.

NameLength3
[Bemenet] *PKTableName-hossz, karakterekben.

FKCatalogName
[Bemenet] Külföldi kulcstáblás katalógus neve. Ha egy illesztőprogram bizonyos táblákhoz katalógusokat támogat, másoknál nem, például amikor az illesztőprogram adatokat tölt be különböző adatbázisokból, akkor egy üres string ("") jelzi azokat a táblákat, amelyeknek nincs katalógus. Az FKCatalogName nem tartalmazhat stringkereső mintát.

Ha az SQL_ATTR_METADATA_ID mondattútumot SQL_TRUE-re állították, az FKCatalogName azonosítóként kezelhető, és az esete nem jelentős. Ha SQL_FALSE, akkor az FKCatalogName egy átlagos érv; szó szerint kezelik, és az esete jelentős.

NameLength4
[Bemenet] *FKCatalogName) hossza, karakterekben.

FKSchemaName
[Bemenet] Külföldi kulcstáblás séma név. Ha egy illesztőprogram támogatja a sémákat bizonyos táblákhoz, de másokhoz nem, például amikor az illeszőr adatokat tölt be különböző adatbázisokból, akkor egy üres string ("") jelzi azokat a táblákat, amelyeknek nincs sémájuk. Az FKSchemaName nem tartalmazhat stringkereső mintát.

Ha az SQL_ATTR_METADATA_ID utasítás attribútuma SQL_TRUE-re van beállítva, akkor az FKSchemaName azonosítóként kezelhető, és az esete nem jelentős. Ha SQL_FALSE, akkor az FKSchemaName egy átlagos érv; szó szerint kezelik, és az esete jelentős.

NameLength5
[Bemenet] *FKSchemaName) hossza karakterekben.

FKTableName
[Bemenet] Külföldi kulcstáblák neve. Az FKTableName nem tartalmazhat string keresési mintát.

Ha a SQL_ATTR_METADATA_ID utasítás attribútuma SQL_TRUE-re van beállítva, az FKTableName azonosítóként kezelhető, és az esete nem jelentős. Ha SQL_FALSE, akkor az FKTableName egy átlagos érv; szó szerint kezelik, és az esete jelentős.

NameLength6
[Bemenet] *FKTableName, karakterekben.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR vagy SQL_INVALID_HANDLE.

Diagnostics

Amikor a SQLForeignKeys SQL_ERROR vagy SQL_SUCCESS_WITH_INFO értéket ad vissza, egy hozzárendelt SQLSTATE értéket lehet megszerezni SQLGetDiagRec hívásával, amely egy SQL_HANDLE_STMT HandleType és egy HandleType of StatementHandle (Handle) segítségével szól. Az alábbi táblázat felsorolja az SQLForeignKeys által általában visszaadott SQLSTATE értékeket, és mindegyiket elmagyarázza ezen függvény kontextusában; a "(DM)" jelölés megelőzi a Driver Manager által visszaadott SQLSTATE-leírásokat. Az egyes SQLSTATE-értékekhez társított visszatérési kód SQL_ERROR, kivéve, ha másként van feltüntetve.

Comments

Arról, hogyan használható az adott információ a funkció által visszaadott információk, lásd: Katalogikus adatok felhasználása.

Ha a *PKTableName tartalmaz egy táblanevet, akkor a SQLForeignKeys egy eredményhalmazt ad vissza, amely tartalmazza a megadott tábla elsődleges kulcsát és az összes hozzá hivatkozó külföldi kulcsot. Más táblák idegen kulcsainak listája nem tartalmaz olyan idegen kulcsokat, amelyek a megadott táblázatban egyedi korlátokra mutatnak.

Ha a *FKTableName tartalmaz táblanevet, az SQLForeignKeys egy eredményhalmazt ad vissza, amely tartalmazza az összes idegen kulcsot a megadott táblában, amelyek más táblák elsődleges kulcsaira mutatnak, valamint a többi táblára tartozó elsődleges kulcsokat, amelyekre hivatkoznak. A megadott táblázatban szereplő idegen kulcsok listája nem tartalmaz olyan idegen kulcsokat, amelyek más táblák egyedi korlátaira utalnak.

Ha mind a *PKTableName , mind a *FKTableName tartalmaz táblaneveket, akkor a SQLForeignKeys visszaadja azokat a külföldi kulcsokat a *FKTableName táblájában, amelyek a *PKTableName által megadott tábla elsődleges kulcsára utalnak. Ez legfeljebb egy kulcs lehet.

Az SQLForeignKeys standard eredményhalmazként adja vissza az eredményeket. Ha az elsődleges kulcshoz tartozó idegen kulcsokat kérik, az eredményhalmaz FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME és KEY_SEQ sorrendben van. Ha egy idegen kulcshoz tartozó elsődleges kulcsokat kérik, az eredményhalmaz PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME és KEY_SEQ szerint sorolódik. Az alábbi táblázat az eredményhalmaz oszlopait sorolja fel.

A VARCHAR oszlopok hosszai nincsenek a táblázatban; a tényleges hosszok az adatforrástól függnek. A PKTABLE_CAT vagy FKTABLE_CAT, PKTABLE_SCHEM vagy FKTABLE_SCHEM, PKTABLE_NAME vagy FKTABLE_NAME, valamint PKCOLUMN_NAME vagy FKCOLUMN_NAME oszlop tényleges hosszának meghatározásához egy alkalmazás hívhatja az SQLGetInfo-t az SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN és SQL_MAX_COLUMN_NAME_LEN opciókkal.

Az alábbi oszlopokat ODBC 3*.x.* névre nevezték át. Az oszlopnév változásai nem befolyásolják a visszafelé kompatibilitást, mivel az alkalmazások oszlopszám alapján kötöttek.

Az alábbi táblázat az eredményhalmaz oszlopait sorolja fel. A 14. oszlopon (MEGJEGYZÉSEK) túl további oszlopokat az illesztővezető definiálhat. Az alkalmazásnak hozzáférést kell szereznie az illesztőprogram-specifikus oszlopokhoz úgy, hogy az eredményhalmaz végétől lefelé számlál, nem pedig explicit sorrendi pozíciót ad meg. További információ: Catalog Functions által visszaadott adatok.

Kódpélda

Ahogy a következő táblázatban látható, ez a példa három táblát használ, amelyeket ORDERS, LINES és CUSTOMERS néven ismertek.

A ORDERS táblázatban a CUSTID megjelöli azt az ügyfelet, akinek az eladás történt. Ez egy idegen kulcs, amely a CUSTID-re utal a CUSTOMERS táblában.

A SOROK táblában az ORDERID azonosítja azt az értékesítési rendelést, amelyhez a sortétel kapcsolódik. Ez egy idegen kulcs, amely a ORDERS táblában az ORDERID-re utal.

Ez a példa az SQLPrimaryKeys-t hívja, hogy megkapja a ORDERS tábla elsődleges kulcsát. Az eredményhalmaznak egy sora lesz; a jelentős oszlopokat az alábbi táblázat mutatja.

Ezután a példa SQLForeignKeys-t hívja, hogy megkapja a külföldi kulcsokat más táblákból, amelyek a ORDERS tábla elsődleges kulcsára hivatkoznak. Az eredményhalmaznak egy sora lesz; a jelentős oszlopokat az alábbi táblázat mutatja.

Végül a példa az SQLForeignKeys-t hívja, hogy megkapja azokat az idegen kulcsokat a ORDERS táblában, amelyek más táblák elsődleges kulcsaira utalnak. Az eredményhalmaznak egy sora lesz; a jelentős oszlopokat az alábbi táblázat mutatja.

#define TAB_LEN SQL_MAX_TABLE_NAME_LEN + 1  
#define COL_LEN SQL_MAX_COLUMN_NAME_LEN + 1  
  
LPSTR   szTable;              /* Table to display */  
  
UCHAR szPkTable[TAB_LEN];   /* Primary key table name */  
UCHAR szFkTable[TAB_LEN];   /* Foreign key table name */  
UCHAR szPkCol[COL_LEN];     /* Primary key column */  
UCHAR szFkCol[COL_LEN];     /* Foreign key column */  
  
SQLHSTMT      hstmt;  
SQLINTEGER    cbPkTable, cbPkCol, cbFkTable, cbFkCol, cbKeySeq;  
SQLSMALLINT   iKeySeq;  
SQLRETURN     retcode;  
  
// Bind the columns that describe the primary and foreign keys.  
// Ignore the table schema, name, and catalog for this example.  
  
SQLBindCol(hstmt, 3, SQL_C_CHAR, szPkTable, TAB_LEN, &cbPkTable);  
SQLBindCol(hstmt, 4, SQL_C_CHAR, szPkCol, COL_LEN, &cbPkCol);  
SQLBindCol(hstmt, 5, SQL_C_SSHORT, &iKeySeq, TAB_LEN, &cbKeySeq);  
SQLBindCol(hstmt, 7, SQL_C_CHAR, szFkTable, TAB_LEN, &cbFkTable);  
SQLBindCol(hstmt, 8, SQL_C_CHAR, szFkCol, COL_LEN, &cbFkCol);  
  
strcpy_s(szTable, sizeof(szTable), "ORDERS");  
  
/* Get the names of the columns in the primary key. */  
  
retcode = SQLPrimaryKeys(hstmt,  
         NULL, 0,             /* Catalog name */  
         NULL, 0,             /* Schema name */  
         szTable, SQL_NTS);   /* Table name */  
  
while ((retcode == SQL_SUCCESS) || (retcode == SQL SUCCESS_WITH_INFO)) {  
  
   /* Fetch and display the result set. This will be a list of the */  
   /* columns in the primary key of the ORDERS table. */  
  
   retcode = SQLFetch(hstmt);  
   if (retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO)  
      fprintf(out, "Table: %s Column: %s Key Seq: %hd \n", szPkTable, szPkCol,  
      iKeySeq);  
}  
  
/* Close the cursor (the hstmt is still allocated). */  
  
SQLFreeStmt(hstmt, SQL_CLOSE);  
  
/* Get all the foreign keys that refer to ORDERS primary key.*/   
  
retcode = SQLForeignKeys(hstmt,  
         NULL, 0,            /* Primary catalog */  
         NULL, 0,            /* Primary schema */  
         szTable, SQL_NTS,   /* Primary table */  
         NULL, 0,            /* Foreign catalog */  
         NULL, 0,            /* Foreign schema */  
         NULL, 0);           /* Foreign table */  
  
while ((retcode == SQL_SUCCESS) || (retcode == SQL_SUCCESS_WITH_INFO)) {  
  
/* Fetch and display the result set. This will be all of the */  
/* foreign keys in other tables that refer to the ORDERS */  
/* primary key. */  
  
   retcode = SQLFetch(hstmt);  
   if (retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO)  
      fprintf(out, "%-s ( %-s ) <-- %-s ( %-s )\n", szPkTable,  
               szPkCol, szFkTable, szFkCol);  
}  
  
/* Close the cursor (the hstmt is still allocated). */  
  
SQLFreeStmt(hstmt, SQL_CLOSE);  
  
/* Get all the foreign keys in the ORDERS table. */  
  
retcode = SQLForeignKeys(hstmt,  
         NULL, 0,             /* Primary catalog */  
         NULL, 0,             /* Primary schema */  
         NULL, 0,             /* Primary table */  
         NULL, 0,             /* Foreign catalog */  
         NULL, 0,             /* Foreign schema */  
         szTable, SQL_NTS);   /* Foreign table */  
  
while ((retcode == SQL_SUCCESS) || (retcode == SQL_SUCCESS_WITH_INFO)) {  
  
/* Fetch and display the result set. This will be all of the */  
/* primary keys in other tables that are referred to by foreign */  
/* keys in the ORDERS table. */  
  
   retcode = SQLFetch(hstmt);  
   if (retcode == SQL_SUCCESS || retcode == SQL_SUCCESS_WITH_INFO)  
      fprintf(out, "%-s ( %-s )--> %-s ( %-s )\n", szFkTable, szFkCol, szPkTable, szPkCol);  
}  
  
/* Free the hstmt. */  
SQLFreeStmt(hstmt, SQL_DROP);  

Kapcsolódó funkciók

Lásd még

ODBC API-referencia
ODBC-fejlécfájlok