pg_field_size - PHP code example

PHP Functions For PostgreSQL

Articles

This PHP function returns the actual printed length (in characters) of a field in a given PostgreSQL result. Its default value is 1 indicating that it returns the actual printed length of the last field in the current row of the result set.

pg_field_name() returns the name of the field occupying the given field_number in the given PostgreSQL query result resource. Alternatively it can return the table's oid if oid_only is True.

PostgreSQL automatically folds all identifiers to lower case, so the function can be used with either upper or lower case field names. It is recommended to use the lower case version of a field name.

pg_result_error_field() returns an error message that includes the primary human-readable error text, position (a decimal integer indicating the cursor position in the result set), SQLSTATE code, and hint. The error message will typically fit on a single line. The optional context field is a list of PostgreSQL source-code functions that were active during the error, and may run to multiple lines.

pg_lo_seek seeks a position within a PostgreSQL large object (LOB) resource. It can be one of the constants PGSQL_SEEK_SET (seek from start), PGSQL_SEEK_CUR (seek from current position) or PGSQL_SEEK_END (seek from end). It will return FALSE on error. To use this function, both the PHP client and the PostgreSQL server must support 64bit large object handling. This function is not documented in the PHP manual and appears only in a few positive search results on GitHub. It might be deprecated in a future version of PHP.

pg_field_size example

$a['affected rows'] = pg_affected_rows($result);
        $a['last OID'] = pg_last_oid($result);

        $fields = pg_num_fields($result);

        for ($i = 0; $i < $fields; ++$i) {
            $field = [
                'name' => pg_field_name($result, $i),
                'table' => sprintf('%s (OID: %s)', pg_field_table($result, $i), pg_field_table($result, $i, true)),
                'type' => sprintf('%s (OID: %s)', pg_field_type($result, $i), pg_field_type_oid($result, $i)),
                'nullable' => (bool) pg_field_is_null($result, $i),
                'storage' => pg_field_size($result, $i).' bytes',
                'display' => pg_field_prtlen($result, $i).' chars',
            ];
            if (' (OID: )' === $field['table']) {
                $field['table'] = null;
            }
            if ('-1 bytes' === $field['storage']) {
                $field['storage'] = 'variable size';
            } elseif ('1 bytes' === $field['storage']) {
                $field['storage'] = '1 byte';
            }
            if ('1 chars' === $field['display']) {

    public function getFieldData(): array
    {
        $retVal = [];

        for ($i = 0, $c = $this->getFieldCount(); $i < $c; $i++) {
            $retVal[$i]             = new stdClass();
            $retVal[$i]->name       = pg_field_name($this->resultID, $i);
            $retVal[$i]->type       = pg_field_type_oid($this->resultID, $i);
            $retVal[$i]->type_name  = pg_field_type($this->resultID, $i);
            $retVal[$i]->max_length = pg_field_size($this->resultID, $i);
            $retVal[$i]->length     = $retVal[$i]->max_length;
            // $retVal[$i]->primary_key = (int)($fieldData[$i]->flags & 2);             // $retVal[$i]->default = $fieldData[$i]->def;         }

        return $retVal;
    }

    /** * Frees the current result. * * @return void */