Show MySQL tables, column names, types and more with PHP
Showing a MySQL database tables with their columns, type, keys and more is done using the MySQL SHOW syntax. For the tables SHOW TABLES is used whilst to get the details about the columns for individual tables SHOW COLUMNS.
First step is creating the PDO MySQL connection and then defining the database that the information will be retrieved from
setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); $database = 'users';//Database $show_tables = $db->prepare("SHOW TABLES;"); $show_tables->execute(); while ($data = $show_tables->fetch(PDO::FETCH_ASSOC)) < $table = $data["Tables_in_$database"];//Table name . This will loop through all the tables in the database user
Next another query gets built into this loop that goes through each of the tables getting the column names, types, keys, defaults and more
prepare("SHOW COLUMNS FROM $table;"); $show_cols->execute(); while ($col = $show_cols->fetch(PDO::FETCH_ASSOC)) < $name = $col['Field']; . View what gets returned from the show columns command here.
Finally getting creating an output and making its readability somewhat decent can be seen like this WordPress database with the full code below the image;
body < background-color: #313233; color: #e2e3e5; font-family: Verdana, Geneva, sans-serif; font-size: 0.95rem; >.table-name < font-size: 1.2rem; margin-bottom: 0.3rem; >.db-table < margin-left: 0.5rem; >.type < color: #abccff; >.null < color: #ffb0a5; font-style: italic; >.key < color: #dcffac; >.default < color: #9cffeb; >.extra setAttribute(PDO::ATTR_ERRMODE, PDO::ERRMODE_EXCEPTION); $database = 'users';//Set database name here $show_tables = $db->prepare("SHOW TABLES;"); $show_tables->execute(); while ($data = $show_tables->fetch(PDO::FETCH_ASSOC)) < $table = $data["Tables_in_$database"]; echo "$table
"; $show_cols = $db->prepare("SHOW COLUMNS FROM $table;"); $show_cols->execute(); while ($col = $show_cols->fetch(PDO::FETCH_ASSOC)) < if ($col['Null'] == 'YES') < $is_null = 'Is NULL'; >else < $is_null = 'Not NULL'; >$key = $col['Key']; if ($key == 'PRI') < $key_type = 'Primary key'; >elseif ($key == 'UNI') < $key_type = 'Unique key'; >elseif ($key == 'MUL') < $key_type = 'Multi key'; >else < $key_type = '';//No key >echo " " . $col['Field'] . " " . $col['Type'] . " $is_null $key_type " . $col['Default'] . " " . $col['Extra'] . " "; > > ?> mysql_list_fields
Данная функция объявлена устаревшей в PHP 5.4.0, и, вместе с модулем MySQL, удалена PHP в 7.0.0. Вместо неё используйте активно развивающиеся модули MySQLi или PDO_MySQL. Так же смотрите раздел MySQL: выбор API. Альтернативы для этой функции:
Описание
mysql_list_fields ( string $database_name , string $table_name , resource $link_identifier = NULL ): resource
Возвращает информацию о таблице с переданным именем.
Эта функция устарела. Вместо неё рекомендуется использовать mysql_query() с SQL-запросом SHOW COLUMNS FROM table [LIKE 'name'] .
Список параметров
Имя опрашиваемой базы данных.
Соединение 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()
$result = mysql_query ( "SHOW COLUMNS FROM sometable" );
if (! $result ) echo 'Ошибка при выполнении запроса: ' . 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] => Php mysqli list columns => PRI [Default] => [Extra] => auto_increment ) Array ( [Field] => email [Type] => varchar(100) [Null] => Php mysqli list columns => [Default] => [Extra] => )
Примечания
Замечание:
Для обратной совместимости может быть использован следующий устаревший псевдоним: mysql_listfields()
Смотрите также
- mysql_field_flags() - Возвращает флаги, связанные с указанным полем результата запроса
- mysql_info() - Возвращает информацию о последнем запросе
User Contributed Notes 7 notes
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:
// 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' ];
>
// 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' ];
>
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)
$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 ++;
>
/* 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.
$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 ++;
>
/* it will have the following output
Array (
[firstcolumn] => 0
[secondcolumn] => 1
[thirdcolumn] => 2
)
*/
?>
To use it in conjuction with mysql_fetch_row:
$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.
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.
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' ];
>
>
mysql_list_fields() retrieves information about the given table name but you can use something like mysql_fetch_field to retrieve the field names from a result source.
Every my html table output begins with heading row containing the field names. For that purpose I accepted the short combination of MySQL function, giving me a result similar to the mysql_fetch_array() for the row of values. The following example shows the basic idea. It should be adapted for the specific use:
//.
$field_names = array_keys ( mysql_fetch_array ( mysql_query ( $query , $link ), MYSQL_ASSOC ));
//.
?>
The advantage of this is, that it gives the names of the result, neither the field names of the whole table.
Please read the discussion about duplicate field names in SQL result carefully. The use, as shown in the example above, increments the pointer, hence some regular function, which does not, could be more useful 🙂
Note, using mysql_list_fields will change the currently selected database so subsequent mysql_query operations will be on the database in param 1 not the one selected with mysql_select_db
mysql_list_fields
This function was deprecated in PHP 5.4.0, and it and the entire original MySQL extension was removed in PHP 7.0.0. Instead, use either the actively developed MySQLi or PDO_MySQL extensions. See also the MySQL: choosing an API guide and its related FAQ entry for additional information. Alternatives to this function include:
Описание
resource mysql_list_fields ( string $database_name , string $table_name [, resource $link_identifier = NULL ] )
Возвращает информацию о таблице с переданным именем.
Эта функция устарела. Вместо нее рекомендуется использовать mysql_query() с SQL-запросом SHOW COLUMNS FROM table [LIKE 'name'].
Список параметров
Имя опрашиваемой базы данных.
Соединение 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()
$result = mysql_query ( "SHOW COLUMNS FROM sometable" );
if (! $result ) echo 'Ошибка при выполнении запроса: ' . 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] => Php mysqli list columns => PRI [Default] => [Extra] => auto_increment ) Array ( [Field] => email [Type] => varchar(100) [Null] => Php mysqli list columns => [Default] => [Extra] => )
Примечания
Замечание:
Для обратной совместимости может быть использован следующий устаревший псевдоним: mysql_listfields()
Смотрите также
- mysql_field_flags() - Возвращает флаги, связанные с указанным полем результата запроса
- mysql_info() - Возвращает информацию о последнем запросе