Recupera uma lista de chaves estrangeiras

Descrição

odbc_foreignkeys(
    resource $odbc,
    ?string $pk_catalog,
    string $pk_schema,
    string $pk_table,
    string $fk_catalog,
    string $fk_schema,
    string $fk_table
): resource|false

Recupera uma lista de chaves estrangeiras na tabela especificada ou uma lista de chaves estrangeiras em outras tabelas que se referem à chave primária na tabela especificada.

Parâmetros

odbc: O identificador da conexão ODBC. Consulte odbc_connect() para obter detalhes.
pk_catalog: O catálogo ('qualifier' na linguagem ODBC 2) da tabela da chave primária.
pk_schema: O esquema ('owner' no jargão do ODBC 2) da tabela da chave primária.
pk_table: A tabela de chave primária.
fk_catalog: O catálogo ('qualifier' na linguagem ODBC 2) da tabela da chave estrangeira.
fk_schema: O esquema ('owner' no jargão do ODBC 2) da tabela da chave estrangeira.
fk_table: A tabela da chave estrangeira.

Valor Retornado

Retorna um identificador de resultado ODBC ou false em caso de falha.

O conjunto de resultados possui as seguintes colunas:

PKTABLE_CAT
PKTABLE_SCHEM
PKTABLE_NAME
PKCOLUMN_NAME
FKTABLE_CAT
FKTABLE_SCHEM
FKTABLE_NAME
FKCOLUMN_NAME
KEY_SEQ
UPDATE_RULE
DELETE_RULE
FK_NAME
PK_NAME
DEFERRABILITY

Drivers podem listar colunas adicionais.

Se as chaves estrangeiras associadas a uma chave primária forem solicitadas, o conjunto de resultados será ordenado por FKTABLE_CAT, FKTABLE_SCHEM, FKTABLE_NAME e KEY_SEQ. Se as chaves primárias associadas a uma chave estrangeira forem solicitadas, o conjunto de resultados será ordenado por PKTABLE_CAT, PKTABLE_SCHEM, PKTABLE_NAME e KEY_SEQ.

Se pk_table contiver um nome de tabela, odbc_foreignkeys() retornará um conjunto de resultados contendo a chave primária da tabela especificada e todas as chaves estrangeiras que se referem a ela.

Se fk_table contiver um nome de tabela, odbc_foreignkeys() retornará um conjunto de resultados contendo todas as chaves estrangeiras na tabela especificada e as chaves primárias (em outras tabelas) às quais elas se referem.

Se ambos pk_table e fk_table contiverem nomes de tabelas, odbc_foreignkeys() retornará as chaves estrangeiras na tabela especificada em fk_table que se referem à chave primária da tabela especificada em pk_table. Esta deve ser uma chave no máximo.

Veja Também

odbc_tables() - Obtém a lista de nomes de tabelas armazenadas em uma fonte de dados específica
odbc_primarykeys() - Obtém as chaves primárias de uma tabela