Reference documentation and code samples for the Cloud Firestore V1 Client class PBReadOnly.
Options for a transaction that can only be used to read documents.
Generated from protobuf message google.firestore.v1.TransactionOptions.ReadOnly
Namespace
Google \ Cloud \ Firestore \ V1 \ TransactionOptionsMethods
__construct
Constructor.
| Parameters | |
|---|---|
| Name | Description |
data |
array
Optional. Data for populating the Message object. |
↳ read_time |
Google\Protobuf\Timestamp
Reads documents at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days. |
getReadTime
Reads documents at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
| Returns | |
|---|---|
| Type | Description |
Google\Protobuf\Timestamp|null | |
hasReadTime
setReadTime
Reads documents at the given time.
This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
| Parameter | |
|---|---|
| Name | Description |
var |
Google\Protobuf\Timestamp
|
| Returns | |
|---|---|
| Type | Description |
$this | |
getConsistencySelector
| Returns | |
|---|---|
| Type | Description |
string | |