DatabaseArgs

data class DatabaseArgs(val createStatement: Output<String>? = null, val databaseDialect: Output<DatabaseDatabaseDialect>? = null, val encryptionConfig: Output<EncryptionConfigArgs>? = null, val extraStatements: Output<List<String>>? = null, val instanceId: Output<String>? = null, val project: Output<String>? = null, val protoDescriptors: Output<String>? = null) : ConvertibleToJava<DatabaseArgs>

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 /operations/ and can be used to track preparation of the database. The metadata field type is CreateDatabaseMetadata. The response field type is Database, if successful. Auto-naming is currently not supported for this resource.

Constructors

Link copied to clipboard
fun DatabaseArgs(createStatement: Output<String>? = null, databaseDialect: Output<DatabaseDatabaseDialect>? = null, encryptionConfig: Output<EncryptionConfigArgs>? = null, extraStatements: Output<List<String>>? = null, instanceId: Output<String>? = null, project: Output<String>? = null, protoDescriptors: Output<String>? = null)

Functions

Link copied to clipboard
open override fun toJava(): DatabaseArgs

Properties

Link copied to clipboard
val createStatement: Output<String>? = null

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] 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 (` ` `).

Link copied to clipboard

Optional. The dialect of the Cloud Spanner Database.

Link copied to clipboard

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.

Link copied to clipboard
val extraStatements: Output<List<String>>? = null

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.

Link copied to clipboard
val instanceId: Output<String>? = null
Link copied to clipboard
val project: Output<String>? = null
Link copied to clipboard
val protoDescriptors: Output<String>? = null

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.