Funkce SQLForeignKeys

Soulad
Zavedená verze: ODBC 1.0 Soulad standardů: ODBC

Shrnutí
SQLForeignKeys může vrátit:

• Seznam cizích klíčů ve specifikované tabulce (sloupce v dané tabulce, které odkazují na primární klíče v jiných tabulkách).

• Seznam cizích klíčů v jiných tabulkách, které odkazují na primární klíč ve specifikované tabulce.

Ovladač vrací každý seznam jako výslednou sadu na zadaném příkazu.

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
[Vstup] Popisovač příkazu

PKCatalogName
[Vstup] Primární klíčová tabulka katalogu název. Pokud ovladač podporuje katalogy pro některé tabulky, ale ne pro jiné, například když ovladač získává data z různých DBMS, prázdný řetězec ("") označuje tabulky, které katalogy nemají. PKCatalogName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, PKCatalogName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, PKCatalogName je běžný argument; Je brána doslovně a její případ je významný. Další informace naleznete v tématu Argumenty funkce katalogu.

NameLength1
[Vstup] Délka *PKCatalogName, v znacích.

PKSchemaName
[Vstup] Název schématu primární klíčové tabulky. Pokud ovladač podporuje schémata pro některé tabulky, ale ne pro jiné, například když ovladač získává data z různých DBMS, prázdný řetězec ("") označuje tabulky, které schémata nemají. PKSchemaName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, PKSchemaName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, PKSchemaName je běžný argument; Je brána doslovně a její případ je významný.

NameLength2
[Vstup] Délka *PKSchemaName, v znacích.

PKTableName
[Vstup] Název hlavní klíčové tabulky. PKTableName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, PKTableName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, PKTableName je běžný argument; Je brána doslovně a její případ je významný.

NameLength3
[Vstup] Délka *PKTableName, v znacích.

FKCatalogName
[Vstup] Název katalogu tabulky cizích klíčů. Pokud ovladač podporuje katalogy pro některé tabulky, ale ne pro jiné, například když ovladač získává data z různých DBMS, prázdný řetězec ("") označuje tabulky, které katalogy nemají. FKCatalogName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, FKCatalogName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, FKCatalogName je běžný argument; Je brána doslovně a její případ je významný.

NameLength4
[Vstup] Délka *FKCatalogName, v znacích.

FKSchemaName
[Vstup] Název schématu cizí klíčové tabulky. Pokud ovladač podporuje schémata pro některé tabulky, ale ne pro jiné, například když ovladač získává data z různých DBMS, prázdný řetězec ("") označuje tabulky, které schémata nemají. FKSchemaName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, FKSchemaName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, FKSchemaName je běžný argument; Je brána doslovně a její případ je významný.

NázevDélka5
[Vstup] Délka *FKSchemaName, v znacích.

FKTableName
[Vstup] Název tabulky cizích klíčů. FKTableName nemůže obsahovat vzor vyhledávání řetězců.

Pokud je atribut SQL_ATTR_METADATA_ID příkazu nastaven na SQL_TRUE, FKTableName je považován za identifikátor a jeho případ není významný. Pokud je to SQL_FALSE, FKTableName je běžný argument; Je brána doslovně a její případ je významný.

NájmenDélka6
[Vstup] Délka *FKTableName, v znacích.

Returns

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR nebo SQL_INVALID_HANDLE.

Diagnostics

Když SQLForeignKeys vrátí SQL_ERROR nebo SQL_SUCCESS_WITH_INFO, lze získat přidruženou hodnotu SQLstate, pokud zavoláte SQLGetDiagRec s HandleType SQL_HANDLE_STMT a HandleStatementHandle. Následující tabulka uvádí hodnoty SQLSTATE, které SQLForeignKeys obvykle vrací, a vysvětluje každou z nich v kontextu této funkce; notace "(DM)" předchází popisům SQLstavů vráceným Správcem ovladačů. Návratový kód přidružený ke každé hodnotě SQLSTATE je SQL_ERROR, pokud není uvedeno jinak.

Comments

Pro informace o tom, jak lze informace vrácené touto funkcí použít, viz Využití katalogových dat.

