class Google::Cloud::Spanner::V1::Spanner::Client

def streaming_read request, options = nil

Other tags:
    Example: Basic example -

Raises:
  • (::Google::Cloud::Error) - if the RPC is aborted.

Returns:
  • (::Enumerable<::Google::Cloud::Spanner::V1::PartialResultSet>) -

Other tags:
    Yieldparam: operation -
    Yieldparam: response -

Other tags:
    Yield: - Access the result along with the RPC operation

Parameters:
  • lock_hint (::Google::Cloud::Spanner::V1::ReadRequest::LockHint) --
  • order_by (::Google::Cloud::Spanner::V1::ReadRequest::OrderBy) --
  • data_boost_enabled (::Boolean) --
  • directed_read_options (::Google::Cloud::Spanner::V1::DirectedReadOptions, ::Hash) --
  • request_options (::Google::Cloud::Spanner::V1::RequestOptions, ::Hash) --
  • partition_token (::String) --
  • resume_token (::String) --
  • limit (::Integer) --
  • key_set (::Google::Cloud::Spanner::V1::KeySet, ::Hash) --
  • columns (::Array<::String>) --
  • index (::String) --
  • table (::String) --
  • transaction (::Google::Cloud::Spanner::V1::TransactionSelector, ::Hash) --
  • session (::String) --
  • options (::Gapic::CallOptions, ::Hash) --
  • request (::Google::Cloud::Spanner::V1::ReadRequest, ::Hash) --

Overloads:
  • streaming_read(session: nil, transaction: nil, table: nil, index: nil, columns: nil, key_set: nil, limit: nil, resume_token: nil, partition_token: nil, request_options: nil, directed_read_options: nil, data_boost_enabled: nil, order_by: nil, lock_hint: nil)
  • streaming_read(request, options = nil) 
def streaming_read request, options = nil
  raise ::ArgumentError, "request must be provided" if request.nil?
  request = ::Gapic::Protobuf.coerce request, to: ::Google::Cloud::Spanner::V1::ReadRequest
  # Converts hash and nil to an options object
  options = ::Gapic::CallOptions.new(**options.to_h) if options.respond_to? :to_h
  # Customize the options with defaults
  metadata = @config.rpcs.streaming_read.metadata.to_h
  # Set x-goog-api-client, x-goog-user-project and x-goog-api-version headers
  metadata[:"x-goog-api-client"] ||= ::Gapic::Headers.x_goog_api_client \
    lib_name: @config.lib_name, lib_version: @config.lib_version,
    gapic_version: ::Google::Cloud::Spanner::V1::VERSION
  metadata[:"x-goog-api-version"] = API_VERSION unless API_VERSION.empty?
  metadata[:"x-goog-user-project"] = @quota_project_id if @quota_project_id
  header_params = {}
  if request.session
    header_params["session"] = request.session
  end
  request_params_header = header_params.map { |k, v| "#{k}=#{v}" }.join("&")
  metadata[:"x-goog-request-params"] ||= request_params_header
  options.apply_defaults timeout:      @config.rpcs.streaming_read.timeout,
                         metadata:     metadata,
                         retry_policy: @config.rpcs.streaming_read.retry_policy
  options.apply_defaults timeout:      @config.timeout,
                         metadata:     @config.metadata,
                         retry_policy: @config.retry_policy
  @spanner_stub.call_rpc :streaming_read, request, options: options do |response, operation|
    yield response, operation if block_given?
    return response
  end
rescue ::GRPC::BadStatus => e
  raise ::Google::Cloud::Error.from_error(e)
end