Cloud Spanner V1 Client - Class DdlStatementActionInfo (1.87.0)

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

Action information extracted from a DDL statement. This proto is used to display the brief info of the DDL statement for the operation UpdateDatabaseDdl.

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

Namespace

Google \ Cloud \ Spanner \ Admin \ Database \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

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

The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc. This field is a non-empty string.
↳ entity_type string

The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc. This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", entity_type = "".
↳ entity_names array

The entity name(s) being operated on the DDL statement. E.g. 1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"]. 2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"]. 3. For statement "ANALYZE", entity_names = [].

getAction

The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc.

This field is a non-empty string.

Returns
Type Description
string

setAction

The action for the DDL statement, e.g. CREATE, ALTER, DROP, GRANT, etc.

This field is a non-empty string.

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityType

The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc.

This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", entity_type = "".

Returns
Type Description
string

setEntityType

The entity type for the DDL statement, e.g. TABLE, INDEX, VIEW, etc.

This field can be empty string for some DDL statement, e.g. for statement "ANALYZE", entity_type = "".

Parameter
Name Description
var string
Returns
Type Description
$this

getEntityNames

The entity name(s) being operated on the DDL statement.

E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].
Returns
Type Description
Google\Protobuf\Internal\RepeatedField

setEntityNames

The entity name(s) being operated on the DDL statement.

E.g.

  1. For statement "CREATE TABLE t1(...)", entity_names = ["t1"].
  2. For statement "GRANT ROLE r1, r2 ...", entity_names = ["r1", "r2"].
  3. For statement "ANALYZE", entity_names = [].
Parameter
Name Description
var string[]
Returns
Type Description
$this