GoogleApi.Spanner.V1.Model.ResultSetMetadata (google_api_spanner v0.48.0)

View Source

Metadata about a ResultSet or PartialResultSet.

Attributes

  • rowType (type: GoogleApi.Spanner.V1.Model.StructType.t, default: nil) - 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 a row_type value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]
  • transaction (type: GoogleApi.Spanner.V1.Model.Transaction.t, default: nil) - If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
  • undeclaredParameters (type: GoogleApi.Spanner.V1.Model.StructType.t, default: nil) - 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 a undeclared_parameters value like: "fields": [ { "name": "UserId", "type": { "code": "INT64" } }, { "name": "UserName", "type": { "code": "STRING" } }, ]

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.Spanner.V1.Model.ResultSetMetadata{
  rowType: GoogleApi.Spanner.V1.Model.StructType.t() | nil,
  transaction: GoogleApi.Spanner.V1.Model.Transaction.t() | nil,
  undeclaredParameters: GoogleApi.Spanner.V1.Model.StructType.t() | nil
}

Functions

decode(value, options)

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.