Class: Google::Cloud::Spanner::V1::SpannerClient

Inherits:
Object
  • Object
show all
Defined in:
lib/google/cloud/spanner/v1/spanner_client.rb

Overview

Cloud Spanner API

The Cloud Spanner API can be used to manage sessions and execute transactions on data stored in Cloud Spanner databases.

Constant Summary collapse

SERVICE_ADDRESS =

The default address of the service.

"spanner.googleapis.com".freeze
DEFAULT_SERVICE_PORT =

The default port of the service.

443
DEFAULT_TIMEOUT =
30
ALL_SCOPES =

The scopes needed to make gRPC calls to all of the methods defined in this service.

[
  "https://www.googleapis.com/auth/cloud-platform",
  "https://www.googleapis.com/auth/spanner.data"
].freeze

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, updater_proc: nil, credentials: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, lib_name: nil, lib_version: "") ⇒ SpannerClient

Returns a new instance of SpannerClient

Parameters:

  • credentials (Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc)

    Provides the means for authenticating requests made by the client. This parameter can be many types. A Google::Auth::Credentials uses a the properties of its represented keyfile for authenticating requests made by this client. A String will be treated as the path to the keyfile to be used for the construction of credentials for this client. A Hash will be treated as the contents of a keyfile to be used for the construction of credentials for this client. A GRPC::Core::Channel will be used to make calls through. A GRPC::Core::ChannelCredentials for the setting up the RPC client. The channel credentials should already be composed with a GRPC::Core::CallCredentials object. A Proc will be used as an updater_proc for the Grpc channel. The proc transforms the metadata for requests, generally, to give OAuth credentials.

  • scopes (Array<String>)

    The OAuth scopes for this service. This parameter is ignored if an updater_proc is supplied.

  • client_config (Hash)

    A Hash for call options for each method. See Google::Gax#construct_settings for the structure of this data. Falls back to the default config if not specified or the specified config is missing data points.

  • timeout (Numeric)

    The default timeout, in seconds, for calls made through this client.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 135

def initialize \
    service_path: SERVICE_ADDRESS,
    port: DEFAULT_SERVICE_PORT,
    channel: nil,
    chan_creds: nil,
    updater_proc: nil,
    credentials: nil,
    scopes: ALL_SCOPES,
    client_config: {},
    timeout: DEFAULT_TIMEOUT,
    lib_name: nil,
    lib_version: ""
  # These require statements are intentionally placed here to initialize
  # the gRPC module only when it's required.
  # See https://github.com/googleapis/toolkit/issues/446
  require "google/gax/grpc"
  require "google/spanner/v1/spanner_services_pb"

  if channel || chan_creds || updater_proc
    warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
      "on 2017/09/08"
    credentials ||= channel
    credentials ||= chan_creds
    credentials ||= updater_proc
  end
  if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
    warn "`service_path` and `port` parameters are deprecated and will be removed"
  end

  credentials ||= Google::Cloud::Spanner::Credentials.default

  if credentials.is_a?(String) || credentials.is_a?(Hash)
    updater_proc = Google::Cloud::Spanner::Credentials.new(credentials).updater_proc
  end
  if credentials.is_a?(GRPC::Core::Channel)
    channel = credentials
  end
  if credentials.is_a?(GRPC::Core::ChannelCredentials)
    chan_creds = credentials
  end
  if credentials.is_a?(Proc)
    updater_proc = credentials
  end
  if credentials.is_a?(Google::Auth::Credentials)
    updater_proc = credentials.updater_proc
  end

  google_api_client = "gl-ruby/#{RUBY_VERSION}"
  google_api_client << " #{lib_name}/#{lib_version}" if lib_name
  google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
  google_api_client << " grpc/#{GRPC::VERSION}"
  google_api_client.freeze

  headers = { :"x-goog-api-client" => google_api_client }
  client_config_file = Pathname.new(__dir__).join(
    "spanner_client_config.json"
  )
  defaults = client_config_file.open do |f|
    Google::Gax.construct_settings(
      "google.spanner.v1.Spanner",
      JSON.parse(f.read),
      client_config,
      Google::Gax::Grpc::STATUS_CODE_NAMES,
      timeout,
      page_descriptors: PAGE_DESCRIPTORS,
      errors: Google::Gax::Grpc::API_ERRORS,
      kwargs: headers
    )
  end
  @spanner_stub = Google::Gax::Grpc.create_stub(
    service_path,
    port,
    chan_creds: chan_creds,
    channel: channel,
    updater_proc: updater_proc,
    scopes: scopes,
    &Google::Spanner::V1::Spanner::Stub.method(:new)
  )

  @create_session = Google::Gax.create_api_call(
    @spanner_stub.method(:create_session),
    defaults["create_session"]
  )
  @get_session = Google::Gax.create_api_call(
    @spanner_stub.method(:get_session),
    defaults["get_session"]
  )
  @list_sessions = Google::Gax.create_api_call(
    @spanner_stub.method(:list_sessions),
    defaults["list_sessions"]
  )
  @delete_session = Google::Gax.create_api_call(
    @spanner_stub.method(:delete_session),
    defaults["delete_session"]
  )
  @execute_sql = Google::Gax.create_api_call(
    @spanner_stub.method(:execute_sql),
    defaults["execute_sql"]
  )
  @execute_streaming_sql = Google::Gax.create_api_call(
    @spanner_stub.method(:execute_streaming_sql),
    defaults["execute_streaming_sql"]
  )
  @read = Google::Gax.create_api_call(
    @spanner_stub.method(:read),
    defaults["read"]
  )
  @streaming_read = Google::Gax.create_api_call(
    @spanner_stub.method(:streaming_read),
    defaults["streaming_read"]
  )
  @begin_transaction = Google::Gax.create_api_call(
    @spanner_stub.method(:begin_transaction),
    defaults["begin_transaction"]
  )
  @commit = Google::Gax.create_api_call(
    @spanner_stub.method(:commit),
    defaults["commit"]
  )
  @rollback = Google::Gax.create_api_call(
    @spanner_stub.method(:rollback),
    defaults["rollback"]
  )
end

Instance Attribute Details

#spanner_stubGoogle::Spanner::V1::Spanner::Stub (readonly)

Returns:

  • (Google::Spanner::V1::Spanner::Stub)


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 44

