odbc_procedures

(PHP 4, PHP 5, PHP 7, PHP 8)

odbc_proceduresObtém a lista de procedimentos armazenados em uma fonte de dados específica

Descrição

odbc_procedures(
    resource $odbc,
    ?string $catalog = null,
    ?string $schema = null,
    ?string $procedure = null
): resource|false

Lista todos os procedimentos no intervalo solicitado.

Parâmetros

odbc

O identificador da conexão ODBC. Consulte odbc_connect() para obter detalhes.

catalog

O catálogo ('qualifier' na linguagem ODBC 2).

schema

O esquema ('owner' na linguagem ODBC 2). Este parâmetro aceita os seguintes padrões de pesquisa: % para corresponder a zero ou mais caracteres e _ para corresponder a um único caractere.

procedure

O nome. Este parâmetro aceita os seguintes padrões de pesquisa: % para corresponder a zero ou mais caracteres e _ para corresponder a um único caractere.

Valor Retornado

Retorna um identificador de resultado ODBC contendo as informações ou false em caso de falha.

O conjunto de resultados possui as seguintes colunas:

  • PROCEDURE_CAT
  • PROCEDURE_SCHEM
  • PROCEDURE_NAME
  • NUM_INPUT_PARAMS
  • NUM_OUTPUT_PARAMS
  • NUM_RESULT_SETS
  • REMARKS
  • PROCEDURE_TYPE
Drivers podem listar colunas adicionais.

O conjunto de resultados é ordenado por PROCEDURE_CAT, PROCEDURE_SCHEMA e PROCEDURE_NAME.

Registro de Alterações

Versão Descrição
8.0.0 Antes desta versão, a função só podia ser chamada com um ou quatro argumentos.

Exemplos

Example #1 Lista procedimentos armazenados de um banco de dados

<?php
$conn = odbc_connect($dsn, $user, $pass);
$procedures = odbc_procedures($conn, $catalog, $schema, '%');
while (($row = odbc_fetch_array($procedures))) {
    print_r($row);
    break; // outras linhas omitidas por questões de brevidade
}
?>

O exemplo acima produzirá algo semelhante a:

Array
(
    [PROCEDURE_CAT] => TutorialDB
    [PROCEDURE_SCHEM] => dbo
    [PROCEDURE_NAME] => GetEmployeeSalesYTD;1
    [NUM_INPUT_PARAMS] => -1
    [NUM_OUTPUT_PARAMS] => -1
    [NUM_RESULT_SETS] => -1
    [REMARKS] =>
    [PROCEDURE_TYPE] => 2
)

Veja Também

  • odbc_procedurecolumns() - Recupera informações sobre parâmetros para procedimentos
  • odbc_tables() - Obtém a lista de nomes de tabelas armazenadas em uma fonte de dados específica