Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly (v1.6.0)

Version latest

• 1.6.0 (latest)
• 1.5.0
• 1.4.0
• 1.3.0
• 1.2.0
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::TransactionOptions::ReadOnly.

Message type to initiate a read-only transaction.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#exact_staleness

def exact_staleness() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Executes all reads at a timestamp that is exact_staleness old. The timestamp is chosen soon after the read is started.

  Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of max_staleness.

  Note: The following fields are mutually exclusive: exact_staleness, strong, min_read_timestamp, max_staleness, read_timestamp. If a field in that set is populated, all other fields in the set will automatically be cleared.

#exact_staleness=

def exact_staleness=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Executes all reads at a timestamp that is exact_staleness old. The timestamp is chosen soon after the read is started.

  Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of max_staleness.

  Note: The following fields are mutually exclusive: exact_staleness, strong, min_read_timestamp, max_staleness, read_timestamp. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Duration) — Executes all reads at a timestamp that is exact_staleness old. The timestamp is chosen soon after the read is started.

  Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading at nearby replicas without the distributed timestamp negotiation overhead of max_staleness.

  Note: The following fields are mutually exclusive: exact_staleness, strong, min_read_timestamp, max_staleness, read_timestamp. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_staleness

def max_staleness() -> ::Google::Protobuf::Duration

Returns

• (::Google::Protobuf::Duration) — Read data at a timestamp >= NOW - max_staleness seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.

  Note that this option can only be used in single-use transactions.

  Note: The following fields are mutually exclusive: max_staleness, strong, min_read_timestamp, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#max_staleness=

def max_staleness=(value) -> ::Google::Protobuf::Duration

Parameter

• value (::Google::Protobuf::Duration) — Read data at a timestamp >= NOW - max_staleness seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.

  Note that this option can only be used in single-use transactions.

  Note: The following fields are mutually exclusive: max_staleness, strong, min_read_timestamp, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Duration) — Read data at a timestamp >= NOW - max_staleness seconds. Guarantees that all writes that have committed more than the specified number of seconds ago are visible. Because Cloud Spanner chooses the exact timestamp, this mode works even if the client's local clock is substantially skewed from Cloud Spanner commit timestamps.

  Useful for reading the freshest data available at a nearby replica, while bounding the possible staleness if the local replica has fallen behind.

  Note that this option can only be used in single-use transactions.

  Note: The following fields are mutually exclusive: max_staleness, strong, min_read_timestamp, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#min_read_timestamp

def min_read_timestamp() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Executes all reads at a timestamp >= min_read_timestamp.

  This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.

  Note that this option can only be used in single-use transactions.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: min_read_timestamp, strong, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#min_read_timestamp=

def min_read_timestamp=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Executes all reads at a timestamp >= min_read_timestamp.

  This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.

  Note that this option can only be used in single-use transactions.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: min_read_timestamp, strong, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Timestamp) — Executes all reads at a timestamp >= min_read_timestamp.

  This is useful for requesting fresher data than some previous read, or data that is fresh enough to observe the effects of some previously committed transaction whose timestamp is known.

  Note that this option can only be used in single-use transactions.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: min_read_timestamp, strong, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#read_timestamp

def read_timestamp() -> ::Google::Protobuf::Timestamp

Returns

• (::Google::Protobuf::Timestamp) — Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.

  Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: read_timestamp, strong, min_read_timestamp, max_staleness, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#read_timestamp=

def read_timestamp=(value) -> ::Google::Protobuf::Timestamp

Parameter

• value (::Google::Protobuf::Timestamp) — Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.

  Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: read_timestamp, strong, min_read_timestamp, max_staleness, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Google::Protobuf::Timestamp) — Executes all reads at the given timestamp. Unlike other modes, reads at a specific timestamp are repeatable; the same read at the same timestamp always returns the same data. If the timestamp is in the future, the read will block until the specified timestamp, modulo the read's deadline.

  Useful for large scale consistent reads such as mapreduces, or for coordinating many reads against a consistent snapshot of the data.

  A timestamp in RFC3339 UTC \"Zulu\" format, accurate to nanoseconds. Example: "2014-10-02T15:01:23.045123456Z".

  Note: The following fields are mutually exclusive: read_timestamp, strong, min_read_timestamp, max_staleness, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#return_read_timestamp

def return_read_timestamp() -> ::Boolean

Returns

• (::Boolean) — If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.

#return_read_timestamp=

def return_read_timestamp=(value) -> ::Boolean

Parameter

• value (::Boolean) — If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.

Returns

• (::Boolean) — If true, the Cloud Spanner-selected read timestamp is included in the Transaction message that describes the transaction.

#strong

def strong() -> ::Boolean

Returns

• (::Boolean) — Read at a timestamp where all previously committed transactions are visible.

  Note: The following fields are mutually exclusive: strong, min_read_timestamp, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

#strong=

def strong=(value) -> ::Boolean

Parameter

• value (::Boolean) — Read at a timestamp where all previously committed transactions are visible.

  Note: The following fields are mutually exclusive: strong, min_read_timestamp, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.

Returns

• (::Boolean) — Read at a timestamp where all previously committed transactions are visible.

  Note: The following fields are mutually exclusive: strong, min_read_timestamp, max_staleness, read_timestamp, exact_staleness. If a field in that set is populated, all other fields in the set will automatically be cleared.