class SpannerClient
  attr_reader :spanner_stub

  # The default address of the service.
  SERVICE_ADDRESS = "spanner.googleapis.com".freeze

  # The default port of the service.
  DEFAULT_SERVICE_PORT = 443

  DEFAULT_TIMEOUT = 30

  PAGE_DESCRIPTORS = {
    "list_sessions" => Google::Gax::PageDescriptor.new(
      "page_token",
      "next_page_token",
      "sessions")
  }.freeze

  private_constant :PAGE_DESCRIPTORS

  # The scopes needed to make gRPC calls to all of the methods defined in
  # this service.
  ALL_SCOPES = [
    "https://www.googleapis.com/auth/cloud-platform",
    "https://www.googleapis.com/auth/spanner.data"
  ].freeze

  DATABASE_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/instances/{instance}/databases/{database}"
  )

  private_constant :DATABASE_PATH_TEMPLATE

  SESSION_PATH_TEMPLATE = Google::Gax::PathTemplate.new(
    "projects/{project}/instances/{instance}/databases/{database}/sessions/{session}"
  )

  private_constant :SESSION_PATH_TEMPLATE

  # Returns a fully-qualified database resource name string.
  # @param project [String]
  # @param instance [String]
  # @param database [String]
  # @return [String]
  def self.database_path project, instance, database
    DATABASE_PATH_TEMPLATE.render(
      :"project" => project,
      :"instance" => instance,
      :"database" => database
    )
  end

  # Returns a fully-qualified session resource name string.
  # @param project [String]
  # @param instance [String]
  # @param database [String]
  # @param session [String]
  # @return [String]
  def self.session_path project, instance, database, session
    SESSION_PATH_TEMPLATE.render(
      :"project" => project,
      :"instance" => instance,
      :"database" => database,
      :"session" => session
    )
  end

  # @param credentials [Google::Auth::Credentials, String, Hash, GRPC::Core::Channel, GRPC::Core::ChannelCredentials, Proc]
  #   Provides the means for authenticating requests made by the client. This parameter can
  #   be many types.
  #   A `Google::Auth::Credentials` uses a the properties of its represented keyfile for
  #   authenticating requests made by this client.
  #   A `String` will be treated as the path to the keyfile to be used for the construction of
  #   credentials for this client.
  #   A `Hash` will be treated as the contents of a keyfile to be used for the construction of
  #   credentials for this client.
  #   A `GRPC::Core::Channel` will be used to make calls through.
  #   A `GRPC::Core::ChannelCredentials` for the setting up the RPC client. The channel credentials
  #   should already be composed with a `GRPC::Core::CallCredentials` object.
  #   A `Proc` will be used as an updater_proc for the Grpc channel. The proc transforms the
  #   metadata for requests, generally, to give OAuth credentials.
  # @param scopes [Array<String>]
  #   The OAuth scopes for this service. This parameter is ignored if
  #   an updater_proc is supplied.
  # @param client_config [Hash]
  #   A Hash for call options for each method. See
  #   Google::Gax#construct_settings for the structure of
  #   this data. Falls back to the default config if not specified
  #   or the specified config is missing data points.
  # @param timeout [Numeric]
  #   The default timeout, in seconds, for calls made through this client.
  def initialize \
      service_path: SERVICE_ADDRESS,
      port: DEFAULT_SERVICE_PORT,
      channel: nil,
      chan_creds: nil,
      updater_proc: nil,
      credentials: nil,
      scopes: ALL_SCOPES,
      client_config: {},
      timeout: DEFAULT_TIMEOUT,
      lib_name: nil,
      lib_version: ""
    # These require statements are intentionally placed here to initialize
    # the gRPC module only when it's required.
    # See https://github.com/googleapis/toolkit/issues/446
    require "google/gax/grpc"
    require "google/spanner/v1/spanner_services_pb"

    if channel || chan_creds || updater_proc
      warn "The `channel`, `chan_creds`, and `updater_proc` parameters will be removed " \
        "on 2017/09/08"
      credentials ||= channel
      credentials ||= chan_creds
      credentials ||= updater_proc
    end
    if service_path != SERVICE_ADDRESS || port != DEFAULT_SERVICE_PORT
      warn "`service_path` and `port` parameters are deprecated and will be removed"
    end

    credentials ||= Google::Cloud::Spanner::Credentials.default

    if credentials.is_a?(String) || credentials.is_a?(Hash)
      updater_proc = Google::Cloud::Spanner::Credentials.new(credentials).updater_proc
    end
    if credentials.is_a?(GRPC::Core::Channel)
      channel = credentials
    end
    if credentials.is_a?(GRPC::Core::ChannelCredentials)
      chan_creds = credentials
    end
    if credentials.is_a?(Proc)
      updater_proc = credentials
    end
    if credentials.is_a?(Google::Auth::Credentials)
      updater_proc = credentials.updater_proc
    end

    google_api_client = "gl-ruby/#{RUBY_VERSION}"
    google_api_client << " #{lib_name}/#{lib_version}" if lib_name
    google_api_client << " gapic/0.1.0 gax/#{Google::Gax::VERSION}"
    google_api_client << " grpc/#{GRPC::VERSION}"
    google_api_client.freeze

    headers = { :"x-goog-api-client" => google_api_client }
    client_config_file = Pathname.new(__dir__).join(
      "spanner_client_config.json"
    )
    defaults = client_config_file.open do |f|
      Google::Gax.construct_settings(
        "google.spanner.v1.Spanner",
        JSON.parse(f.read),
        client_config,
        Google::Gax::Grpc::STATUS_CODE_NAMES,
        timeout,
        page_descriptors: PAGE_DESCRIPTORS,
        errors: Google::Gax::Grpc::API_ERRORS,
        kwargs: headers
      )
    end
    @spanner_stub = Google::Gax::Grpc.create_stub(
      service_path,
      port,
      chan_creds: chan_creds,
      channel: channel,
      updater_proc: updater_proc,
      scopes: scopes,
      &Google::Spanner::V1::Spanner::Stub.method(:new)
    )

    @create_session = Google::Gax.create_api_call(
      @spanner_stub.method(:create_session),
      defaults["create_session"]
    )
    @get_session = Google::Gax.create_api_call(
      @spanner_stub.method(:get_session),
      defaults["get_session"]
    )
    @list_sessions = Google::Gax.create_api_call(
      @spanner_stub.method(:list_sessions),
      defaults["list_sessions"]
    )
    @delete_session = Google::Gax.create_api_call(
      @spanner_stub.method(:delete_session),
      defaults["delete_session"]
    )
    @execute_sql = Google::Gax.create_api_call(
      @spanner_stub.method(:execute_sql),
      defaults["execute_sql"]
    )
    @execute_streaming_sql = Google::Gax.create_api_call(
      @spanner_stub.method(:execute_streaming_sql),
      defaults["execute_streaming_sql"]
    )
    @read = Google::Gax.create_api_call(
      @spanner_stub.method(:read),
      defaults["read"]
    )
    @streaming_read = Google::Gax.create_api_call(
      @spanner_stub.method(:streaming_read),
      defaults["streaming_read"]
    )
    @begin_transaction = Google::Gax.create_api_call(
      @spanner_stub.method(:begin_transaction),
      defaults["begin_transaction"]
    )
    @commit = Google::Gax.create_api_call(
      @spanner_stub.method(:commit),
      defaults["commit"]
    )
    @rollback = Google::Gax.create_api_call(
      @spanner_stub.method(:rollback),
      defaults["rollback"]
    )
  end

  # Service calls

  # Creates a new session. A session can be used to perform
  # transactions that read and/or modify data in a Cloud Spanner database.
  # Sessions are meant to be reused for many consecutive
  # transactions.
  #
  # Sessions can only execute one transaction at a time. To execute
  # multiple concurrent read-write/write-only transactions, create
  # multiple sessions. Note that standalone reads and queries use a
  # transaction internally, and count toward the one transaction
  # limit.
  #
  # Cloud Spanner limits the number of sessions that can exist at any given
  # time; thus, it is a good idea to delete idle and/or unneeded sessions.
  # Aside from explicit deletes, Cloud Spanner can delete sessions for which no
  # operations are sent for more than an hour. If a session is deleted,
  # requests to it return +NOT_FOUND+.
  #
  # Idle sessions can be kept alive by sending a trivial SQL query
  # periodically, e.g., +"SELECT 1"+.
  #
  # @param database [String]
  #   Required. The database in which the new session is created.
  # @param session [Google::Spanner::V1::Session | Hash]
  #   The session to create.
  #   A hash of the same form as `Google::Spanner::V1::Session`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::Session]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
  #   response = spanner_client.create_session(formatted_database)

  def create_session \
      database,
      session: nil,
      options: nil
    req = {
      database: database,
      session: session
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::CreateSessionRequest)
    @create_session.call(req, options)
  end

  # Gets a session. Returns +NOT_FOUND+ if the session does not exist.
  # This is mainly useful for determining whether a session is still
  # alive.
  #
  # @param name [String]
  #   Required. The name of the session to retrieve.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::Session]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   response = spanner_client.get_session(formatted_name)

  def get_session \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::GetSessionRequest)
    @get_session.call(req, options)
  end

  # Lists all sessions in a given database.
  #
  # @param database [String]
  #   Required. The database in which to list sessions.
  # @param page_size [Integer]
  #   The maximum number of resources contained in the underlying API
  #   response. If page streaming is performed per-resource, this
  #   parameter does not affect the return value. If page streaming is
  #   performed per-page, this determines the maximum number of
  #   resources in a page.
  # @param filter [String]
  #   An expression for filtering the results of the request. Filter rules are
  #   case insensitive. The fields eligible for filtering are:
  #
  #   * +labels.key+ where key is the name of a label
  #
  #   Some examples of using filters are:
  #
  #   * +labels.env:*+ --> The session has the label "env".
  #     * +labels.env:dev+ --> The session has the label "env" and the value of
  #       the label contains the string "dev".
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Gax::PagedEnumerable<Google::Spanner::V1::Session>]
  #   An enumerable of Google::Spanner::V1::Session instances.
  #   See Google::Gax::PagedEnumerable documentation for other
  #   operations such as per-page iteration or access to the response
  #   object.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
  #
  #   # Iterate over all results.
  #   spanner_client.list_sessions(formatted_database).each do |element|
  #     # Process element.
  #   end
  #
  #   # Or iterate over results one page at a time.
  #   spanner_client.list_sessions(formatted_database).each_page do |page|
  #     # Process each page at a time.
  #     page.each do |element|
  #       # Process element.
  #     end
  #   end

  def list_sessions \
      database,
      page_size: nil,
      filter: nil,
      options: nil
    req = {
      database: database,
      page_size: page_size,
      filter: filter
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::ListSessionsRequest)
    @list_sessions.call(req, options)
  end

  # Ends a session, releasing server resources associated with it.
  #
  # @param name [String]
  #   Required. The name of the session to delete.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   spanner_client.delete_session(formatted_name)

  def delete_session \
      name,
      options: nil
    req = {
      name: name
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::DeleteSessionRequest)
    @delete_session.call(req, options)
    nil
  end

  # Executes an SQL query, returning all rows in a single reply. This
  # method cannot be used to return a result set larger than 10 MiB;
  # if the query yields more data than that, the query fails with
  # a +FAILED_PRECONDITION+ error.
  #
  # Queries inside read-write transactions might return +ABORTED+. If
  # this occurs, the application should restart the transaction from
  # the beginning. See {Google::Spanner::V1::Transaction Transaction} for more details.
  #
  # Larger result sets can be fetched in streaming fashion by calling
  # {Google::Spanner::V1::Spanner::ExecuteStreamingSql ExecuteStreamingSql} instead.
  #
  # @param session [String]
  #   Required. The session in which the SQL query should be performed.
  # @param sql [String]
  #   Required. The SQL query string.
  # @param transaction [Google::Spanner::V1::TransactionSelector | Hash]
  #   The transaction to use. If none is provided, the default is a
  #   temporary read-only transaction with strong concurrency.
  #   A hash of the same form as `Google::Spanner::V1::TransactionSelector`
  #   can also be provided.
  # @param params [Google::Protobuf::Struct | Hash]
  #   The SQL query string can contain parameter placeholders. A parameter
  #   placeholder consists of +'@'+ followed by the parameter
  #   name. Parameter names consist of any combination of letters,
  #   numbers, and underscores.
  #
  #   Parameters can appear anywhere that a literal value is expected.  The same
  #   parameter name can be used more than once, for example:
  #     +"WHERE id > @msg_id AND id < @msg_id + 100"+
  #
  #   It is an error to execute an SQL query with unbound parameters.
  #
  #   Parameter values are specified using +params+, which is a JSON
  #   object whose keys are parameter names, and whose values are the
  #   corresponding parameter values.
  #   A hash of the same form as `Google::Protobuf::Struct`
  #   can also be provided.
  # @param param_types [Hash{String => Google::Spanner::V1::Type | Hash}]
  #   It is not always possible for Cloud Spanner to infer the right SQL type
  #   from a JSON value.  For example, values of type +BYTES+ and values
  #   of type +STRING+ both appear in {Google::Spanner::V1::ExecuteSqlRequest#params params} as JSON strings.
  #
  #   In these cases, +param_types+ can be used to specify the exact
  #   SQL type for some or all of the SQL query parameters. See the
  #   definition of {Google::Spanner::V1::Type Type} for more information
  #   about SQL types.
  #   A hash of the same form as `Google::Spanner::V1::Type`
  #   can also be provided.
  # @param resume_token [String]
  #   If this request is resuming a previously interrupted SQL query
  #   execution, +resume_token+ should be copied from the last
  #   {Google::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
  #   enables the new SQL query execution to resume where the last one left
  #   off. The rest of the request parameters must exactly match the
  #   request that yielded this token.
  # @param query_mode [Google::Spanner::V1::ExecuteSqlRequest::QueryMode]
  #   Used to control the amount of debugging information returned in
  #   {Google::Spanner::V1::ResultSetStats ResultSetStats}.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::ResultSet]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   sql = ''
  #   response = spanner_client.execute_sql(formatted_session, sql)

  def execute_sql \
      session,
      sql,
      transaction: nil,
      params: nil,
      param_types: nil,
      resume_token: nil,
      query_mode: nil,
      options: nil
    req = {
      session: session,
      sql: sql,
      transaction: transaction,
      params: params,
      param_types: param_types,
      resume_token: resume_token,
      query_mode: query_mode
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::ExecuteSqlRequest)
    @execute_sql.call(req, options)
  end

  # Like {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql}, except returns the result
  # set as a stream. Unlike {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql}, there
  # is no limit on the size of the returned result set. However, no
  # individual row in the result set can exceed 100 MiB, and no
  # column value can exceed 10 MiB.
  #
  # @param session [String]
  #   Required. The session in which the SQL query should be performed.
  # @param sql [String]
  #   Required. The SQL query string.
  # @param transaction [Google::Spanner::V1::TransactionSelector | Hash]
  #   The transaction to use. If none is provided, the default is a
  #   temporary read-only transaction with strong concurrency.
  #   A hash of the same form as `Google::Spanner::V1::TransactionSelector`
  #   can also be provided.
  # @param params [Google::Protobuf::Struct | Hash]
  #   The SQL query string can contain parameter placeholders. A parameter
  #   placeholder consists of +'@'+ followed by the parameter
  #   name. Parameter names consist of any combination of letters,
  #   numbers, and underscores.
  #
  #   Parameters can appear anywhere that a literal value is expected.  The same
  #   parameter name can be used more than once, for example:
  #     +"WHERE id > @msg_id AND id < @msg_id + 100"+
  #
  #   It is an error to execute an SQL query with unbound parameters.
  #
  #   Parameter values are specified using +params+, which is a JSON
  #   object whose keys are parameter names, and whose values are the
  #   corresponding parameter values.
  #   A hash of the same form as `Google::Protobuf::Struct`
  #   can also be provided.
  # @param param_types [Hash{String => Google::Spanner::V1::Type | Hash}]
  #   It is not always possible for Cloud Spanner to infer the right SQL type
  #   from a JSON value.  For example, values of type +BYTES+ and values
  #   of type +STRING+ both appear in {Google::Spanner::V1::ExecuteSqlRequest#params params} as JSON strings.
  #
  #   In these cases, +param_types+ can be used to specify the exact
  #   SQL type for some or all of the SQL query parameters. See the
  #   definition of {Google::Spanner::V1::Type Type} for more information
  #   about SQL types.
  #   A hash of the same form as `Google::Spanner::V1::Type`
  #   can also be provided.
  # @param resume_token [String]
  #   If this request is resuming a previously interrupted SQL query
  #   execution, +resume_token+ should be copied from the last
  #   {Google::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
  #   enables the new SQL query execution to resume where the last one left
  #   off. The rest of the request parameters must exactly match the
  #   request that yielded this token.
  # @param query_mode [Google::Spanner::V1::ExecuteSqlRequest::QueryMode]
  #   Used to control the amount of debugging information returned in
  #   {Google::Spanner::V1::ResultSetStats ResultSetStats}.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Spanner::V1::PartialResultSet>]
  #   An enumerable of Google::Spanner::V1::PartialResultSet instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   sql = ''
  #   spanner_client.execute_streaming_sql(formatted_session, sql).each do |element|
  #     # Process element.
  #   end

  def execute_streaming_sql \
      session,
      sql,
      transaction: nil,
      params: nil,
      param_types: nil,
      resume_token: nil,
      query_mode: nil,
      options: nil
    req = {
      session: session,
      sql: sql,
      transaction: transaction,
      params: params,
      param_types: param_types,
      resume_token: resume_token,
      query_mode: query_mode
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::ExecuteSqlRequest)
    @execute_streaming_sql.call(req, options)
  end

  # Reads rows from the database using key lookups and scans, as a
  # simple key/value style alternative to
  # {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql}.  This method cannot be used to
  # return a result set larger than 10 MiB; if the read matches more
  # data than that, the read fails with a +FAILED_PRECONDITION+
  # error.
  #
  # Reads inside read-write transactions might return +ABORTED+. If
  # this occurs, the application should restart the transaction from
  # the beginning. See {Google::Spanner::V1::Transaction Transaction} for more details.
  #
  # Larger result sets can be yielded in streaming fashion by calling
  # {Google::Spanner::V1::Spanner::StreamingRead StreamingRead} instead.
  #
  # @param session [String]
  #   Required. The session in which the read should be performed.
  # @param table [String]
  #   Required. The name of the table in the database to be read.
  # @param columns [Array<String>]
  #   The columns of {Google::Spanner::V1::ReadRequest#table table} to be returned for each row matching
  #   this request.
  # @param key_set [Google::Spanner::V1::KeySet | Hash]
  #   Required. +key_set+ identifies the rows to be yielded. +key_set+ names the
  #   primary keys of the rows in {Google::Spanner::V1::ReadRequest#table table} to be yielded, unless {Google::Spanner::V1::ReadRequest#index index}
  #   is present. If {Google::Spanner::V1::ReadRequest#index index} is present, then {Google::Spanner::V1::ReadRequest#key_set key_set} instead names
  #   index keys in {Google::Spanner::V1::ReadRequest#index index}.
  #
  #   Rows are yielded in table primary key order (if {Google::Spanner::V1::ReadRequest#index index} is empty)
  #   or index key order (if {Google::Spanner::V1::ReadRequest#index index} is non-empty).
  #
  #   It is not an error for the +key_set+ to name rows that do not
  #   exist in the database. Read yields nothing for nonexistent rows.
  #   A hash of the same form as `Google::Spanner::V1::KeySet`
  #   can also be provided.
  # @param transaction [Google::Spanner::V1::TransactionSelector | Hash]
  #   The transaction to use. If none is provided, the default is a
  #   temporary read-only transaction with strong concurrency.
  #   A hash of the same form as `Google::Spanner::V1::TransactionSelector`
  #   can also be provided.
  # @param index [String]
  #   If non-empty, the name of an index on {Google::Spanner::V1::ReadRequest#table table}. This index is
  #   used instead of the table primary key when interpreting {Google::Spanner::V1::ReadRequest#key_set key_set}
  #   and sorting result rows. See {Google::Spanner::V1::ReadRequest#key_set key_set} for further information.
  # @param limit [Integer]
  #   If greater than zero, only the first +limit+ rows are yielded. If +limit+
  #   is zero, the default is no limit.
  # @param resume_token [String]
  #   If this request is resuming a previously interrupted read,
  #   +resume_token+ should be copied from the last
  #   {Google::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
  #   enables the new read to resume where the last read left off. The
  #   rest of the request parameters must exactly match the request
  #   that yielded this token.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::ResultSet]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   table = ''
  #   columns = []
  #   key_set = {}
  #   response = spanner_client.read(formatted_session, table, columns, key_set)

  def read \
      session,
      table,
      columns,
      key_set,
      transaction: nil,
      index: nil,
      limit: nil,
      resume_token: nil,
      options: nil
    req = {
      session: session,
      table: table,
      columns: columns,
      key_set: key_set,
      transaction: transaction,
      index: index,
      limit: limit,
      resume_token: resume_token
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::ReadRequest)
    @read.call(req, options)
  end

  # Like {Google::Spanner::V1::Spanner::Read Read}, except returns the result set as a
  # stream. Unlike {Google::Spanner::V1::Spanner::Read Read}, there is no limit on the
  # size of the returned result set. However, no individual row in
  # the result set can exceed 100 MiB, and no column value can exceed
  # 10 MiB.
  #
  # @param session [String]
  #   Required. The session in which the read should be performed.
  # @param table [String]
  #   Required. The name of the table in the database to be read.
  # @param columns [Array<String>]
  #   The columns of {Google::Spanner::V1::ReadRequest#table table} to be returned for each row matching
  #   this request.
  # @param key_set [Google::Spanner::V1::KeySet | Hash]
  #   Required. +key_set+ identifies the rows to be yielded. +key_set+ names the
  #   primary keys of the rows in {Google::Spanner::V1::ReadRequest#table table} to be yielded, unless {Google::Spanner::V1::ReadRequest#index index}
  #   is present. If {Google::Spanner::V1::ReadRequest#index index} is present, then {Google::Spanner::V1::ReadRequest#key_set key_set} instead names
  #   index keys in {Google::Spanner::V1::ReadRequest#index index}.
  #
  #   Rows are yielded in table primary key order (if {Google::Spanner::V1::ReadRequest#index index} is empty)
  #   or index key order (if {Google::Spanner::V1::ReadRequest#index index} is non-empty).
  #
  #   It is not an error for the +key_set+ to name rows that do not
  #   exist in the database. Read yields nothing for nonexistent rows.
  #   A hash of the same form as `Google::Spanner::V1::KeySet`
  #   can also be provided.
  # @param transaction [Google::Spanner::V1::TransactionSelector | Hash]
  #   The transaction to use. If none is provided, the default is a
  #   temporary read-only transaction with strong concurrency.
  #   A hash of the same form as `Google::Spanner::V1::TransactionSelector`
  #   can also be provided.
  # @param index [String]
  #   If non-empty, the name of an index on {Google::Spanner::V1::ReadRequest#table table}. This index is
  #   used instead of the table primary key when interpreting {Google::Spanner::V1::ReadRequest#key_set key_set}
  #   and sorting result rows. See {Google::Spanner::V1::ReadRequest#key_set key_set} for further information.
  # @param limit [Integer]
  #   If greater than zero, only the first +limit+ rows are yielded. If +limit+
  #   is zero, the default is no limit.
  # @param resume_token [String]
  #   If this request is resuming a previously interrupted read,
  #   +resume_token+ should be copied from the last
  #   {Google::Spanner::V1::PartialResultSet PartialResultSet} yielded before the interruption. Doing this
  #   enables the new read to resume where the last read left off. The
  #   rest of the request parameters must exactly match the request
  #   that yielded this token.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Enumerable<Google::Spanner::V1::PartialResultSet>]
  #   An enumerable of Google::Spanner::V1::PartialResultSet instances.
  #
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   table = ''
  #   columns = []
  #   key_set = {}
  #   spanner_client.streaming_read(formatted_session, table, columns, key_set).each do |element|
  #     # Process element.
  #   end

  def streaming_read \
      session,
      table,
      columns,
      key_set,
      transaction: nil,
      index: nil,
      limit: nil,
      resume_token: nil,
      options: nil
    req = {
      session: session,
      table: table,
      columns: columns,
      key_set: key_set,
      transaction: transaction,
      index: index,
      limit: limit,
      resume_token: resume_token
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::ReadRequest)
    @streaming_read.call(req, options)
  end

  # Begins a new transaction. This step can often be skipped:
  # {Google::Spanner::V1::Spanner::Read Read}, {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql} and
  # {Google::Spanner::V1::Spanner::Commit Commit} can begin a new transaction as a
  # side-effect.
  #
  # @param session [String]
  #   Required. The session in which the transaction runs.
  # @param options_ [Google::Spanner::V1::TransactionOptions | Hash]
  #   Required. Options for the new transaction.
  #   A hash of the same form as `Google::Spanner::V1::TransactionOptions`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::Transaction]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   options_ = {}
  #   response = spanner_client.begin_transaction(formatted_session, options_)

  def begin_transaction \
      session,
      options_,
      options: nil
    req = {
      session: session,
      options: options_
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::BeginTransactionRequest)
    @begin_transaction.call(req, options)
  end

  # Commits a transaction. The request includes the mutations to be
  # applied to rows in the database.
  #
  # +Commit+ might return an +ABORTED+ error. This can occur at any time;
  # commonly, the cause is conflicts with concurrent
  # transactions. However, it can also happen for a variety of other
  # reasons. If +Commit+ returns +ABORTED+, the caller should re-attempt
  # the transaction from the beginning, re-using the same session.
  #
  # @param session [String]
  #   Required. The session in which the transaction to be committed is running.
  # @param mutations [Array<Google::Spanner::V1::Mutation | Hash>]
  #   The mutations to be executed when this transaction commits. All
  #   mutations are applied atomically, in the order they appear in
  #   this list.
  #   A hash of the same form as `Google::Spanner::V1::Mutation`
  #   can also be provided.
  # @param transaction_id [String]
  #   Commit a previously-started transaction.
  # @param single_use_transaction [Google::Spanner::V1::TransactionOptions | Hash]
  #   Execute mutations in a temporary transaction. Note that unlike
  #   commit of a previously-started transaction, commit with a
  #   temporary transaction is non-idempotent. That is, if the
  #   +CommitRequest+ is sent to Cloud Spanner more than once (for
  #   instance, due to retries in the application, or in the
  #   transport library), it is possible that the mutations are
  #   executed more than once. If this is undesirable, use
  #   {Google::Spanner::V1::Spanner::BeginTransaction BeginTransaction} and
  #   {Google::Spanner::V1::Spanner::Commit Commit} instead.
  #   A hash of the same form as `Google::Spanner::V1::TransactionOptions`
  #   can also be provided.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @return [Google::Spanner::V1::CommitResponse]
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   mutations = []
  #   response = spanner_client.commit(formatted_session, mutations)

  def commit \
      session,
      mutations,
      transaction_id: nil,
      single_use_transaction: nil,
      options: nil
    req = {
      session: session,
      mutations: mutations,
      transaction_id: transaction_id,
      single_use_transaction: single_use_transaction
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::CommitRequest)
    @commit.call(req, options)
  end

  # Rolls back a transaction, releasing any locks it holds. It is a good
  # idea to call this for any transaction that includes one or more
  # {Google::Spanner::V1::Spanner::Read Read} or {Google::Spanner::V1::Spanner::ExecuteSql ExecuteSql} requests and
  # ultimately decides not to commit.
  #
  # +Rollback+ returns +OK+ if it successfully aborts the transaction, the
  # transaction was already aborted, or the transaction is not
  # found. +Rollback+ never returns +ABORTED+.
  #
  # @param session [String]
  #   Required. The session in which the transaction to roll back is running.
  # @param transaction_id [String]
  #   Required. The transaction to roll back.
  # @param options [Google::Gax::CallOptions]
  #   Overrides the default settings for this call, e.g, timeout,
  #   retries, etc.
  # @raise [Google::Gax::GaxError] if the RPC is aborted.
  # @example
  #   require "google/cloud/spanner/v1"
  #
  #   spanner_client = Google::Cloud::Spanner::V1.new
  #   formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
  #   transaction_id = ''
  #   spanner_client.rollback(formatted_session, transaction_id)

  def rollback \
      session,
      transaction_id,
      options: nil
    req = {
      session: session,
      transaction_id: transaction_id
    }.delete_if { |_, v| v.nil? }
    req = Google::Gax::to_proto(req, Google::Spanner::V1::RollbackRequest)
    @rollback.call(req, options)
    nil
  end
