mysqli_result::fetch_fields

    mysqli_fetch_fields

    (PHP 5, PHP 7, PHP 8)

    mysqli_result::fetch_fields -- mysqli_fetch_fields — Retorna um array de objetos representando os campos em um conjunto de resultados

    Descrição

    Estilo orientado a objetos

    public mysqli_result::fetch_fields(): array

    Estilo procedural

    mysqli_fetch_fields(mysqli_result $result): array

    Esta função serve para o mesmo propósito que a função mysqli_fetch_field() com uma simples diferença, ao invés de retornar um objeto de cada vez para cada campo, as colunas são retornadas como um array de objetos.

    Parâmetros

    result

    Somente no estilo procedural: Um objeto mysqli_result retornado por mysqli_query(), mysqli_store_result(), mysqli_use_result() ou mysqli_stmt_get_result().

    Valor Retornado

    Retorna um array de objetos contendo informações de definições de campo.

    Propriedades dos objetos
    Propriedade Descrição
    name O nome da coluna
    orgname O nome original da coluna se foi especificado um apelido
    table O nome da tabela à qual o campo pertence (se não calculado)
    orgtable Nome da tabela original se foi especificado um apelido
    def Não utilizado. Sempre uma string vazia
    db O nome do banco de dados
    catalog Não utilizado. Sempre "def"
    max_length A largura máxima do campo para o conjunto de resultados. A partir do PHP 8.1, este valor é sempre 0.
    length O comprimento do campo em bytes. Para colunas de strings, o valor do comprimento varia conforme o conjunto de caracteres. Por exemplo, se o conjunto de caracteres for latin1, um conjunto de um byte, o valor de comprimento para uma consulta SELECT 'abc' será 3. Se o conjunto for utf8mb4, um conjunto multi-bytes onde os caracteres podem ter até 4 bytes, o valor de comprimento será 12.
    charsetnr O número do conjunto de caracteres do campo.
    flags Um inteiro representando bits de opções para o campo.
    type O tipo de dados usado para este campo
    decimals O número de decimais para campos numéricos, e a precisão em segundos fracionários para campos temporais.

    Exemplos

    Exemplo #1 Estilo orientado a objetos

    <?php
    $mysqli     = new mysqli("127.0.0.1", "root", "foofoo", "sakila");

    /*verifica a conexão */
    if ($mysqli->connect_errno) {
    printf("Conexão falhou: %s\n", $mysqli->connect_error);
    exit();
    }

    foreach (array(    'latin1', 'utf8') as $charset) {

    // Define o conjunto de caracteres, para mostrar seu impacto em alguns valores (ex.: comprimento em bytes)
    $mysqli->set_charset($charset);

    $query = "SELECT actor_id, last_name from actor ORDER BY actor_id";

    echo     "======================\n";
    echo     "Conjunto de Caracteres: $charset\n";
    echo     "======================\n";

    if (    $result = $mysqli->query($query)) {

    /* Obtém informação de campo para todas as colunas */
    $finfo = $result->fetch_fields();

    foreach (    $finfo as $val) {
    printf("Nome: %s\n", $val->name);
    printf("Tabela: %s\n", $val->table);
    printf("Comp. máx: %d\n", $val->max_length);
    printf("Comprimento: %d\n", $val->length);
    printf("Id conj. carac: %d\n", $val->charsetnr);
    printf("Opções: %d\n", $val->flags);
    printf("Tipo: %d\n\n", $val->type);
    }
    $result->free();
    }
    }
    $mysqli->close();
    ?>

    Exemplo #2 Estilo procedural

    <?php
    $link     = mysqli_connect("127.0.0.1", "my_user", "my_password", "sakila");

    /*verifica a conexão */
    if (mysqli_connect_errno()) {
    printf("Conexão falhou: %s\n", mysqli_connect_error());
    exit();
    }

    foreach (array(    'latin1', 'utf8') as $charset) {

    // Define o conjunto de caracteres, para mostrar seu impacto em alguns valores (ex.: comprimento em bytes)
    mysqli_set_charset($link, $charset);

    $query = "SELECT actor_id, last_name from actor ORDER BY actor_id";

    echo     "======================\n";
    echo     "Conjunto de Caracteres: $charset\n";
    echo     "======================\n";

    if (    $result = mysqli_query($link, $query)) {

    /* Obtém informação de campo para todas as colunas */
    $finfo = mysqli_fetch_fields($result);

    foreach (    $finfo as $val) {
    printf("Nome: %s\n", $val->name);
    printf("Tabela: %s\n", $val->table);
    printf("Comp. máx: %d\n", $val->max_length);
    printf("Comprimento: %d\n", $val->length);
    printf("Id conj. carac: %d\n", $val->charsetnr);
    printf("Opções: %d\n", $val->flags);
    printf("Tipo: %d\n\n", $val->type);
    }
    mysqli_free_result($result);
    }
    }

    mysqli_close($link);
    ?>

    Os exemplos acima produzirão:

    ======================
