Google Cloud AlloyDB for PostgreSQL V1 Client - Class ExecuteSqlMetadata (1.1.1)

Reference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ExecuteSqlMetadata.

Any additional metadata information regarding the execution of the SQL

Generated from protobuf message google.cloud.alloydb.v1.ExecuteSqlMetadata

Namespace

Google \ Cloud \ AlloyDb \ V1

Methods

__construct

Constructor.

Parameters
Name Description
data array

Optional. Data for populating the Message object.

↳ message string

Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."

↳ partial_result bool

Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.

↳ sql_statement_execution_duration Google\Protobuf\Duration

The time duration taken to execute the sql statement.

↳ status int

Status of SQL execution.

getMessage

Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."

Returns
Type Description
string

setMessage

Message related to SQL execution. Marked as core content since it can potentially contain details related to the query or result set. This field can be used to convey messages such as "when the SQL result set exceeds the acceptable response size limits."

Parameter
Name Description
var string
Returns
Type Description
$this

getPartialResult

Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.

Returns
Type Description
bool

setPartialResult

Set to true if SQL returned a result set larger than the acceptable response size limits and the result was truncated.

Parameter
Name Description
var bool
Returns
Type Description
$this

getSqlStatementExecutionDuration

The time duration taken to execute the sql statement.

Returns
Type Description
Google\Protobuf\Duration|null

hasSqlStatementExecutionDuration

clearSqlStatementExecutionDuration

setSqlStatementExecutionDuration

The time duration taken to execute the sql statement.

Parameter
Name Description
var Google\Protobuf\Duration
Returns
Type Description
$this

getStatus

Status of SQL execution.

Returns
Type Description
int

setStatus

Status of SQL execution.

Parameter
Name Description
var int
Returns
Type Description
$this