end

Class Method Details

.database_path(project, instance, database) ⇒ String

Returns a fully-qualified database resource name string.

Parameters:

  • project (String)
  • instance (String)
  • database (String)

Returns:

  • (String)


88
89
90
91
92
93
94
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 88

def self.database_path project, instance, database
  DATABASE_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"database" => database
  )
end

.session_path(project, instance, database, session) ⇒ String

Returns a fully-qualified session resource name string.

Parameters:

  • project (String)
  • instance (String)
  • database (String)
  • session (String)

Returns:

  • (String)


102
103
104
105
106
107
108
109
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 102

def self.session_path project, instance, database, session
  SESSION_PATH_TEMPLATE.render(
    :"project" => project,
    :"instance" => instance,
    :"database" => database,
    :"session" => session
  )
end

Instance Method Details

#begin_transaction(session, options_, options: nil) ⇒ Google::Spanner::V1::Transaction

Begins a new transaction. This step can often be skipped: Read, ExecuteSql and Commit can begin a new transaction as a side-effect.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
options_ = {}
response = spanner_client.begin_transaction(formatted_session, options_)

Parameters:

  • session (String)

    Required. The session in which the transaction runs.

  • options_ (Google::Spanner::V1::TransactionOptions | Hash)

    Required. Options for the new transaction. A hash of the same form as Google::Spanner::V1::TransactionOptions can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



