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
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
Instance Method Summary collapse
-
#creating? ⇒ Boolean
The database is still being created.
-
#database_id ⇒ String
The unique identifier for the 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.
-
#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
#creating? ⇒ Boolean
The database is still being created. Operations on the database may
raise with FAILED_PRECONDITION
in this state.
110 111 112 |
# File 'lib/google/cloud/spanner/database.rb', line 110 def creating? state == :CREATING end |
#database_id ⇒ String
The unique identifier for the database.
82 83 84 |
# File 'lib/google/cloud/spanner/database.rb', line 82 def database_id @grpc.name.split("/")[5] 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.
154 155 156 157 158 159 |
# File 'lib/google/cloud/spanner/database.rb', line 154 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.
221 222 223 224 225 |
# File 'lib/google/cloud/spanner/database.rb', line 221 def drop ensure_service! service.drop_database instance_id, database_id true end |
#instance_id ⇒ String
The unique identifier for the instance.
76 77 78 |
# File 'lib/google/cloud/spanner/database.rb', line 76 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.
261 262 263 264 265 266 267 268 |
# File 'lib/google/cloud/spanner/database.rb', line 261 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.
70 71 72 |
# File 'lib/google/cloud/spanner/database.rb', line 70 def project_id @grpc.name.split("/")[1] end |
#ready? ⇒ Boolean
The database is fully created and ready for use.
117 118 119 |
# File 'lib/google/cloud/spanner/database.rb', line 117 def ready? state == :READY end |
#state ⇒ Symbol
The current database state. Possible values are :CREATING
and
:READY
.
102 103 104 |
# File 'lib/google/cloud/spanner/database.rb', line 102 def state @grpc.state end |
#test_permissions(*permissions) ⇒ Array<Strings>
Tests the specified permissions against the Cloud IAM access control policy.
347 348 349 350 351 352 353 354 |
# File 'lib/google/cloud/spanner/database.rb', line 347 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.
200 201 202 203 204 205 206 |
# File 'lib/google/cloud/spanner/database.rb', line 200 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.
299 300 301 302 303 304 |
# File 'lib/google/cloud/spanner/database.rb', line 299 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 |