Class: Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient
- Inherits:
-
Object
- Object
- Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient
- Defined in:
- lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb
Overview
Cloud Spanner Database Admin API
The Cloud Spanner Database Admin API can be used to create, drop, and list databases. It also enables updating the schema of pre-existing 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.admin" ].freeze
Instance Attribute Summary collapse
Class Method Summary collapse
-
.database_path(project, instance, database) ⇒ String
Returns a fully-qualified database resource name string.
-
.instance_path(project, instance) ⇒ String
Returns a fully-qualified instance resource name string.
-
.match_database_from_database_name(database_name) ⇒ String
Parses the database from a database resource.
-
.match_instance_from_database_name(database_name) ⇒ String
Parses the instance from a database resource.
-
.match_instance_from_instance_name(instance_name) ⇒ String
Parses the instance from a instance resource.
-
.match_project_from_database_name(database_name) ⇒ String
Parses the project from a database resource.
-
.match_project_from_instance_name(instance_name) ⇒ String
Parses the project from a instance resource.
Instance Method Summary collapse
-
#create_database(parent, create_statement, extra_statements: nil, options: nil) ⇒ Google::Gax::Operation
Creates a new Cloud Spanner database and starts to prepare it for serving.
-
#drop_database(database, options: nil) ⇒ Object
Drops (aka deletes) a Cloud Spanner database.
-
#get_database(name, options: nil) ⇒ Google::Spanner::Admin::Database::V1::Database
Gets the state of a Cloud Spanner database.
-
#get_database_ddl(database, options: nil) ⇒ Google::Spanner::Admin::Database::V1::GetDatabaseDdlResponse
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements.
-
#get_iam_policy(resource, options: nil) ⇒ Google::Iam::V1::Policy
Gets the access control policy for a database resource.
-
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ DatabaseAdminClient
constructor
A new instance of DatabaseAdminClient.
-
#list_databases(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::V1::Database>
Lists Cloud Spanner databases.
-
#set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy
Sets the access control policy on a database resource.
-
#test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified database resource.
-
#update_database_ddl(database, statements, operation_id: nil, options: nil) ⇒ Google::Gax::Operation
Updates the schema of a Cloud Spanner database by creating/altering/dropping tables, columns, indexes, etc.
Constructor Details
#initialize(service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, lib_name: nil, lib_version: "") ⇒ DatabaseAdminClient
Returns a new instance of DatabaseAdminClient
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 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 161 def initialize \ service_path: SERVICE_ADDRESS, port: DEFAULT_SERVICE_PORT, channel: nil, chan_creds: nil, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, 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/admin/database/v1/spanner_database_admin_services_pb" @operations_client = Google::Longrunning::OperationsClient.new( service_path: service_path, port: port, channel: channel, chan_creds: chan_creds, scopes: scopes, client_config: client_config, timeout: timeout, app_name: app_name, app_version: app_version, lib_name: lib_name, lib_version: lib_version, ) if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 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( "database_admin_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.spanner.admin.database.v1.DatabaseAdmin", 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 @database_admin_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, scopes: scopes, &Google::Spanner::Admin::Database::V1::DatabaseAdmin::Stub.method(:new) ) @list_databases = Google::Gax.create_api_call( @database_admin_stub.method(:list_databases), defaults["list_databases"] ) @create_database = Google::Gax.create_api_call( @database_admin_stub.method(:create_database), defaults["create_database"] ) @get_database = Google::Gax.create_api_call( @database_admin_stub.method(:get_database), defaults["get_database"] ) @update_database_ddl = Google::Gax.create_api_call( @database_admin_stub.method(:update_database_ddl), defaults["update_database_ddl"] ) @drop_database = Google::Gax.create_api_call( @database_admin_stub.method(:drop_database), defaults["drop_database"] ) @get_database_ddl = Google::Gax.create_api_call( @database_admin_stub.method(:get_database_ddl), defaults["get_database_ddl"] ) @set_iam_policy = Google::Gax.create_api_call( @database_admin_stub.method(:set_iam_policy), defaults["set_iam_policy"] ) @get_iam_policy = Google::Gax.create_api_call( @database_admin_stub.method(:get_iam_policy), defaults["get_iam_policy"] ) @test_iam_permissions = Google::Gax.create_api_call( @database_admin_stub.method(:test_iam_permissions), defaults["test_iam_permissions"] ) end |
Instance Attribute Details
#database_admin_stub ⇒ Google::Spanner::Admin::Database::V1::DatabaseAdmin::Stub (readonly)
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 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 48 class DatabaseAdminClient attr_reader :database_admin_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_databases" => Google::Gax::PageDescriptor.new( "page_token", "next_page_token", "databases") }.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.admin" ].freeze INSTANCE_PATH_TEMPLATE = Google::Gax::PathTemplate.new( "projects/{project}/instances/{instance}" ) private_constant :INSTANCE_PATH_TEMPLATE DATABASE_PATH_TEMPLATE = Google::Gax::PathTemplate.new( "projects/{project}/instances/{instance}/databases/{database}" ) private_constant :DATABASE_PATH_TEMPLATE # Returns a fully-qualified instance resource name string. # @param project [String] # @param instance [String] # @return [String] def self.instance_path project, instance INSTANCE_PATH_TEMPLATE.render( :"project" => project, :"instance" => instance ) end # 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 # Parses the project from a instance resource. # @param instance_name [String] # @return [String] def self.match_project_from_instance_name instance_name INSTANCE_PATH_TEMPLATE.match(instance_name)["project"] end # Parses the instance from a instance resource. # @param instance_name [String] # @return [String] def self.match_instance_from_instance_name instance_name INSTANCE_PATH_TEMPLATE.match(instance_name)["instance"] end # Parses the project from a database resource. # @param database_name [String] # @return [String] def self.match_project_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["project"] end # Parses the instance from a database resource. # @param database_name [String] # @return [String] def self.match_instance_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["instance"] end # Parses the database from a database resource. # @param database_name [String] # @return [String] def self.match_database_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["database"] end # @param service_path [String] # The domain name of the API remote host. # @param port [Integer] # The port on which to connect to the remote host. # @param channel [Channel] # A Channel object through which to make calls. # @param chan_creds [Grpc::ChannelCredentials] # A ChannelCredentials for the setting up the RPC client. # @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, scopes: ALL_SCOPES, client_config: {}, timeout: DEFAULT_TIMEOUT, app_name: nil, app_version: nil, 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/admin/database/v1/spanner_database_admin_services_pb" @operations_client = Google::Longrunning::OperationsClient.new( service_path: service_path, port: port, channel: channel, chan_creds: chan_creds, scopes: scopes, client_config: client_config, timeout: timeout, app_name: app_name, app_version: app_version, lib_name: lib_name, lib_version: lib_version, ) if app_name || app_version warn "`app_name` and `app_version` are no longer being used in the request headers." end google_api_client = "gl-ruby/#{RUBY_VERSION}" google_api_client << " #{lib_name}/#{lib_version}" if lib_name google_api_client << " gapic/0.6.8 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( "database_admin_client_config.json" ) defaults = client_config_file.open do |f| Google::Gax.construct_settings( "google.spanner.admin.database.v1.DatabaseAdmin", 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 @database_admin_stub = Google::Gax::Grpc.create_stub( service_path, port, chan_creds: chan_creds, channel: channel, scopes: scopes, &Google::Spanner::Admin::Database::V1::DatabaseAdmin::Stub.method(:new) ) @list_databases = Google::Gax.create_api_call( @database_admin_stub.method(:list_databases), defaults["list_databases"] ) @create_database = Google::Gax.create_api_call( @database_admin_stub.method(:create_database), defaults["create_database"] ) @get_database = Google::Gax.create_api_call( @database_admin_stub.method(:get_database), defaults["get_database"] ) @update_database_ddl = Google::Gax.create_api_call( @database_admin_stub.method(:update_database_ddl), defaults["update_database_ddl"] ) @drop_database = Google::Gax.create_api_call( @database_admin_stub.method(:drop_database), defaults["drop_database"] ) @get_database_ddl = Google::Gax.create_api_call( @database_admin_stub.method(:get_database_ddl), defaults["get_database_ddl"] ) @set_iam_policy = Google::Gax.create_api_call( @database_admin_stub.method(:set_iam_policy), defaults["set_iam_policy"] ) @get_iam_policy = Google::Gax.create_api_call( @database_admin_stub.method(:get_iam_policy), defaults["get_iam_policy"] ) @test_iam_permissions = Google::Gax.create_api_call( @database_admin_stub.method(:test_iam_permissions), defaults["test_iam_permissions"] ) end # Service calls # Lists Cloud Spanner databases. # # @param parent [String] # Required. The instance whose databases should be listed. # Values are of the form +projects/<project>/instances/<instance>+. # @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 options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::V1::Database>] # An enumerable of Google::Spanner::Admin::Database::V1::Database 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/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_parent = DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]") # # # Iterate over all results. # database_admin_client.list_databases(formatted_parent).each do |element| # # Process element. # end # # # Or iterate over results one page at a time. # database_admin_client.list_databases(formatted_parent).each_page do |page| # # Process each page at a time. # page.each do |element| # # Process element. # end # end def list_databases \ parent, page_size: nil, options: nil req = Google::Spanner::Admin::Database::V1::ListDatabasesRequest.new({ parent: parent, page_size: page_size }.delete_if { |_, v| v.nil? }) @list_databases.call(req, ) end # Creates a new Cloud Spanner database and starts to prepare it for serving. # The returned Long-running operation will # have a name of the format +<database_name>/operations/<operation_id>+ and # can be used to track preparation of the database. The # Metadata field type is # CreateDatabaseMetadata. The # Response field type is # Database, if successful. # # @param parent [String] # Required. The name of the instance that will serve the new database. # Values are of the form +projects/<project>/instances/<instance>+. # @param create_statement [String] # Required. A +CREATE DATABASE+ statement, which specifies the ID of the # new database. The database ID must conform to the regular expression # +[a-z][a-z0-9_\-]*[a-z0-9]+ and be between 2 and 30 characters in length. # @param extra_statements [Array<String>] # An optional list of DDL statements to run inside the newly created # database. Statements can create tables, indexes, etc. These # statements execute atomically with the creation of the database: # if there is an error in any statement, the database is not created. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Gax::Operation] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_parent = DatabaseAdminClient.instance_path("[PROJECT]", "[INSTANCE]") # create_statement = '' # # # Register a callback during the method call. # operation = database_admin_client.create_database(formatted_parent, create_statement) do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Or use the return value to register a callback. # operation.on_done do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Manually reload the operation. # operation.reload! # # # Or block until the operation completes, triggering callbacks on # # completion. # operation.wait_until_done! def create_database \ parent, create_statement, extra_statements: nil, options: nil req = Google::Spanner::Admin::Database::V1::CreateDatabaseRequest.new({ parent: parent, create_statement: create_statement, extra_statements: extra_statements }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @create_database.call(req, ), @operations_client, Google::Spanner::Admin::Database::V1::Database, Google::Spanner::Admin::Database::V1::CreateDatabaseMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end # Gets the state of a Cloud Spanner database. # # @param name [String] # Required. The name of the requested database. Values are of the form # +projects/<project>/instances/<instance>/databases/<database>+. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Spanner::Admin::Database::V1::Database] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_name = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # response = database_admin_client.get_database(formatted_name) def get_database \ name, options: nil req = Google::Spanner::Admin::Database::V1::GetDatabaseRequest.new({ name: name }.delete_if { |_, v| v.nil? }) @get_database.call(req, ) end # Updates the schema of a Cloud Spanner database by # creating/altering/dropping tables, columns, indexes, etc. The returned # Long-running operation will have a name of # the format +<database_name>/operations/<operation_id>+ and can be used to # track execution of the schema change(s). The # Metadata field type is # UpdateDatabaseDdlMetadata. The operation has no response. # # @param database [String] # Required. The database to update. # @param statements [Array<String>] # DDL statements to be applied to the database. # @param operation_id [String] # If empty, the new update request is assigned an # automatically-generated operation ID. Otherwise, +operation_id+ # is used to construct the name of the resulting # Operation. # # Specifying an explicit operation ID simplifies determining # whether the statements were executed in the event that the # UpdateDatabaseDdl call is replayed, # or the return value is otherwise lost: the Database and # +operation_id+ fields can be combined to form the # Name of the resulting # Longrunning::Operation: +<database>/operations/<operation_id>+. # # +operation_id+ should be unique within the database, and must be # a valid identifier: +[a-z][a-z0-9_]*+. Note that # automatically-generated operation IDs always begin with an # underscore. If the named operation already exists, # UpdateDatabaseDdl returns # +ALREADY_EXISTS+. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Gax::Operation] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_database = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # statements = [] # # # Register a callback during the method call. # operation = database_admin_client.update_database_ddl(formatted_database, statements) do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Or use the return value to register a callback. # operation.on_done do |op| # raise op.results.message if op.error? # op_results = op.results # # Process the results. # # metadata = op.metadata # # Process the metadata. # end # # # Manually reload the operation. # operation.reload! # # # Or block until the operation completes, triggering callbacks on # # completion. # operation.wait_until_done! def update_database_ddl \ database, statements, operation_id: nil, options: nil req = Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest.new({ database: database, statements: statements, operation_id: operation_id }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @update_database_ddl.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end # Drops (aka deletes) a Cloud Spanner database. # # @param database [String] # Required. The database to be dropped. # @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/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_database = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # database_admin_client.drop_database(formatted_database) def drop_database \ database, options: nil req = Google::Spanner::Admin::Database::V1::DropDatabaseRequest.new({ database: database }.delete_if { |_, v| v.nil? }) @drop_database.call(req, ) nil end # Returns the schema of a Cloud Spanner database as a list of formatted # DDL statements. This method does not show pending schema updates, those may # be queried using the Operations API. # # @param database [String] # Required. The database whose schema we wish to get. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Spanner::Admin::Database::V1::GetDatabaseDdlResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_database = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # response = database_admin_client.get_database_ddl(formatted_database) def get_database_ddl \ database, options: nil req = Google::Spanner::Admin::Database::V1::GetDatabaseDdlRequest.new({ database: database }.delete_if { |_, v| v.nil? }) @get_database_ddl.call(req, ) end # Sets the access control policy on a database resource. Replaces any # existing policy. # # Authorization requires +spanner.databases.setIamPolicy+ permission on # Resource. # # @param resource [String] # REQUIRED: The resource for which the policy is being specified. # +resource+ is usually specified as a path. For example, a Project # resource is specified as +projects/{project}+. # @param policy [Google::Iam::V1::Policy] # REQUIRED: The complete policy to be applied to the +resource+. The size of # the policy is limited to a few 10s of KB. An empty policy is a # valid policy but certain Cloud Platform services (such as Projects) # might reject them. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Iam::V1::Policy] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # Policy = Google::Iam::V1::Policy # # database_admin_client = DatabaseAdminClient.new # formatted_resource = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # policy = Policy.new # response = database_admin_client.set_iam_policy(formatted_resource, policy) def set_iam_policy \ resource, policy, options: nil req = Google::Iam::V1::SetIamPolicyRequest.new({ resource: resource, policy: policy }.delete_if { |_, v| v.nil? }) @set_iam_policy.call(req, ) end # Gets the access control policy for a database resource. Returns an empty # policy if a database exists but does not have a policy set. # # Authorization requires +spanner.databases.getIamPolicy+ permission on # Resource. # # @param resource [String] # REQUIRED: The resource for which the policy is being requested. # +resource+ is usually specified as a path. For example, a Project # resource is specified as +projects/{project}+. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Iam::V1::Policy] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_resource = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # response = database_admin_client.get_iam_policy(formatted_resource) def get_iam_policy \ resource, options: nil req = Google::Iam::V1::GetIamPolicyRequest.new({ resource: resource }.delete_if { |_, v| v.nil? }) @get_iam_policy.call(req, ) end # Returns permissions that the caller has on the specified database resource. # # Attempting this RPC on a non-existent Cloud Spanner database will result in # a NOT_FOUND error if the user has +spanner.databases.list+ permission on # the containing Cloud Spanner instance. Otherwise returns an empty set of # permissions. # # @param resource [String] # REQUIRED: The resource for which the policy detail is being requested. # +resource+ is usually specified as a path. For example, a Project # resource is specified as +projects/{project}+. # @param permissions [Array<String>] # The set of permissions to check for the +resource+. Permissions with # wildcards (such as '*' or 'storage.*') are not allowed. For more # information see # {IAM Overview}[https://cloud.google.com/iam/docs/overview#permissions]. # @param options [Google::Gax::CallOptions] # Overrides the default settings for this call, e.g, timeout, # retries, etc. # @return [Google::Iam::V1::TestIamPermissionsResponse] # @raise [Google::Gax::GaxError] if the RPC is aborted. # @example # require "google/cloud/spanner/admin/database/v1/database_admin_client" # # DatabaseAdminClient = Google::Cloud::Spanner::Admin::Database::V1::DatabaseAdminClient # # database_admin_client = DatabaseAdminClient.new # formatted_resource = DatabaseAdminClient.database_path("[PROJECT]", "[INSTANCE]", "[DATABASE]") # permissions = [] # response = database_admin_client.test_iam_permissions(formatted_resource, permissions) def \ resource, , options: nil req = Google::Iam::V1::TestIamPermissionsRequest.new({ resource: resource, permissions: }.delete_if { |_, v| v.nil? }) @test_iam_permissions.call(req, ) end end |
Class Method Details
.database_path(project, instance, database) ⇒ String
Returns a fully-qualified database resource name string.
103 104 105 106 107 108 109 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 103 def self.database_path project, instance, database DATABASE_PATH_TEMPLATE.render( :"project" => project, :"instance" => instance, :"database" => database ) end |
.instance_path(project, instance) ⇒ String
Returns a fully-qualified instance resource name string.
91 92 93 94 95 96 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 91 def self.instance_path project, instance INSTANCE_PATH_TEMPLATE.render( :"project" => project, :"instance" => instance ) end |
.match_database_from_database_name(database_name) ⇒ String
Parses the database from a database resource.
142 143 144 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 142 def self.match_database_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["database"] end |
.match_instance_from_database_name(database_name) ⇒ String
Parses the instance from a database resource.
135 136 137 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 135 def self.match_instance_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["instance"] end |
.match_instance_from_instance_name(instance_name) ⇒ String
Parses the instance from a instance resource.
121 122 123 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 121 def self.match_instance_from_instance_name instance_name INSTANCE_PATH_TEMPLATE.match(instance_name)["instance"] end |
.match_project_from_database_name(database_name) ⇒ String
Parses the project from a database resource.
128 129 130 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 128 def self.match_project_from_database_name database_name DATABASE_PATH_TEMPLATE.match(database_name)["project"] end |
.match_project_from_instance_name(instance_name) ⇒ String
Parses the project from a instance resource.
114 115 116 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 114 def self.match_project_from_instance_name instance_name INSTANCE_PATH_TEMPLATE.match(instance_name)["project"] end |
Instance Method Details
#create_database(parent, create_statement, extra_statements: nil, options: nil) ⇒ Google::Gax::Operation
Creates a new Cloud Spanner database and starts to prepare it for serving.
The returned Long-running operation will
have a name of the format +
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 382 def create_database \ parent, create_statement, extra_statements: nil, options: nil req = Google::Spanner::Admin::Database::V1::CreateDatabaseRequest.new({ parent: parent, create_statement: create_statement, extra_statements: extra_statements }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @create_database.call(req, ), @operations_client, Google::Spanner::Admin::Database::V1::Database, Google::Spanner::Admin::Database::V1::CreateDatabaseMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |
#drop_database(database, options: nil) ⇒ Object
Drops (aka deletes) a Cloud Spanner database.
542 543 544 545 546 547 548 549 550 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 542 def drop_database \ database, options: nil req = Google::Spanner::Admin::Database::V1::DropDatabaseRequest.new({ database: database }.delete_if { |_, v| v.nil? }) @drop_database.call(req, ) nil end |
#get_database(name, options: nil) ⇒ Google::Spanner::Admin::Database::V1::Database
Gets the state of a Cloud Spanner database.
422 423 424 425 426 427 428 429 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 422 def get_database \ name, options: nil req = Google::Spanner::Admin::Database::V1::GetDatabaseRequest.new({ name: name }.delete_if { |_, v| v.nil? }) @get_database.call(req, ) end |
#get_database_ddl(database, options: nil) ⇒ Google::Spanner::Admin::Database::V1::GetDatabaseDdlResponse
Returns the schema of a Cloud Spanner database as a list of formatted DDL statements. This method does not show pending schema updates, those may be queried using the Operations API.
572 573 574 575 576 577 578 579 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 572 def get_database_ddl \ database, options: nil req = Google::Spanner::Admin::Database::V1::GetDatabaseDdlRequest.new({ database: database }.delete_if { |_, v| v.nil? }) @get_database_ddl.call(req, ) end |
#get_iam_policy(resource, options: nil) ⇒ Google::Iam::V1::Policy
Gets the access control policy for a database resource. Returns an empty policy if a database exists but does not have a policy set.
Authorization requires +spanner.databases.getIamPolicy+ permission on Resource.
647 648 649 650 651 652 653 654 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 647 def get_iam_policy \ resource, options: nil req = Google::Iam::V1::GetIamPolicyRequest.new({ resource: resource }.delete_if { |_, v| v.nil? }) @get_iam_policy.call(req, ) end |
#list_databases(parent, page_size: nil, options: nil) ⇒ Google::Gax::PagedEnumerable<Google::Spanner::Admin::Database::V1::Database>
Lists Cloud Spanner databases.
309 310 311 312 313 314 315 316 317 318 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 309 def list_databases \ parent, page_size: nil, options: nil req = Google::Spanner::Admin::Database::V1::ListDatabasesRequest.new({ parent: parent, page_size: page_size }.delete_if { |_, v| v.nil? }) @list_databases.call(req, ) end |
#set_iam_policy(resource, policy, options: nil) ⇒ Google::Iam::V1::Policy
Sets the access control policy on a database resource. Replaces any existing policy.
Authorization requires +spanner.databases.setIamPolicy+ permission on Resource.
612 613 614 615 616 617 618 619 620 621 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 612 def set_iam_policy \ resource, policy, options: nil req = Google::Iam::V1::SetIamPolicyRequest.new({ resource: resource, policy: policy }.delete_if { |_, v| v.nil? }) @set_iam_policy.call(req, ) end |
#test_iam_permissions(resource, permissions, options: nil) ⇒ Google::Iam::V1::TestIamPermissionsResponse
Returns permissions that the caller has on the specified database resource.
Attempting this RPC on a non-existent Cloud Spanner database will result in a NOT_FOUND error if the user has +spanner.databases.list+ permission on the containing Cloud Spanner instance. Otherwise returns an empty set of permissions.
687 688 689 690 691 692 693 694 695 696 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 687 def \ resource, , options: nil req = Google::Iam::V1::TestIamPermissionsRequest.new({ resource: resource, permissions: }.delete_if { |_, v| v.nil? }) @test_iam_permissions.call(req, ) end |
#update_database_ddl(database, statements, operation_id: nil, options: nil) ⇒ Google::Gax::Operation
Updates the schema of a Cloud Spanner database by
creating/altering/dropping tables, columns, indexes, etc. The returned
Long-running operation will have a name of
the format +
504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 |
# File 'lib/google/cloud/spanner/admin/database/v1/database_admin_client.rb', line 504 def update_database_ddl \ database, statements, operation_id: nil, options: nil req = Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlRequest.new({ database: database, statements: statements, operation_id: operation_id }.delete_if { |_, v| v.nil? }) operation = Google::Gax::Operation.new( @update_database_ddl.call(req, ), @operations_client, Google::Protobuf::Empty, Google::Spanner::Admin::Database::V1::UpdateDatabaseDdlMetadata, call_options: ) operation.on_done { |operation| yield(operation) } if block_given? operation end |