819
820
821
822
823
824
825
826
827
828
829
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 819

def begin_transaction \
    session,
    options_,
    options: nil
  req = {
    session: session,
    options: options_
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::BeginTransactionRequest)
  @begin_transaction.call(req, options)
end

#commit(session, mutations, transaction_id: nil, single_use_transaction: nil, options: nil) ⇒ Google::Spanner::V1::CommitResponse

Commits a transaction. The request includes the mutations to be applied to rows in the database.

+Commit+ might return an +ABORTED+ error. This can occur at any time; commonly, the cause is conflicts with concurrent transactions. However, it can also happen for a variety of other reasons. If +Commit+ returns +ABORTED+, the caller should re-attempt the transaction from the beginning, re-using the same session.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
mutations = []
response = spanner_client.commit(formatted_session, mutations)

Parameters:

  • session (String)

    Required. The session in which the transaction to be committed is running.

  • mutations (Array<Google::Spanner::V1::Mutation | Hash>)

    The mutations to be executed when this transaction commits. All mutations are applied atomically, in the order they appear in this list. A hash of the same form as Google::Spanner::V1::Mutation can also be provided.

  • transaction_id (String)

    Commit a previously-started transaction.

  • single_use_transaction (Google::Spanner::V1::TransactionOptions | Hash)

    Execute mutations in a temporary transaction. Note that unlike commit of a previously-started transaction, commit with a temporary transaction is non-idempotent. That is, if the +CommitRequest+ is sent to Cloud Spanner more than once (for instance, due to retries in the application, or in the transport library), it is possible that the mutations are executed more than once. If this is undesirable, use BeginTransaction and Commit instead. A hash of the same form as Google::Spanner::V1::TransactionOptions can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 875

