Cloud Spanner V1 Client - Class CreateDatabaseRequest (1.104.0)

Reference documentation and code samples for the Cloud Spanner V1 Client class CreateDatabaseRequest.

The request for CreateDatabase.

Generated from protobuf message google.spanner.admin.database.v1.CreateDatabaseRequest

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.
↳ parent string

Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>.
↳ create_statement 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 (` ).
↳ extra_statements array

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.
↳ encryption_config 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.
↳ database_dialect int

Optional. The dialect of the Cloud Spanner Database.
↳ proto_descriptors 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.

getParent

Required. The name of the instance that will serve the new database.

Values are of the form projects/<project>/instances/<instance>.

Returns
Type Description
string

setParent

Required. The name of the instance that will serve the new database.

Values are of the form projects/<project>/instances/<instance>.

Parameter
Name Description
var string
Returns
Type Description
$this

getCreateStatement

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
Type Description
string

setCreateStatement

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

Parameter
Name Description
var string
Returns
Type Description
$this

getExtraStatements

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
Type Description
Google\Protobuf\Internal\RepeatedField

setExtraStatements

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.

Parameter
Name Description
var string[]
Returns
Type Description
$this

getEncryptionConfig

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
Type Description
EncryptionConfig|null

hasEncryptionConfig

clearEncryptionConfig

setEncryptionConfig

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.

Parameter
Name Description
var EncryptionConfig
Returns
Type Description
$this

getDatabaseDialect

Optional. The dialect of the Cloud Spanner Database.

Returns
Type Description
int

setDatabaseDialect

Optional. The dialect of the Cloud Spanner Database.

Parameter
Name Description
var int
Returns
Type Description
$this

getProtoDescriptors

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
Type Description
string

setProtoDescriptors

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.

Parameter
Name Description
var string
Returns
Type Description
$this

static::build

Parameters
Name Description
parent string

Required. The name of the instance that will serve the new database. Values are of the form projects/<project>/instances/<instance>. Please see DatabaseAdminClient::instanceName() for help formatting this field.
createStatement 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
Type Description
CreateDatabaseRequest