Class: Google::Cloud::Spanner::Database
- Inherits:
-
Object
- Object
- Google::Cloud::Spanner::Database
- Defined in:
- lib/google/cloud/spanner/database.rb,
lib/google/cloud/spanner/database/job.rb,
lib/google/cloud/spanner/database/list.rb,
lib/google/cloud/spanner/database/job/list.rb,
lib/google/cloud/spanner/database/backup_info.rb,
lib/google/cloud/spanner/database/restore_info.rb
Overview
Database
Represents a Cloud Spanner database. To use Cloud Spanner's read and write operations, you must first create a database. A database belongs to a Instance and contains tables and indexes. You may create multiple databases in an Instance.
See Instance#databases, Instance#database, and Instance#create_database.
To read and/or modify data in a Cloud Spanner database, use an instance of Client. See Project#client.
Defined Under Namespace
Classes: BackupInfo, Job, List, RestoreInfo
Instance Method Summary collapse
-
#backups(page_size: nil) ⇒ Array<Google::Cloud::Spanner::Backup>
Retrieves backups belonging to the database.
-
#create_backup(backup_id, expire_time) ⇒ Google::Cloud::Spanner::Backup::Job
Creates a database backup.
-
#creating? ⇒ Boolean
The database is still being created.
-
#database_id ⇒ String
The unique identifier for the database.
-
#database_operations(filter: nil, page_size: nil) ⇒ Array<Google::Cloud::Spanner::Database::Job>
Retrieves the list of database operations for the given database.
-
#ddl(force: nil) ⇒ Array<String>
Retrieve the Data Definition Language (DDL) statements that define database structures.
-
#drop ⇒ Boolean
Drops (deletes) the Cloud Spanner database.
-
#instance_id ⇒ String
The unique identifier for the instance.
-
#path ⇒ String
The full path for the database resource.
-
#policy {|policy| ... } ⇒ Policy
Gets the Cloud IAM access control policy for this database.
-
#project_id ⇒ String
The unique identifier for the project.
-
#ready? ⇒ Boolean
The database is fully created and ready for use.
-
#ready_optimizing? ⇒ Boolean
The database is fully created from backup and optimizing.
-
#restore_info ⇒ Google::Cloud::Spanner::Database::RestoreInfo?
Information about the source used to restore the database.
-
#state ⇒ Symbol
The current database state.
-
#test_permissions(*permissions) ⇒ Array<Strings>
Tests the specified permissions against the Cloud IAM access control policy.
-
#update(statements: [], operation_id: nil) ⇒ Database::Job
Updates the database schema by adding Data Definition Language (DDL) statements to create, update, and delete tables and indexes.
-
#update_policy(new_policy) ⇒ Policy
(also: #policy=)
Updates the Cloud IAM access control policy for this database.
Instance Method Details
#backups(page_size: nil) ⇒ Array<Google::Cloud::Spanner::Backup>
Retrieves backups belonging to the database.
466 467 468 469 470 471 472 473 |
# File 'lib/google/cloud/spanner/database.rb', line 466 def backups page_size: nil ensure_service! grpc = service.list_backups \ instance_id, filter: "database:#{database_id}", page_size: page_size Backup::List.from_grpc grpc, service end |
#create_backup(backup_id, expire_time) ⇒ Google::Cloud::Spanner::Backup::Job
Creates a database backup.
427 428 429 430 431 432 433 434 435 |
# File 'lib/google/cloud/spanner/database.rb', line 427 def create_backup backup_id, expire_time ensure_service! grpc = service.create_backup \ instance_id, database_id, backup_id, expire_time Backup::Job.from_grpc grpc, service end |
#creating? ⇒ Boolean
The database is still being created. Operations on the database may
raise with FAILED_PRECONDITION
in this state.
108 109 110 |
# File 'lib/google/cloud/spanner/database.rb', line 108 def creating? state == :CREATING end |
#database_id ⇒ String
The unique identifier for the database.
84 85 86 |
# File 'lib/google/cloud/spanner/database.rb', line 84 def database_id @grpc.name.split("/")[5] end |
#database_operations(filter: nil, page_size: nil) ⇒ Array<Google::Cloud::Spanner::Database::Job>
Retrieves the list of database operations for the given database.
374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 |
# File 'lib/google/cloud/spanner/database.rb', line 374 def database_operations filter: nil, page_size: nil database_filter = format( DATBASE_OPERATION_METADAT_FILTER_TEMPLATE, database_id: database_id ) if filter database_filter = format( "(%<filter>s) AND (%<database_filter>s)", filter: filter, database_filter: database_filter ) end grpc = service.list_database_operations \ instance_id, filter: database_filter, page_size: page_size Database::Job::List.from_grpc grpc, service end |
#ddl(force: nil) ⇒ Array<String>
Retrieve the Data Definition Language (DDL) statements that define database structures. DDL statements are used to create, update, and delete tables and indexes.
159 160 161 162 163 164 |
# File 'lib/google/cloud/spanner/database.rb', line 159 def ddl force: nil return @ddl if @ddl && !force ensure_service! ddl_grpc = service.get_database_ddl instance_id, database_id @ddl = ddl_grpc.statements end |
#drop ⇒ Boolean
Drops (deletes) the Cloud Spanner database.
226 227 228 229 230 |
# File 'lib/google/cloud/spanner/database.rb', line 226 def drop ensure_service! service.drop_database instance_id, database_id true end |
#instance_id ⇒ String
The unique identifier for the instance.
78 79 80 |
# File 'lib/google/cloud/spanner/database.rb', line 78 def instance_id @grpc.name.split("/")[3] end |
#path ⇒ String
The full path for the database resource. Values are of the form
projects/<project_id>/instances/<instance_id>/databases/<database_id>
.
92 93 94 |
# File 'lib/google/cloud/spanner/database.rb', line 92 def path @grpc.name end |
#policy {|policy| ... } ⇒ Policy
Gets the Cloud IAM access control policy for this database.
517 518 519 520 521 522 523 524 |
# File 'lib/google/cloud/spanner/database.rb', line 517 def policy ensure_service! grpc = service.get_database_policy instance_id, database_id policy = Policy.from_grpc grpc return policy unless block_given? yield policy update_policy policy end |
#project_id ⇒ String
The unique identifier for the project.
72 73 74 |
# File 'lib/google/cloud/spanner/database.rb', line 72 def project_id @grpc.name.split("/")[1] end |
#ready? ⇒ Boolean
The database is fully created and ready for use.
115 116 117 |
# File 'lib/google/cloud/spanner/database.rb', line 115 def ready? state == :READY end |
#ready_optimizing? ⇒ Boolean
The database is fully created from backup and optimizing.
122 123 124 |
# File 'lib/google/cloud/spanner/database.rb', line 122 def ready_optimizing? state == :READY_OPTIMIZING end |
#restore_info ⇒ Google::Cloud::Spanner::Database::RestoreInfo?
Information about the source used to restore the database.
478 479 480 481 |
# File 'lib/google/cloud/spanner/database.rb', line 478 def restore_info return nil unless @grpc.restore_info RestoreInfo.from_grpc @grpc.restore_info end |
#state ⇒ Symbol
The current database state. Possible values are :CREATING
and
:READY
.
100 101 102 |
# File 'lib/google/cloud/spanner/database.rb', line 100 def state @grpc.state end |
#test_permissions(*permissions) ⇒ Array<Strings>
Tests the specified permissions against the Cloud IAM access control policy.
603 604 605 606 607 608 609 610 |
# File 'lib/google/cloud/spanner/database.rb', line 603 def * = Array().flatten = Array().flatten ensure_service! grpc = service. \ instance_id, database_id, grpc. end |
#update(statements: [], operation_id: nil) ⇒ Database::Job
Updates the database schema by adding Data Definition Language (DDL) statements to create, update, and delete tables and indexes.
205 206 207 208 209 210 211 |
# File 'lib/google/cloud/spanner/database.rb', line 205 def update statements: [], operation_id: nil ensure_service! grpc = service.update_database_ddl instance_id, database_id, statements: statements, operation_id: operation_id Database::Job.from_grpc grpc, service end |
#update_policy(new_policy) ⇒ Policy Also known as: policy=
Updates the Cloud IAM access control
policy for this database. The policy should be read from #policy.
See Policy for an explanation of the policy
etag
property and how to modify policies.
You can also update the policy by passing a block to #policy, which will call this method internally after the block completes.
555 556 557 558 559 560 |
# File 'lib/google/cloud/spanner/database.rb', line 555 def update_policy new_policy ensure_service! grpc = service.set_database_policy \ instance_id, database_id, new_policy.to_grpc Policy.from_grpc grpc end |