def commit \
    session,
    mutations,
    transaction_id: nil,
    single_use_transaction: nil,
    options: nil
  req = {
    session: session,
    mutations: mutations,
    transaction_id: transaction_id,
    single_use_transaction: single_use_transaction
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::CommitRequest)
  @commit.call(req, options)
end

#create_session(database, session: nil, options: nil) ⇒ Google::Spanner::V1::Session

Creates a new session. A session can be used to perform transactions that read and/or modify data in a Cloud Spanner database. Sessions are meant to be reused for many consecutive transactions.

Sessions can only execute one transaction at a time. To execute multiple concurrent read-write/write-only transactions, create multiple sessions. Note that standalone reads and queries use a transaction internally, and count toward the one transaction limit.

Cloud Spanner limits the number of sessions that can exist at any given time; thus, it is a good idea to delete idle and/or unneeded sessions. Aside from explicit deletes, Cloud Spanner can delete sessions for which no operations are sent for more than an hour. If a session is deleted, requests to it return +NOT_FOUND+.

Idle sessions can be kept alive by sending a trivial SQL query periodically, e.g., +"SELECT 1"+.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")
response = spanner_client.create_session(formatted_database)

Parameters:

  • database (String)

    Required. The database in which the new session is created.

  • session (Google::Spanner::V1::Session | Hash)

    The session to create. A hash of the same form as Google::Spanner::V1::Session can also be provided.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