Pokud *PKTableName obsahuje název tabulky, SQLForeignKeys vrátí výslednou sadu, která obsahuje primární klíč dané tabulky a všechny cizí klíče, které se na ni vztahují. Seznam cizích klíčů v jiných tabulkách nezahrnuje cizí klíče, které ukazují na jedinečná omezení v dané tabulce.

Pokud *FKTableName obsahuje název tabulky, SQLForeignKeys vrátí výslednou sadu, která obsahuje všechny cizí klíče ve specifikované tabulce, které ukazují na primární klíče v jiných tabulkách, a primární klíče v ostatních tabulkách, na které se vztahují. Seznam cizích klíčů v uvedené tabulce neobsahuje cizí klíče, které odkazují na jedinečná omezení v jiných tabulkách.

Pokud oba typy *PKTableName a *FKTableName obsahují názvy tabulek, SQLForeignKeys vrátí cizí klíče v tabulce specifikované v *FKTableName , které odkazují na primární klíč tabulky specifikované v *PKTableName. To by měl být maximálně jeden klíč.

SQLForeignKeys vrací výsledky jako standardní sadu výsledků. Pokud jsou požádány cizí klíče spojené s primárním klíčem, výsledná sada je uspořádána podle FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME a KEY_SEQ. Pokud jsou požádány primární klíče spojené s cizím klíčem, výsledná sada je uspořádána podle PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME a KEY_SEQ. Následující tabulka uvádí sloupce v sadě výsledků.

Délky sloupců VARCHAR nejsou v tabulce uvedeny; skutečné délky závisí na zdroji dat. Pro určení skutečných délek PKTABLE_CAT nebo FKTABLE_CAT, PKTABLE_SCHEM nebo FKTABLE_SCHEM, PKTABLE_NAME nebo FKTABLE_NAME a sloupců PKCOLUMN_NAME nebo FKCOLUMN_NAME může aplikace volat SQLGetInfo s možnostmi SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN a SQL_MAX_COLUMN_NAME_LEN.

Následující sloupce byly přejmenovány pro ODBC 3*.x.* Změny názvů sloupců neovlivňují zpětnou kompatibilitu, protože aplikace se vázají podle čísla sloupce.

Následující tabulka uvádí sloupce v sadě výsledků. Další sloupce za sloupcem 14 (POZNÁMKY) může řidič definovat. Aplikace by měla získat přístup ke sloupcům specifickým pro ovladače tím, že odpočítává od konce sady výsledků místo určení explicitní řadové pozice. Další informace naleznete v tématu Data vrácená funkcemi katalogu.

Příklad kódu

Jak je znázorněno v následující tabulce, tento příklad používá tři tabulky nazvané OBJEDNÁVKY, ŘÁDKY a ZÁKAZNÍCI.

V tabulce OBJEDNÁVKY CUSTID identifikuje zákazníka, kterému byl prodej uskutečněn. Jedná se o cizí klíč, který odkazuje na CUSTID v tabulce ZÁKAZNÍCI.

V tabulce LINES identifikuje ORDERID prodejní objednávku, ke které je položka přiřazena. Jedná se o cizí klíč, který odkazuje na ORDERID v tabulce ORDERS.

Tento příklad volá SQLPrimaryKeys pro získání primárního klíče tabulky ORDERS. Výsledná sada bude mít jeden řádek; Významné sloupce jsou zobrazeny v následující tabulce.

Dále příklad volá SQLForeignKeys pro získání cizích klíčů v jiných tabulkách, které odkazují na primární klíč tabulky ORDERS. Výsledná sada bude mít jeden řádek; Významné sloupce jsou zobrazeny v následující tabulce.

Nakonec příklad volá SQLForeignKeys pro získání cizích klíčů v tabulce ORDERS, které odkazují na primární klíče jiných tabulek. Výsledná sada bude mít jeden řádek; Významné sloupce jsou zobrazeny v následující tabulce.

#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);  

Související funkce

Viz také

Referenční rozhraní ODBC API
Soubory hlaviček ODBC