Reference documentation and code samples for the Cloud Spanner Database Admin V1 API class Google::Cloud::Spanner::Admin::Database::V1::CreateDatabaseRequest.
The request for CreateDatabase.
Inherits
- Object
Extended By
- Google::Protobuf::MessageExts::ClassMethods
Includes
- Google::Protobuf::MessageExts
Methods
#create_statement
def create_statement() -> ::String
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 (`
).
#create_statement=
def create_statement=(value) -> ::String
Parameter
-
value (::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 (`
).
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 (`
).
#database_dialect
def database_dialect() -> ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect) — Optional. The dialect of the Cloud Spanner Database.
#database_dialect=
def database_dialect=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect
Parameter
- value (::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect) — Optional. The dialect of the Cloud Spanner Database.
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::DatabaseDialect) — Optional. The dialect of the Cloud Spanner Database.
#encryption_config
def encryption_config() -> ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig
Returns
- (::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig) — 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.
#encryption_config=
def encryption_config=(value) -> ::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig
Parameter
- value (::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig) — 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
- (::Google::Cloud::Spanner::Admin::Database::V1::EncryptionConfig) — 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.
#extra_statements
def extra_statements() -> ::Array<::String>
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.
#extra_statements=
def extra_statements=(value) -> ::Array<::String>
Parameter
- value (::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.
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.
#parent
def parent() -> ::String
Returns
-
(::String) — Required. The name of the instance that will serve the new database.
Values are of the form
projects/<project>/instances/<instance>
.
#parent=
def parent=(value) -> ::String
Parameter
-
value (::String) — 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>
.
#proto_descriptors
def proto_descriptors() -> ::String
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.
#proto_descriptors=
def proto_descriptors=(value) -> ::String
Parameter
-
value (::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.
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.