300
301
302
303
304
305
306
307
308
309
310
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 300

def create_session \
    database,
    session: nil,
    options: nil
  req = {
    database: database,
    session: session
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::CreateSessionRequest)
  @create_session.call(req, options)
end

#delete_session(name, options: nil) ⇒ Object

Ends a session, releasing server resources associated with it.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
spanner_client.delete_session(formatted_name)

Parameters:

  • name (String)

    Required. The name of the session to delete.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



418
419
420
421
422
423
424
425
426
427
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 418

def delete_session \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::DeleteSessionRequest)
  @delete_session.call(req, options)
  nil
end

#execute_sql(session, sql, transaction: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, options: nil) ⇒ Google::Spanner::V1::ResultSet

Executes an SQL query, returning all rows in a single reply. This method cannot be used to return a result set larger than 10 MiB; if the query yields more data than that, the query fails with a +FAILED_PRECONDITION+ error.

Queries inside read-write transactions might return +ABORTED+. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be fetched in streaming fashion by calling ExecuteStreamingSql instead.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
sql = ''
response = spanner_client.execute_sql(formatted_session, sql)

Parameters:

  • session (String)

    Required. The session in which the SQL query should be performed.

  • sql (String)

    Required. The SQL query string.

  • transaction (Google::Spanner::V1::TransactionSelector | Hash)

    The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. A hash of the same form as Google::Spanner::V1::TransactionSelector can also be provided.

  • params (Google::Protobuf::Struct | Hash)

    The SQL query string can contain parameter placeholders. A parameter placeholder consists of +'@'+ followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores.

    Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: +"WHERE id > @msg_id AND id < @msg_id + 100"+

    It is an error to execute an SQL query with unbound parameters.

    Parameter values are specified using +params+, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. A hash of the same form as Google::Protobuf::Struct can also be provided.

  • param_types (Hash{String => Google::Spanner::V1::Type | Hash})

    It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type +BYTES+ and values of type +STRING+ both appear in params as JSON strings.

    In these cases, +param_types+ can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. A hash of the same form as Google::Spanner::V1::Type can also be provided.

  • resume_token (String)

    If this request is resuming a previously interrupted SQL query execution, +resume_token+ should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.

  • query_mode (Google::Spanner::V1::ExecuteSqlRequest::QueryMode)

    Used to control the amount of debugging information returned in ResultSetStats.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 501