Conjunto de Caracteres: latin1
======================
Nome:        actor_id
Tabela:      actor
Comp. máx:   3
Comprimento: 5
Id conj. carac: 63
Opções:      49699
Tipo:        2

Nome:        last_name
Tabela:      actor
Comp. máx:   12
Comprimento: 45
Id conj. carac: 8
Opções:      20489
Tipo:        253

======================
Conjunto de Caracteres: utf8
======================
Nome:        actor_id
Tabela:      actor
Comp. máx:   3
Comprimento: 5
Id conj. carac: 63
Opções:      49699
Tipo:        2

Nome:        last_name
Tabela:      actor
Comp. máx:   12
Comprimento: 135
Id conj. carac: 33
Opções:      20489

    Veja Também

    Melhore Esta Página

    Aprenda Como Melhorar Esta Página • Envie uma Solicitação de Modificação • Reporte um Problema
    ＋adicionar nota

    Notas de Usuários 6 notes

    up
    16
    AndrewRoz
    14 years ago
    The field info bit-flags used by MySql are:
    (Thanks to ragtag at hotmail dot com)
    <?php
    /*
    NOT_NULL_FLAG = 1
    PRI_KEY_FLAG = 2
    UNIQUE_KEY_FLAG = 4
    BLOB_FLAG = 16
    UNSIGNED_FLAG = 32
    ZEROFILL_FLAG = 64
    BINARY_FLAG = 128
    ENUM_FLAG = 256
    AUTO_INCREMENT_FLAG = 512
    TIMESTAMP_FLAG = 1024
    SET_FLAG = 2048
    NUM_FLAG = 32768
    PART_KEY_FLAG = 16384
    GROUP_FLAG = 32768
    UNIQUE_FLAG = 65536
    */

    // To test if a flag is set you can use & like so:

    $meta = $mysqli_result_object->fetch_field();
    if (    $meta->flags & 4) {
    echo     'Unique key flag is set';
    }
    ?>
    up
    6
    andre at koethur dot de
    11 years ago
    Here are two methods for converting the 'type' and 'flags' attributes to text for debugging purposes. They both use the predefined MYSQLI_ constants to generate the text.

    <?php

    public static function h_type2txt($type_id)
    {
    static     $types;

    if (!isset(    $types))
    {
    $types = array();
    $constants = get_defined_constants(true);
    foreach (    $constants['mysqli'] as $c => $n) if (preg_match('/^MYSQLI_TYPE_(.*)/', $c, $m)) $types[$n] = $m[1];
    }

    return     array_key_exists($type_id, $types)? $types[$type_id] : NULL;
    }

    public static function     h_flags2txt($flags_num)
    {
    static     $flags;

    if (!isset(    $flags))
    {
    $flags = array();
    $constants = get_defined_constants(true);
    foreach (    $constants['mysqli'] as $c => $n) if (preg_match('/MYSQLI_(.*)_FLAG$/', $c, $m)) if (!array_key_exists($n, $flags)) $flags[$n] = $m[1];
    }

    $result = array();
    foreach (    $flags as $n => $t) if ($flags_num & $n) $result[] = $t;
    return     implode(' ', $result);
    }

    ?>
    up
    4
    mccharles dot craven at dot dot gov
    9 years ago
    Those wanting to map the 'type' field in this function for use in mysqli_stmt_bind_param or to cannibalize it for their own mapping may find this function useful.

    function map_field_type_to_bind_type($field_type)
    {
    switch ($field_type)
    {
    case MYSQLI_TYPE_DECIMAL:
    case MYSQLI_TYPE_NEWDECIMAL:
    case MYSQLI_TYPE_FLOAT:
    case MYSQLI_TYPE_DOUBLE:
    return 'd';

    case MYSQLI_TYPE_BIT:
    case MYSQLI_TYPE_TINY:
    case MYSQLI_TYPE_SHORT:
    case MYSQLI_TYPE_LONG:
    case MYSQLI_TYPE_LONGLONG:
    case MYSQLI_TYPE_INT24:
    case MYSQLI_TYPE_YEAR:
    case MYSQLI_TYPE_ENUM:
    return 'i';

    case MYSQLI_TYPE_TIMESTAMP:
    case MYSQLI_TYPE_DATE:
    case MYSQLI_TYPE_TIME:
    case MYSQLI_TYPE_DATETIME:
    case MYSQLI_TYPE_NEWDATE:
    case MYSQLI_TYPE_INTERVAL:
    case MYSQLI_TYPE_SET:
    case MYSQLI_TYPE_VAR_STRING:
    case MYSQLI_TYPE_STRING:
    case MYSQLI_TYPE_CHAR:
    case MYSQLI_TYPE_GEOMETRY:
    return 's';

    case MYSQLI_TYPE_TINY_BLOB:
    case MYSQLI_TYPE_MEDIUM_BLOB:
    case MYSQLI_TYPE_LONG_BLOB:
    case MYSQLI_TYPE_BLOB:
    return 'b';

    default:
    trigger_error("unknown type: $field_type");
    return 's';
    }
    }
    up
    3
    educarme at adinet dot com dot uy
    11 years ago
    Codigos de tipos de datos devueltos por fetch_fields()

    Nombre Codigo
    tinyint_ 1
    boolean_ 1
    smallint_ 2
    int_ 3
    float_ 4
    double_ 5
    real_ 5
    timestamp_ 7
    bigint_ 8
    serial 8
    mediumint_ 9
    date_ 10
    time_ 11
    datetime_ 12
    year_ 13
    bit_ 16
    decimal_ 246
    text_ 252
    tinytext_ 252
    mediumtext_ 252
    longtext_ 252
    tinyblob_ 252
    mediumblob_ 252
    blob_ 252
    longblob_ 252
    varchar_ 253
    varbinary_ 253
    char_ 254
    binary_ 254
    up
    -1
    cz dot paranoiq at gmail dot com
    10 years ago
    complete list of flags from MySQL source code:

    NOT_NULL_FLAG 1 /* Field can't be NULL */
    PRI_KEY_FLAG 2 /* Field is part of a primary key */
    UNIQUE_KEY_FLAG 4 /* Field is part of a unique key */
    MULTIPLE_KEY_FLAG 8 /* Field is part of a key */
    BLOB_FLAG 16 /* Field is a blob */
    UNSIGNED_FLAG 32 /* Field is unsigned */
    ZEROFILL_FLAG 64 /* Field is zerofill */
    BINARY_FLAG 128 /* Field is binary */
    ENUM_FLAG 256 /* field is an enum */
    AUTO_INCREMENT_FLAG 512 /* field is a autoincrement field */
    TIMESTAMP_FLAG 1024 /* Field is a timestamp */
    SET_FLAG 2048 /* field is a set */
    NO_DEFAULT_VALUE_FLAG 4096 /* Field doesn't have default value */
    ON_UPDATE_NOW_FLAG 8192 /* Field is set to NOW on UPDATE */
    NUM_FLAG 32768 /* Field is num (for clients) */
    PART_KEY_FLAG 16384 /* Intern; Part of some key */
    GROUP_FLAG 32768 /* Intern: Group field */
    UNIQUE_FLAG 65536 /* Intern: Used by sql_yacc */
    BINCMP_FLAG 131072 /* Intern: Used by sql_yacc */
    GET_FIXED_FIELDS_FLAG (1 << 18) /* Used to get fields in item tree */
    FIELD_IN_PART_FUNC_FLAG (1 << 19)/* Field part of partition func */
    up
    -2
    attand at gmail dot com
    7 years ago
    The nax_length gives counts in bytes. So if the text is utf-8, then we get incorrect result.

    We have a code snippet where we check if the maximum length of the field and the max length of data stored becomes equal. This way we can check the potential truncation of data inserted
    ＋adicionar nota
    To Top