This is a marker type for records such as table rows or query results.
The driver uses plain JavaScript objects to represent table rows for
put operations and as results of get operations and query results. A row
object consists of properties each designating a table field (on input) or
field generated by a query (on output). The property keys must
match their corresponding field names and property values are used as
corresponding field values. The match between the keys and field names
is case-insensitive. For put operations such as put,
the property values must be of a type that maps to the corresponding data
type of the table field as described in FieldValue. When a row
object is received on output, such as from get, its
value will always conform to the schema of the table from which the it was
received or the implied schema of a query projection.
Note the following:
To represent rows as objects, you may only use plain JavaScript
objects, that is object literals. The driver will reject any class
instances
You may also specify a valid JSON string as a row value, in which case
it will be parsed via JSON.parse and the result subjected to the
same validation as above
Typescript-specific:
This type is used as a default for TRow type parameter for APIs
such as get, put and others as well
as interfaces representing the results of these operations. It represents
object of any type.
The users are encouraged to define interface or type that describes the
shape of their table rows and use it as TRow type parameter for
these APIs.
For Javascript users:
This is a marker type for records such as table rows or query results.
The driver uses plain JavaScript objects to represent table rows for put operations and as results of get operations and query results. A row object consists of properties each designating a table field (on input) or field generated by a query (on output). The property keys must match their corresponding field names and property values are used as corresponding field values. The match between the keys and field names is case-insensitive. For put operations such as put, the property values must be of a type that maps to the corresponding data type of the table field as described in FieldValue. When a row object is received on output, such as from get, its value will always conform to the schema of the table from which the it was received or the implied schema of a query projection.
Note the following:
Typescript-specific:
This type is used as a default for TRow type parameter for APIs such as get, put and others as well as interfaces representing the results of these operations. It represents object of any type.
The users are encouraged to define interface or type that describes the shape of their table rows and use it as TRow type parameter for these APIs.