def execute_sql \
    session,
    sql,
    transaction: nil,
    params: nil,
    param_types: nil,
    resume_token: nil,
    query_mode: nil,
    options: nil
  req = {
    session: session,
    sql: sql,
    transaction: transaction,
    params: params,
    param_types: param_types,
    resume_token: resume_token,
    query_mode: query_mode
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::ExecuteSqlRequest)
  @execute_sql.call(req, options)
end

#execute_streaming_sql(session, sql, transaction: nil, params: nil, param_types: nil, resume_token: nil, query_mode: nil, options: nil) ⇒ Enumerable<Google::Spanner::V1::PartialResultSet>

Like ExecuteSql, except returns the result set as a stream. Unlike ExecuteSql, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
sql = ''
spanner_client.execute_streaming_sql(formatted_session, sql).each do |element|
  # Process element.
end

Parameters:

  • session (String)

    Required. The session in which the SQL query should be performed.

  • sql (String)

    Required. The SQL query string.

  • transaction (Google::Spanner::V1::TransactionSelector | Hash)

    The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. A hash of the same form as Google::Spanner::V1::TransactionSelector can also be provided.

  • params (Google::Protobuf::Struct | Hash)

    The SQL query string can contain parameter placeholders. A parameter placeholder consists of +'@'+ followed by the parameter name. Parameter names consist of any combination of letters, numbers, and underscores.

    Parameters can appear anywhere that a literal value is expected. The same parameter name can be used more than once, for example: +"WHERE id > @msg_id AND id < @msg_id + 100"+

    It is an error to execute an SQL query with unbound parameters.

    Parameter values are specified using +params+, which is a JSON object whose keys are parameter names, and whose values are the corresponding parameter values. A hash of the same form as Google::Protobuf::Struct can also be provided.

  • param_types (Hash{String => Google::Spanner::V1::Type | Hash})

    It is not always possible for Cloud Spanner to infer the right SQL type from a JSON value. For example, values of type +BYTES+ and values of type +STRING+ both appear in params as JSON strings.

    In these cases, +param_types+ can be used to specify the exact SQL type for some or all of the SQL query parameters. See the definition of Type for more information about SQL types. A hash of the same form as Google::Spanner::V1::Type can also be provided.

  • resume_token (String)

    If this request is resuming a previously interrupted SQL query execution, +resume_token+ should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new SQL query execution to resume where the last one left off. The rest of the request parameters must exactly match the request that yielded this token.

  • query_mode (Google::Spanner::V1::ExecuteSqlRequest::QueryMode)

    Used to control the amount of debugging information returned in ResultSetStats.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 593

def execute_streaming_sql \
    session,
    sql,
    transaction: nil,
    params: nil,
    param_types: nil,
    resume_token: nil,
    query_mode: nil,
    options: nil
  req = {
    session: session,
    sql: sql,
    transaction: transaction,
    params: params,
    param_types: param_types,
    resume_token: resume_token,
    query_mode: query_mode
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::ExecuteSqlRequest)
  @execute_streaming_sql.call(req, options)
end

#get_session(name, options: nil) ⇒ Google::Spanner::V1::Session

Gets a session. Returns +NOT_FOUND+ if the session does not exist. This is mainly useful for determining whether a session is still alive.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_name = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
response = spanner_client.get_session(formatted_name)

Parameters:

  • name (String)

    Required. The name of the session to retrieve.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



330
331
332
333
334
335
336
337
338
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 330

def get_session \
    name,
    options: nil
  req = {
    name: name
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::GetSessionRequest)
  @get_session.call(req, options)
end

#list_sessions(database, page_size: nil, filter: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Spanner::V1::Session>

Lists all sessions in a given database.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_database = Google::Cloud::Spanner::V1::SpannerClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]")

# Iterate over all results.
spanner_client.list_sessions(formatted_database).each do |element|
  # Process element.
end

# Or iterate over results one page at a time.
spanner_client.list_sessions(formatted_database).each_page do |page|
  # Process each page at a time.
  page.each do |element|
    # Process element.
  end
end

Parameters:

  • database (String)

    Required. The database in which to list sessions.

  • page_size (Integer)

    The maximum number of resources contained in the underlying API response. If page streaming is performed per-resource, this parameter does not affect the return value. If page streaming is performed per-page, this determines the maximum number of resources in a page.

  • filter (String)

    An expression for filtering the results of the request. Filter rules are case insensitive. The fields eligible for filtering are:

    • +labels.key+ where key is the name of a label

    Some examples of using filters are:

    • +labels.env:*+ --> The session has the label "env".
      • +labels.env:dev+ --> The session has the label "env" and the value of the label contains the string "dev".
  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

  • (Google::Gax::PagedEnumerable<Google::Spanner::V1::Session>)

    An enumerable of Google::Spanner::V1::Session instances. See Google::Gax::PagedEnumerable documentation for other operations such as per-page iteration or access to the response object.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



