cubrid_schema
(PECL CUBRID >= 8.3.0)
cubrid_schema — Récupère des informations sur un schéma
Description
$conn_identifier
, int $schema_type
[, string $class_name
[, string $attr_name
]] )
La fonction cubrid_schema() est utilisée pour
récupérer des informations d'un schéma depuis la base de données.
Vous devez désigner le paramètre class_name
,
si vous voulez récupérer les informations d'une classe particulière,
attr_name
si vous voulez récupérer des
informations sur un attribut particulier (ne peut être utilisé qu'avec
CUBRID_ SCH_ATTR_PRIVILEGE).
Le résultat de la fonction est retourné sous la forme d'un tableau à 2 dimensions (colonne (tableau associatif) * lignes (tableau numérique)). Les tables suivantes montrent les types d'un schéma ainsi que la structure d'une colonne du tableau résultant, suivant le type de schéma demandé.
Schéma | Numéro de colonne | Nom de la colonne | Valeur |
---|---|---|---|
CUBRID_SCH_CLASS | 1 | NAME | |
2 | TYPE | 0:system class 1:vclass 2:class | |
CUBRID_SCH_VCLASS | 1 | NAME | |
2 | TYPE | 1:vclass | |
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:indexed | |
6 | NOT NULL | 1:not null | |
7 | SHARED | 1:shared | |
8 | UNIQUE | 1:unique | |
9 | DEFAULT | ||
10 | ATTR_ORDER | base:1 | |
11 | CLASS_NAME | ||
12 | SOURCE_CLASS | ||
13 | IS_KEY | 1:key | |
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:system class 1:vclass 2:class | |
CUBRID_SCH_CONSTRAINT | 1 | TYPE | 0:unique 1:index 2:reverse unique 3:reverse index |
2 | NAME | ||
3 | ATTR_NAME | ||
4 | NUM_PAGES | ||
5 | NUM_KEYS | ||
6 | PRIMARY_KEY | 1:primary key | |
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:cascade 1:restrict 2:no action 3:set null | |
7 | DELETE_ACTION | 0:cascade 1:restrict 2:no action 3:set null | |
8 | FK_NAME | ||
9 | PK_NAME |
Liste de paramètres
-
conn_identifier
-
Identifiant de connexion.
-
schema_type
-
Données du schéma à récupérer.
-
class_name
-
Classe pour laquelle vous souhaitez connaître le schéma.
-
attr_name
-
Attribut pour lequel vous souhaitez connaître le schéma.
Valeurs de retour
Un tableau contenant les informations sur le schéma en cas de succès.
FALSE
en cas d'échec.
Historique
Version | Description |
---|---|
8.3.1 |
Modification de la valeur retournée : lorsque la fonction échoue,
la valeur retournée est maintenant FALSE au lieu de -1.
|
Exemples
Exemple #1 Exemple avec cubrid_schema()
<?php $conn = cubrid_connect("localhost", 33000, "demodb", "dba"); printf("\n--- Primary Key ---\n"); $pk = cubrid_schema($conn, CUBRID_SCH_PRIMARY_KEY, "game"); var_dump($pk); printf("\n--- Foreign Keys ---\n"); $fk = cubrid_schema($conn, CUBRID_SCH_IMPORTED_KEYS, "game"); var_dump($fk); printf("\n--- Column Attribute ---\n"); $attr = cubrid_schema($conn, CUBRID_SCH_ATTRIBUTE, "stadium", "area"); var_dump($attr); cubrid_disconnect($conn); ?>
L'exemple ci-dessus va afficher :
--- Primary Key --- 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" } } --- Foreign Keys --- 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" } } --- Column Attribute --- 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" } }