Cloud Spanner V1 Client - Class UpdateDatabaseDdlMetadata (1.56.0)

Version 1.56.0

• 1.89.0 (latest)
• 1.88.0
• 1.87.0
• 1.86.0
• 1.85.0
• 1.84.0
• 1.83.0
• 1.82.0
• 1.81.0
• 1.80.0
• 1.79.0
• 1.78.0
• 1.77.0
• 1.76.1
• 1.68.0
• 1.67.0
• 1.66.0
• 1.65.0
• 1.64.0
• 1.63.2
• 1.62.1
• 1.61.0
• 1.60.0
• 1.59.0
• 1.58.4
• 1.57.0
• 1.56.0
• 1.55.0
• 1.54.2

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

Metadata type for the operation returned by UpdateDatabaseDdl.

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

Methods

__construct

Constructor.

Parameters
Name	Description
data	array Optional. Data for populating the Message object.
↳ database	string The database being modified.
↳ statements	array For an update this list contains all the statements. For an individual statement, this list contains only that statement.
↳ commit_timestamps	array<Google\Protobuf\Timestamp> Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].
↳ throttled	bool Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be false again.
↳ progress	array<Google\Cloud\Spanner\Admin\Database\V1\OperationProgress> The progress of the UpdateDatabaseDdl operations. Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

getDatabase

The database being modified.

Returns
Type	Description
string

setDatabase

The database being modified.

Parameter
Name	Description
var	string

Returns
Type	Description
$this

getStatements

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setStatements

For an update this list contains all the statements. For an individual statement, this list contains only that statement.

Parameter
Name	Description
var	string[]

Returns
Type	Description
$this

getCommitTimestamps

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setCommitTimestamps

Reports the commit timestamps of all statements that have succeeded so far, where commit_timestamps[i] is the commit timestamp for the statement statements[i].

Parameter
Name	Description
var	array<Google\Protobuf\Timestamp>

Returns
Type	Description
$this

getThrottled

Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be false again.

Returns
Type	Description
bool

setThrottled

Output only. When true, indicates that the operation is throttled e.g due to resource constraints. When resources become available the operation will resume and this field will be false again.

Parameter
Name	Description
var	bool

Returns
Type	Description
$this

getProgress

The progress of the UpdateDatabaseDdl operations.

Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

Returns
Type	Description
Google\Protobuf\Internal\RepeatedField

setProgress

The progress of the UpdateDatabaseDdl operations.

Currently, only index creation statements will have a continuously updating progress. For non-index creation statements, progress[i] will have start time and end time populated with commit timestamp of operation, as well as a progress of 100% once the operation has completed. progress[i] is the operation progress for statements[i].

Parameter
Name	Description
var	array<Google\Cloud\Spanner\Admin\Database\V1\OperationProgress>

Returns
Type	Description
$this