AsyncMysqlRowBlock

Note

This is a point-in-time snapshot of the API documentation from January 2026. Going forward, we will not be maintaining a public copy of these references, and recommend users to refer to the built-in signature helpers available in the Hack LSP instead for complete and up-to-date information.

Represents a row block

A row block is either a full or partial set of result rows from a MySQL query.

In a query result, the sum total of all the row blocks is the full result of the query. Most of the time there is only one row block per query result since the query was never interrupted or otherwise deterred by some outside condition like exceeding network packet parameters.

You can get an instance of AsyncMysqlRowBlock via the AsyncMysqlQueryResult::rowBlocks() call.

Guides

• Introduction
• Extensions

Interface Synopsis

final class AsyncMysqlRowBlock implements IteratorAggregate, Countable, KeyedTraversable<int, AsyncMysqlRow> {...}

Public Methods

• ->at(int $row, mixed $field): mixed
  Get a field (column) value
• ->count(): int
  Returns the number of rows in the current row block
• ->fieldFlags(mixed $field): int
  Returns the flags of the field (column)
• ->fieldName(int $field): string
  Returns the name of the field (column)
• ->fieldType(mixed $field): int
  Returns the type of the field (column)
• ->fieldsCount(): int
  Returns the number of fields (columns) associated with the current row block
• ->getFieldAsDouble(int $row, mixed $field): float
  Get a certain field (column) value from a certain row as double
• ->getFieldAsInt(int $row, mixed $field): int
  Get a certain field (column) value from a certain row as int
• ->getFieldAsString(int $row, mixed $field): string
  Get a certain field (column) value from a certain row as string
• ->getIterator(): KeyedIterator<int, AsyncMysqlRow>
  Get the iterator for the rows in the block
• ->getRow(int $row): AsyncMysqlRow
  Get a certain row in the current row block
• ->isEmpty(): bool
  Returns whether there were any rows are returned in the current row block
• ->isNull(int $row, mixed $field): bool
  Returns whether a field (column) value is null