389
390
391
392
393
394
395
396
397
398
399
400
401
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 389

def list_sessions \
    database,
    page_size: nil,
    filter: nil,
    options: nil
  req = {
    database: database,
    page_size: page_size,
    filter: filter
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::ListSessionsRequest)
  @list_sessions.call(req, options)
end

#read(session, table, columns, key_set, transaction: nil, index: nil, limit: nil, resume_token: nil, options: nil) ⇒ Google::Spanner::V1::ResultSet

Reads rows from the database using key lookups and scans, as a simple key/value style alternative to ExecuteSql. This method cannot be used to return a result set larger than 10 MiB; if the read matches more data than that, the read fails with a +FAILED_PRECONDITION+ error.

Reads inside read-write transactions might return +ABORTED+. If this occurs, the application should restart the transaction from the beginning. See Transaction for more details.

Larger result sets can be yielded in streaming fashion by calling StreamingRead instead.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
table = ''
columns = []
key_set = {}
response = spanner_client.read(formatted_session, table, columns, key_set)

Parameters:

  • session (String)

    Required. The session in which the read should be performed.

  • table (String)

    Required. The name of the table in the database to be read.

  • columns (Array<String>)

    The columns of table to be returned for each row matching this request.

  • key_set (Google::Spanner::V1::KeySet | Hash)

    Required. +key_set+ identifies the rows to be yielded. +key_set+ names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

    Rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty).

    It is not an error for the +key_set+ to name rows that do not exist in the database. Read yields nothing for nonexistent rows. A hash of the same form as Google::Spanner::V1::KeySet can also be provided.

  • transaction (Google::Spanner::V1::TransactionSelector | Hash)

    The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. A hash of the same form as Google::Spanner::V1::TransactionSelector can also be provided.

  • index (String)

    If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

  • limit (Integer)

    If greater than zero, only the first +limit+ rows are yielded. If +limit+ is zero, the default is no limit.

  • resume_token (String)

    If this request is resuming a previously interrupted read, +resume_token+ should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 683

def read \
    session,
    table,
    columns,
    key_set,
    transaction: nil,
    index: nil,
    limit: nil,
    resume_token: nil,
    options: nil
  req = {
    session: session,
    table: table,
    columns: columns,
    key_set: key_set,
    transaction: transaction,
    index: index,
    limit: limit,
    resume_token: resume_token
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::ReadRequest)
  @read.call(req, options)
end

#rollback(session, transaction_id, options: nil) ⇒ Object

Rolls back a transaction, releasing any locks it holds. It is a good idea to call this for any transaction that includes one or more Read or ExecuteSql requests and ultimately decides not to commit.

+Rollback+ returns +OK+ if it successfully aborts the transaction, the transaction was already aborted, or the transaction is not found. +Rollback+ never returns +ABORTED+.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
transaction_id = ''
spanner_client.rollback(formatted_session, transaction_id)

Parameters:

  • session (String)

    Required. The session in which the transaction to roll back is running.

  • transaction_id (String)

    Required. The transaction to roll back.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



916
917
918
919
920
921
922
923
924
925
926
927
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 916

def rollback \
    session,
    transaction_id,
    options: nil
  req = {
    session: session,
    transaction_id: transaction_id
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::RollbackRequest)
  @rollback.call(req, options)
  nil
end

#streaming_read(session, table, columns, key_set, transaction: nil, index: nil, limit: nil, resume_token: nil, options: nil) ⇒ Enumerable<Google::Spanner::V1::PartialResultSet>

Like Read, except returns the result set as a stream. Unlike Read, there is no limit on the size of the returned result set. However, no individual row in the result set can exceed 100 MiB, and no column value can exceed 10 MiB.

Examples:

require "google/cloud/spanner/v1"

spanner_client = Google::Cloud::Spanner::V1.new
formatted_session = Google::Cloud::Spanner::V1::SpannerClient.session_path("[PROJECT]", "[INSTANCE]", "[DATABASE]", "[SESSION]")
table = ''
columns = []
key_set = {}
spanner_client.streaming_read(formatted_session, table, columns, key_set).each do |element|
  # Process element.
end

Parameters:

  • session (String)

    Required. The session in which the read should be performed.

  • table (String)

    Required. The name of the table in the database to be read.

  • columns (Array<String>)

    The columns of table to be returned for each row matching this request.

  • key_set (Google::Spanner::V1::KeySet | Hash)

    Required. +key_set+ identifies the rows to be yielded. +key_set+ names the primary keys of the rows in table to be yielded, unless index is present. If index is present, then key_set instead names index keys in index.

    Rows are yielded in table primary key order (if index is empty) or index key order (if index is non-empty).

    It is not an error for the +key_set+ to name rows that do not exist in the database. Read yields nothing for nonexistent rows. A hash of the same form as Google::Spanner::V1::KeySet can also be provided.

  • transaction (Google::Spanner::V1::TransactionSelector | Hash)

    The transaction to use. If none is provided, the default is a temporary read-only transaction with strong concurrency. A hash of the same form as Google::Spanner::V1::TransactionSelector can also be provided.

  • index (String)

    If non-empty, the name of an index on table. This index is used instead of the table primary key when interpreting key_set and sorting result rows. See key_set for further information.

  • limit (Integer)

    If greater than zero, only the first +limit+ rows are yielded. If +limit+ is zero, the default is no limit.

  • resume_token (String)

    If this request is resuming a previously interrupted read, +resume_token+ should be copied from the last PartialResultSet yielded before the interruption. Doing this enables the new read to resume where the last read left off. The rest of the request parameters must exactly match the request that yielded this token.

  • options (Google::Gax::CallOptions)

    Overrides the default settings for this call, e.g, timeout, retries, etc.

Returns:

Raises:

  • (Google::Gax::GaxError)

    if the RPC is aborted.



771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
# File 'lib/google/cloud/spanner/v1/spanner_client.rb', line 771

def streaming_read \
    session,
    table,
    columns,
    key_set,
    transaction: nil,
    index: nil,
    limit: nil,
    resume_token: nil,
    options: nil
  req = {
    session: session,
    table: table,
    columns: columns,
    key_set: key_set,
    transaction: transaction,
    index: index,
    limit: limit,
    resume_token: resume_token
  }.delete_if { |_, v| v.nil? }
  req = Google::Gax::to_proto(req, Google::Spanner::V1::ReadRequest)
  @streaming_read.call(req, options)
end