Alpha

These pages are built from turborel-php’s main, turborel 0.0.0. Anything may change from one build to the next: SQL, API, protocol and files alike.

Values

NAME

Turborel\Value, Turborel\Type: the values the low-level client gives and takes for each of the protocol's types, and the types of columns and parameters.

SYNOPSIS

use Turborel\Value\Exact;
use Turborel\Value\Json;
use Turborel\Value\Uuid;

$price = Exact::fromString('-12.340');      // units '-12340', scale 3
$document = Json::fromText('{"a":[1,2.5]}');
$id = Uuid::fromText('919108f7-52d1-4320-9bac-f847db4148a8');

DESCRIPTION

A value is PHP's own where PHP has a type that holds every value of its SQL type: null, a string for a character string, a float for an approximate number, a bool for a truth value, and an int sent as an exact number of scale 0. Every other value is an object of Turborel\Value, made by its constructor or a named constructor, and checked as it is made. Appendix A maps each tag to its class.

An exact number keeps its units, an i128, as the string of their digits, and its scale, so every exact number Turborel holds reaches a program with no loss: (string) $price writes it with its point, -12.340. A DecFloat is kept in Turborel's one form, its trailing zeros in its exponent. A Json holds its stored form, which text() writes as JSON text and value() gives as PHP's values. A Uuid holds its 16 octets, and (string) $id gives its text.

A connection reads them in its rows, and sends them as the parameters of a prepared statement (Statements and Cursors).

ERRORS

SQLSTATE SQLCODE When
22003 -301 A value, or one of its fields, out of its range: an exact number's units past an i128, a DecFloat past 34 digits
22018 -301 A UUID's text that is not one: 32 hexadecimal digits, a hyphen allowed after each group of four, trimmed, braced or not
TB910 -910 A UUID made of other than 16 octets
22021 -301 A string, or a character large object, that is not UTF-8
22032 -301 JSON text that does not parse, or JSON with no text, a datetime's
TB916 -916 A JSON stored form that is damaged, or of another version; a value a server sent that the driver cannot take, as a truth byte not 0 or 1, or value tags 18 and 19, its statement failing alone
0A000 -900 JSON nested more than 128 deep, or a stored form past 256 MiB: turborel's limits
22000 -301 A PHP value no SQL value is, sent as a parameter
08006 -919 A value a server sent whose frame is malformed: cut short, or bytes after its last field

EXAMPLES

use Turborel\Value\Json;

$json = Json::fromText('{"b":1,"a":2,"b":3}');
echo $json->text(), PHP_EOL;
print_r($json->value());
{"b":1,"a":2,"b":3}
stdClass Object
(
    [b] => 1
    [a] => 2
)

STANDARD

[PROTOCOL Data types], [PROTOCOL Values], and Turborel's RULES.md D89 and D184.

SEE ALSO

Appendix A: Types, Errors.