Class: Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest

Inherits:
Object
  • Object
show all
Extended by:
Protobuf::MessageExts::ClassMethods
Includes:
Protobuf::MessageExts
Defined in:
proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb

Overview

The request for CreateDatabase.

Instance Attribute Summary collapse

Instance Attribute Details

#create_statement ⇒ ::String

Returns 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. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).

Returns:

  • (::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. If the database ID is a reserved word or if it contains a hyphen, the database ID must be enclosed in backticks (`).



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#database_dialect ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect

Returns Optional. The dialect of the Cloud Spanner Database.

Returns:



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#encryption_config ⇒ ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig

Returns Optional. The encryption configuration for the database. If this field is not specified, Cloud Spanner will encrypt/decrypt all data at rest using Google default encryption.

Returns:



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#extra_statements ⇒ ::Array<::String>

Returns Optional. A 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.

Returns:

  • (::Array<::String>) —

    Optional. A 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.



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#parent ⇒ ::String

Returns Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.

Returns:

  • (::String) —

    Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end

#proto_descriptors ⇒ ::String

Returns Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run

$protoc  --proto_path=/app_path --proto_path=/lib_path \
         --include_imports \
         --descriptor_set_out=descriptors.data \
         moon/shot/app.proto

For more details, see protobuffer self description.

Returns:

  • (::String) —

    Optional. Proto descriptors used by CREATE/ALTER PROTO BUNDLE statements in 'extra_statements' above. Contains a protobuf-serialized google.protobuf.FileDescriptorSet. To generate it, install and run protoc with --include_imports and --descriptor_set_out. For example, to generate for moon/shot/app.proto, run

    $protoc  --proto_path=/app_path --proto_path=/lib_path \
         --include_imports \
         --descriptor_set_out=descriptors.data \
         moon/shot/app.proto

    For more details, see protobuffer self description.



211
212
213
214
 
# File 'proto_docs/google/spanner/admin/database/v1/spanner_database_admin.rb', line 211

class CreateDatabaseRequest
  include ::Google::Protobuf::MessageExts
  extend ::Google::Protobuf::MessageExts::ClassMethods
end