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.
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.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-09-04 UTC."],[],[],null,["# Google Cloud AlloyDB for PostgreSQL V1 Client - Class ExecuteSqlMetadata (1.4.1)\n\nVersion latestkeyboard_arrow_down\n\n- [1.4.1 (latest)](/php/docs/reference/cloud-alloydb/latest/V1.ExecuteSqlMetadata)\n- [1.4.0](/php/docs/reference/cloud-alloydb/1.4.0/V1.ExecuteSqlMetadata)\n- [1.3.0](/php/docs/reference/cloud-alloydb/1.3.0/V1.ExecuteSqlMetadata)\n- [1.2.0](/php/docs/reference/cloud-alloydb/1.2.0/V1.ExecuteSqlMetadata)\n- [1.1.3](/php/docs/reference/cloud-alloydb/1.1.3/V1.ExecuteSqlMetadata)\n- [1.0.0](/php/docs/reference/cloud-alloydb/1.0.0/V1.ExecuteSqlMetadata)\n- [0.10.3](/php/docs/reference/cloud-alloydb/0.10.3/V1.ExecuteSqlMetadata)\n- [0.9.0](/php/docs/reference/cloud-alloydb/0.9.0/V1.ExecuteSqlMetadata)\n- [0.8.0](/php/docs/reference/cloud-alloydb/0.8.0/V1.ExecuteSqlMetadata)\n- [0.7.1](/php/docs/reference/cloud-alloydb/0.7.1/V1.ExecuteSqlMetadata)\n- [0.6.0](/php/docs/reference/cloud-alloydb/0.6.0/V1.ExecuteSqlMetadata)\n- [0.5.0](/php/docs/reference/cloud-alloydb/0.5.0/V1.ExecuteSqlMetadata)\n- [0.4.0](/php/docs/reference/cloud-alloydb/0.4.0/V1.ExecuteSqlMetadata)\n- [0.3.0](/php/docs/reference/cloud-alloydb/0.3.0/V1.ExecuteSqlMetadata)\n- [0.2.1](/php/docs/reference/cloud-alloydb/0.2.1/V1.ExecuteSqlMetadata)\n- [0.1.3](/php/docs/reference/cloud-alloydb/0.1.3/V1.ExecuteSqlMetadata) \nReference documentation and code samples for the Google Cloud AlloyDB for PostgreSQL V1 Client class ExecuteSqlMetadata.\n\nAny additional metadata information regarding the execution of the SQL\n\nGenerated from protobuf message `google.cloud.alloydb.v1.ExecuteSqlMetadata`\n\nNamespace\n---------\n\nGoogle \\\\ Cloud \\\\ AlloyDb \\\\ V1\n\nMethods\n-------\n\n### __construct\n\nConstructor.\n\n### getMessage\n\nMessage related to SQL execution. Marked as core content since it\ncan potentially contain details related to the query or result set. This\nfield can be used to convey messages such as \"when the SQL result set\nexceeds the acceptable response size limits.\"\n\n### setMessage\n\nMessage related to SQL execution. Marked as core content since it\ncan potentially contain details related to the query or result set. This\nfield can be used to convey messages such as \"when the SQL result set\nexceeds the acceptable response size limits.\"\n\n### getPartialResult\n\nSet to true if SQL returned a result set larger than the acceptable\nresponse size limits and the result was truncated.\n\n### setPartialResult\n\nSet to true if SQL returned a result set larger than the acceptable\nresponse size limits and the result was truncated.\n\n### getSqlStatementExecutionDuration\n\nThe time duration taken to execute the sql statement.\n\n### hasSqlStatementExecutionDuration\n\n### clearSqlStatementExecutionDuration\n\n### setSqlStatementExecutionDuration\n\nThe time duration taken to execute the sql statement.\n\n### getStatus\n\nStatus of SQL execution.\n\n### setStatus\n\nStatus of SQL execution."]]