sql_showtable

La fonction sql_showtable() retourne une description d’une table SQL dans un tableau associatif listant les colonnes et leurs descriptions SQL (« field ») et listant les clés (« key »). Lorsqu’une déclaration de jointure est présente pour la table déclarée dans tables_principales ou tables_auxiliaires, le tableau la retourne également dans la clé « join ».

Ses paramètres sont :

  1. $table est le nom de la table à interroger,
  2. $table_spip permet de remplacer automatiquement « spip » par le vrai préfixe de table ; il vaut false par défaut,
  3. $serveur,
  4. $option

Utilisation :

$desc = sql_showtable('spip_articles', true);
// $desc['field']['id_article']  = "bigint(21) NOT NULL AUTO_INCREMENT"
// $desc['key']['PRIMARY KEY']  = "id_article"
// $desc['join']['id_article']  = "id_article"

Dans la plupart des situations, il vaut mieux utiliser directement la fonction trouver_table, qui possède un cache sur la structure des données, utilise cette fonction sql_showtable() et ajoute des informations supplémentaires.

$trouver_table = charger_fonction('trouver_table', 'base');
$desc = $trouver_table('spip_articles');

Auteur Matthieu Marcillaud Publié le : Mis à jour : 16/05/10

Traductions : English, français