ResultSetMetadata

Metadata about aResultSet orPartialResultSet.

JSON representation
{"rowType":{object (StructType)},"transaction":{object (Transaction)},"undeclaredParameters":{object (StructType)}}
Fields
rowType

object (StructType)

Indicates the field names and types for the rows in the result set. For example, a SQL query like"SELECT UserId, UserName FROM Users" could return arowType value like:

"fields": [  { "name": "UserId", "type": { "code": "INT64" } },  { "name": "UserName", "type": { "code": "STRING" } },]
transaction

object (Transaction)

If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

undeclaredParameters

object (StructType)

A SQL query can be parameterized. In PLAN mode, these parameters can be undeclared. This indicates the field names and types for those undeclared parameters in the SQL query. For example, a SQL query like"SELECT * FROM Users where UserId = @userId and UserName = @userName " could return aundeclaredParameters value like:

"fields": [  { "name": "UserId", "type": { "code": "INT64" } },  { "name": "UserName", "type": { "code": "STRING" } },]

Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.

Last updated 2025-05-30 UTC.