SQLForeignKeys İşlevi

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

Özet
SQLForeignKeys şunları döndürebilir:

• Belirtilen tablodaki yabancı anahtarların listesi (belirtilen tablodaki sütunlar, diğer tablolardaki birincil anahtarlara atıfta bulunur).

• Belirtilen tablodaki birincil anahtara atıfta bulunan diğer tablolardaki yabancı anahtarların listesi.

Sürücü, her listeyi belirtilen ifadede bir sonuç seti olarak döndürür.

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
[Giriş] Deyim tanıtıcısı.

PKatalogName
[Giriş] Birincil anahtar tablo katalog adı. 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ırken, boş bir dizi ("") katalogları olmayan tabloları gösterir. PKCatalogName bir dizi arama deseni içeremez.

Eğer SQL_ATTR_METADATA_ID ifadesi özniteliği SQL_TRUE olarak ayarlanmışsa, PKCatalogName tanımlayıcı olarak kabul edilir ve durumu anlamlı değildir. Eğer SQL_FALSE ise, PKCatalogName sıradan bir argümandı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ş] *PKCatalogName'in uzunluğu, karakter olarak.

PKSchemaName
[Giriş] Birincil anahtar tablo şema adı. 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ırken, boş bir dizi ("") şema olmayan tabloları gösterir. PKSchemaName bir dizi arama deseni içeremez.

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

NameLength2
[Giriş] *PKSchemaName'in uzunluğu, karakter olarak.

PKTableName
[Giriş] Birincil anahtar tablo adı. PKTableName bir dizi arama deseni içeremez.

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

NameLength3
[Giriş] *PKTableName'in uzunluğu, karakter olarak.

FKCatalogName
[Giriş] Yabancı anahtar tablosu katalog adı. 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ırken, boş bir dizi ("") katalogları olmayan tabloları gösterir. FKCatalogName bir dize arama deseni içeremez.

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

NameLength4
[Giriş] *FKCatalogName'in uzunluğu, karakter olarak.

FKSchemaName
[Giriş] Yabancı anahtar tablo şema adı. 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ırken, boş bir dizi ("") şema olmayan tabloları gösterir. FKSchemaName bir dizi arama deseni içeremez.

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

NameLength5
[Giriş] *FKSchemaName'in uzunluğu, karakter olarak.

FKTableName
[Giriş] Yabancı anahtar tablo adı. FKTableName bir dizi arama deseni içeremez.

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

NameLength6
[Giriş] *FKTableName'in uzunluğu, karakter olarak.

İadeler

SQL_SUCCESS, SQL_SUCCESS_WITH_INFO, SQL_STILL_EXECUTING, SQL_ERROR ya da SQL_INVALID_HANDLE.

Diagnostics

SQLForeignKeys SQL_ERROR veya SQL_SUCCESS_WITH_INFO döndürdüğünde, ilişkili bir SQLSTATE değeri SQLGetDiagRec çağrılarak SQL_HANDLE_STMT HandleType ve HandleHandle ile elde edilebilir. Aşağıdaki tablo, genellikle SQLForeignKeys tarafından duygulanan SQLSTATE değerlerini listeler ve her birini bu fonksiyon 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

Bu fonksiyonun verdiği bilgilerin nasıl kullanılabileceğine dair bilgi için Kullanım Katalog Verileri'ne bakınız.

Eğer *PKTableName bir tablo adı içeriyorsa, SQLForeignKeys belirtilen tablonun birincil anahtarını ve ona atıfta bulunan tüm yabancı anahtarları içeren bir sonuç kümesi döner. Diğer tablolardaki yabancı anahtarlar listesi, belirtilen tablodaki benzersiz kısıtlamalara işaret eden yabancı anahtarları içermez.

Eğer *FKTableName bir tablo adı içeriyorsa, SQLForeignKeys belirtilen tablodaki diğer tablolardaki birincil anahtarlara işaret eden tüm yabancı anahtarları ve referans aldıkları diğer tablolardaki birincil anahtarları içeren bir sonuç kümesi döner. Belirtilen tablodaki yabancı anahtarlar listesi, diğer tablolardaki benzersiz kısıtlamalara atıfta bulunan yabancı anahtarları içermez.

Eğer hem *PKTableName hem de *FKTableName tablo adları içeriyorsa, SQLForeignKeys , *FKTableName içinde belirtilen tablodaki yabancı anahtarları döndürür; bu anahtarlar *PKTableName içinde belirtilen tablonun birincil anahtarına atıfta bulunur. Bu en fazla bir anahtar olmalı.

SQLForeignKeys , standart bir sonuç kümesi olarak sonuçları döndürür. Birincil anahtara bağlı yabancı anahtarlar istenirse, sonuç kümesi FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME ve KEY_SEQ olarak sıralanır. Yabancı anahtara bağlı birincil anahtarlar istenirse, sonuç kümesi PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME ve KEY_SEQ olarak sıralanır. Aşağıdaki tabloda sonuç kümesindeki sütunlar listelenir.

VARCHAR sütunlarının uzunlukları tabloda gösterilmemiştir; Gerçek uzunluklar veri kaynağına bağlıdır. PKTABLE_CAT veya FKTABLE_CAT, PKTABLE_SCHEM veya FKTABLE_SCHEM, PKTABLE_NAME veya FKTABLE_NAME ve PKCOLUMN_NAME veya FKCOLUMN_NAME sütunlarının gerçek uzunluklarını belirlemek için bir uygulama, SQL_MAX_CATALOG_NAME_LEN, SQL_MAX_SCHEMA_NAME_LEN, SQL_MAX_TABLE_NAME_LEN ve SQL_MAX_COLUMN_NAME_LEN seçenekleriyle 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 dönük uyumluluk etkisini sağlamaz.

Aşağıdaki tabloda sonuç kümesindeki sütunlar listelenir. 14. sütunun (NOTLAR) ötesinde 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.

Kod Örneği

Aşağıdaki tabloda gösterildiği gibi, bu örnek üç tablo kullanır: SIPARIŞLER, HATLAR ve MÜŞTERILER.

ORDERS tablosunda CUSTED, satışın yapıldığı müşteriyi belirler. CUSTOMERS tablosunda CUSID'i ifade eden yabancı bir anahtardır.

SATLAR tablosunda ORDERID, satır öğesinin ilişkilendirildiği satış sırasını tanımlar. ORDERS tablosunda ORDERID'ye atıfta bulunan yabancı bir anahtardır.

Bu örnek, ORDERS tablosunun birincil anahtarını almak için SQLPrimaryKeys çağırır. Sonuç seti bir satırdan oluşur; Önemli sütunlar aşağıdaki tabloda gösterilmiştir.

Sonra, örnek, ORDERS tablosunun birincil anahtarına referans veren diğer tablolardaki yabancı anahtarları almak için SQLForeignKeys çağırır. Sonuç seti bir satırdan oluşur; Önemli sütunlar aşağıdaki tabloda gösterilmiştir.

Son olarak, örnek SQLForeignKeys çağrısıyla ORDERS tablosundaki yabancı anahtarları alır ve bu anahtarlar diğer tabloların birincil anahtarlarına atıfta bulunur. Sonuç seti bir satırdan oluşur; Önemli sütunlar aşağıdaki tabloda gösterilmiştir.

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

İlgili Fonksiyonlar

Ayrıca Bkz.

ODBC API Referansı
ODBC Üst Bilgi Dosyaları