mysql_list_fields

(PHP 4, PHP 5)

mysql_list_fields — MySQL テーブルのフィールドのリストを得る

警告

この関数は PHP 5.4.0 で非推奨になり、PHP 7.0.0 で MySQL 拡張モジュール全体とあわせて削除されました。 MySQLi あるいは PDO_MySQL を使うべきです。詳細な情報は MySQL: API の選択を参照ください。この関数の代替として、これらが使えます。

SQL クエリー: SHOW COLUMNS FROM sometable

説明

mysql_list_fields(string $database_name, string $table_name, resource $link_identifier = NULL): resource

指定された名前のテーブルについての情報を取得します。

この関数は非推奨です。かわりに mysql_query() を利用して SHOW COLUMNS FROM table [LIKE 'name'] 文を発行することを推奨します。

パラメータ

database_name: クエリの対象となるデータベース名。
table_name: クエリの対象となるテーブル名。
link_identifier: MySQL 接続。指定されない場合、mysql_connect() により直近にオープンされたリンクが指定されたと仮定されます。そのようなリンクがない場合、引数を指定せずに mysql_connect() がコールした時と同様にリンクを確立します。リンクが見付からない、または、確立できない場合、E_WARNING レベルのエラーが生成されます。

戻り値

成功した場合に結果ポインタ resource 、失敗した場合に false を返します。

返された結果は mysql_field_flags(), mysql_field_len(), mysql_field_name() そして mysql_field_type() で利用可能です。

例

例1 非推奨である mysql_list_fields() の代替例

<?php
$result = mysql_query("SHOW COLUMNS FROM sometable");
if (!$result) {
    echo 'Could not run query: ' . mysql_error();
    exit;
}
if (mysql_num_rows($result) > 0) {
    while ($row = mysql_fetch_assoc($result)) {
        print_r($row);
    }
}
?>

上の例の出力は、たとえば以下のようになります。

Array
(
    [Field] => id
    [Type] => int(7)
    [Null] =>  
    [Key] => PRI
    [Default] =>
    [Extra] => auto_increment
)
Array
(
    [Field] => email
    [Type] => varchar(100)
    [Null] =>
    [Key] =>
    [Default] =>
    [Extra] =>
)

注意

注意:
下位互換のために、次の非推奨別名を使用してもいいでしょう。 mysql_listfields()

参考

mysql_field_flags() - 結果において指定したフィールドのフラグを取得する
mysql_info() - 直近のクエリについての情報を得る

Found A Problem?

Learn How To Improve This Page • Submit a Pull Request • Report a Bug

＋add a note

User Contributed Notes 3 notes

down

mbevan at marginsoftware dot com ¶

21 years ago

If you're willing to use a lot of functions to get a little information about fields in a table, this function is for you.  If you just want to get all the information you can find, you can use this:

<?php

// Taken from: http://ca.php.net/manual/en/function.mysql-field-flags.php
// Original by: amir at scrounch dot com
// Returns the name of the fields in the primary key for a table.
// Also keeps the fields in KEY order.  Handy.
function getPrimaryKeyOf($table) { 
  $keys = Array();

  $query = sprintf("SHOW KEYS FROM `%s`", $table);
  $result = mysql_query($query) or die(mysql_error());

  while ($row = mysql_fetch_assoc($result)) {
    if ( $row['Key_name'] == 'PRIMARY' )
      $keys[$row['Seq_in_index'] - 1] = $row['Column_name'];
  }

  return $keys;
}

// Returns a bunch of information about a table...
// The name of the auto-increment field, if any, fields in the
// primary key (using the function above), and all information
// about all fields.
function getTableInformationOf($table) {
  $information = array(
      "auto"    => "",
      "primary" => array(),
      "fields"  => array()
    );

  $information['primary'] = $this->getPrimaryKeyOf($table);

  $result = mysql_query("DESC `$table`");
  while ( $field = mysql_fetch_assoc($result) ) {
    $information['fields'][] = $field;
    if ( $field['Extra'] == "auto_increment" )
      $information['auto'] = $field['Field'];
  }

  return $information;
}

?>

down

rhyous at yahoo dot com ¶

19 years ago

To make an array containing the names of a column from a table, you use the following simple script: (Note: using table1 with three columns)



<?php

$qColumnNames = mysql_query("SHOW COLUMNS FROM table1",$db) or die("mysql error");

$numColumns = mysql_num_rows($qColumnNames);

$x = 0;

while ($x < $numColumns)

{

    $colname = mysql_fetch_row($qColumnNames);

    $col[$colname[0]] = $colname[0];

    $x++;

}



print_r($col);



/* it will have the following output

Array (

[firstcolumn] => firstcolumn

[secondcolumn] => secondcolumn

[thirdcolumn] => thirdcolumn

)

*/

?>



Or you can number the columns from zero.  This help when using it in conjunction with mysql_fetch_row to get an array.  You don't have to remember which number of the array a certain column is.



<?php

$qColumnNames = mysql_query("SHOW COLUMNS FROM table1",$db) or die("mysql error");

$numColumns = mysql_num_rows($qColumnNames);

$x = 0;

while ($x < $numColumns)

{

    $colname = mysql_fetch_row($qColumnNames);

    $col[$colname[0]] = $x;

    $x++;

}



print_r($col);



/* it will have the following output

Array (

[firstcolumn] => 0

[secondcolumn] => 1

[thirdcolumn] => 2

)

*/

?>



To use it in conjuction with mysql_fetch_row:



<?php

$row = mysql_fetch_row("SELECT * from table1",$db) or die("mysql error");

?>



You can now call $row[col[firstcolumn]].  This becomes useful when you have a lot of columns.

down

-3

phpflow at gmail dot com ¶

12 years ago

Below script is used to get all coloumn indormation of an table.When we are working custome ORM then we need to match the coloumn name with array keys.



<?php

function getColoumn($table) {

     $result = mysql_query("SHOW COLUMNS FROM ". $table);

      if (!$result) {

        echo 'Could not run query: ' . mysql_error();

      }

      $fieldnames=array();

      if (mysql_num_rows($result) > 0) {

        while ($row = mysql_fetch_assoc($result)) {

          $fieldnames[] = $row['Field'];

        }

      }



      return $fieldnames;

}

?>

＋add a note