PHP 8.4.0 RC2 available for testing

cubrid_schema

(PECL CUBRID >= 8.3.0)

cubrid_schemaObtém informação do esquema solicitado

Descrição

cubrid_schema(
    resource $conn_identifier,
    int $schema_type,
    string $class_name = ?,
    string $attr_name = ?
): array

A função cubrid_schema() é usada para obter as informações do esquema solicitadas do banco de dados. Para obter informações sobre uma classe específica, class_name deve ser definido, para obter informações sobre um atributo específico (pode ser usada apenas com CUBRID_SCH_ATTR_PRIVILEGE), attr_name deve ser definido.

O resultado da função cubrid_schema() é retornado como um array bidimensional (coluna (array associativo) * linha (array numérico)). As tabelas a seguir mostram os tipos de esquema e a estrutura da coluna do array de resultados a ser retornada com base no tipo de esquema.

Composição do resultado de cada tipo
Esquema Número da Coluna Nome da Coluna Valor
CUBRID_SCH_CLASS 1 NAME  
  2 TYPE 0:classe de sistema 1:classe virtual 2:classe
CUBRID_SCH_VCLASS 1 NAME  
  2 TYPE 1:classe virtual
CUBRID_SCH_QUERY_SPEC 1 QUERY_SPEC  
CUBRID_SCH_ATTRIBUTE / CUBRID_SCH_CLASS_ATTRIBUTE 1 ATTR_NAME  
  2 DOMAIN  
  3 SCALE  
  4 PRECISION  
  5 INDEXED 1:indexado
  6 NOT NULL 1:não nulo
  7 SHARED 1:compartilhado
  8 UNIQUE 1:exclusivo
  9 DEFAULT  
  10 ATTR_ORDER base:1
  11 CLASS_NAME  
  12 SOURCE_CLASS  
  13 IS_KEY 1:chave
CUBRID_SCH_METHOD / CUBRID_SCH_CLASS_METHOD 1 NAME  
  2 RET_DOMAIN  
  3 ARG_DOMAIN  
CUBRID_SCH_METHOD_FILE 1 METHOD_FILE  
CUBRID_SCH_SUPERCLASS / CUBRID_SCH_DIRECT_SUPER_CLASS / CUBRID_SCH_SUBCLASS 1 CLASS_NAME  
  2 TYPE 0:classe de sistema 1:classe virtual 2:classe
CUBRID_SCH_CONSTRAINT 1 TYPE 0:exclusivo 1:índice 2:exclusivo reverso 3:índice reverso
  2 NAME  
  3 ATTR_NAME  
  4 NUM_PAGES  
  5 NUM_KEYS  
  6 PRIMARY_KEY 1:chave primária
  7 KEY_ORDER base:1
CUBRID_SCH_TRIGGER 1 NAME  
  2 STATUS  
  3 EVENT  
  4 TARGET_CLASS  
  5 TARGET_ATTR  
  6 ACTION_TIME  
  7 ACTION  
  8 PRIORITY  
  9 CONDITION_TIME  
  10 CONDITION  
CUBRID_SCH_CLASS_PRIVILEGE / CUBRID_SCH_ATTR_PRIVILEGE 1 CLASS_NAME / ATTR_NAME  
  2 PRIVILEGE  
  3 GRANTABLE  
CUBRID_SCH_PRIMARY_KEY 1 CLASS_NAME  
  2 ATTR_NAME  
  3 KEY_SEQ base:1
  4 KEY_NAME  
CUBRID_SCH_IMPORTED_KEYS / CUBRID_SCH_EXPORTED_KEYS / CUBRID_SCH_CROSS_REFERENCE 1 PKTABLE_NAME  
  2 PKCOLUMN_NAME  
  3 FKTABLE_NAME base:1
  4 FKCOLUMN_NAME  
  5 KEY_SEQ base:1
  6 UPDATE_ACTION 0:cascata 1:restrição 2:sem ação 3:definir como nulo
  7 DELETE_ACTION 0:cascata 1:restrição 2:sem ação 3:definir como nulo
  8 FK_NAME  
  9 PK_NAME  

Parâmetros

conn_identifier

Identificador da conexão.

schema_type

Dados do esquema que precisam ser conhecidos.

class_name

Classe da qual deseja-se conhecer o esquema.

attr_name

Atributo do qual deseja-se conhecer o esquema.

Valor Retornado

Array contendo a informação do esquema em caso de sucesso, ou false em caso de falha.

Registro de Alterações

Versão Descrição
8.3.1 Alterado valor de retorno: quando houver falha, retorna false e não -1.

Exemplos

Exemplo #1 Exemplo de cubrid_schema()

<?php
$conn
= cubrid_connect("localhost", 33000, "demodb", "dba");

printf("\n--- Chave Primária ---\n");
$pk = cubrid_schema($conn, CUBRID_SCH_PRIMARY_KEY, "game");
var_dump($pk);

printf("\n--- Chaves Estrangeiras ---\n");
$fk = cubrid_schema($conn, CUBRID_SCH_IMPORTED_KEYS, "game");
var_dump($fk);

printf("\n--- Atributo da Coluna ---\n");
$attr = cubrid_schema($conn, CUBRID_SCH_ATTRIBUTE, "stadium", "area");
var_dump($attr);

cubrid_disconnect($conn);
?>

O exemplo acima produzirá:

--- Chave Primária ---
array(3) {
  [0]=>
  array(4) {
    ["CLASS_NAME"]=>
    string(4) "game"
    ["ATTR_NAME"]=>
    string(12) "athlete_code"
    ["KEY_SEQ"]=>
    string(1) "3"
    ["KEY_NAME"]=>
    string(41) "pk_game_host_year_event_code_athlete_code"
  }
  [1]=>
  array(4) {
    ["CLASS_NAME"]=>
    string(4) "game"
    ["ATTR_NAME"]=>
    string(10) "event_code"
    ["KEY_SEQ"]=>
    string(1) "2"
    ["KEY_NAME"]=>
    string(41) "pk_game_host_year_event_code_athlete_code"
  }
  [2]=>
  array(4) {
    ["CLASS_NAME"]=>
    string(4) "game"
    ["ATTR_NAME"]=>
    string(9) "host_year"
    ["KEY_SEQ"]=>
    string(1) "1"
    ["KEY_NAME"]=>
    string(41) "pk_game_host_year_event_code_athlete_code"
  }
}

--- Chaves Estrangeiras ---
array(2) {
  [0]=>
  array(9) {
    ["PKTABLE_NAME"]=>
    string(7) "athlete"
    ["PKCOLUMN_NAME"]=>
    string(4) "code"
    ["FKTABLE_NAME"]=>
    string(4) "game"
    ["FKCOLUMN_NAME"]=>
    string(12) "athlete_code"
    ["KEY_SEQ"]=>
    string(1) "1"
    ["UPDATE_RULE"]=>
    string(1) "1"
    ["DELETE_RULE"]=>
    string(1) "1"
    ["FK_NAME"]=>
    string(20) "fk_game_athlete_code"
    ["PK_NAME"]=>
    string(15) "pk_athlete_code"
  }
  [1]=>
  array(9) {
    ["PKTABLE_NAME"]=>
    string(5) "event"
    ["PKCOLUMN_NAME"]=>
    string(4) "code"
    ["FKTABLE_NAME"]=>
    string(4) "game"
    ["FKCOLUMN_NAME"]=>
    string(10) "event_code"
    ["KEY_SEQ"]=>
    string(1) "1"
    ["UPDATE_RULE"]=>
    string(1) "1"
    ["DELETE_RULE"]=>
    string(1) "1"
    ["FK_NAME"]=>
    string(18) "fk_game_event_code"
    ["PK_NAME"]=>
    string(13) "pk_event_code"
  }
}

--- Atributo da Coluna ---
array(1) {
  [0]=>
  array(13) {
    ["ATTR_NAME"]=>
    string(4) "area"
    ["DOMAIN"]=>
    string(1) "7"
    ["SCALE"]=>
    string(1) "2"
    ["PRECISION"]=>
    string(2) "10"
    ["INDEXED"]=>
    string(1) "0"
    ["NON_NULL"]=>
    string(1) "0"
    ["SHARED"]=>
    string(1) "0"
    ["UNIQUE"]=>
    string(1) "0"
    ["DEFAULT"]=>
    NULL
    ["ATTR_ORDER"]=>
    string(1) "4"
    ["CLASS_NAME"]=>
    string(7) "stadium"
    ["SOURCE_CLASS"]=>
    string(7) "stadium"
    ["IS_KEY"]=>
    string(1) "0"
  }
}
add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top