Cloud Spanner V1 API - Class Google::Cloud::Spanner::V1::ResultSetMetadata (v0.23.0)

Version 0.23.0

• 1.2.0 (latest)
• 1.1.0
• 1.0.2
• 0.27.0
• 0.26.0
• 0.25.0
• 0.24.0
• 0.23.0
• 0.22.2
• 0.21.0
• 0.20.1
• 0.19.0
• 0.18.0
• 0.17.0
• 0.16.0
• 0.15.1
• 0.14.1
• 0.13.0
• 0.12.0
• 0.11.0
• 0.10.0
• 0.9.0
• 0.8.1
• 0.7.4

Reference documentation and code samples for the Cloud Spanner V1 API class Google::Cloud::Spanner::V1::ResultSetMetadata.

Metadata about a ResultSet or PartialResultSet.

Inherits

• Object

Extended By

• Google::Protobuf::MessageExts::ClassMethods

Includes

• Google::Protobuf::MessageExts

Methods

#row_type

def row_type() -> ::Google::Cloud::Spanner::V1::StructType

Returns

• (::Google::Cloud::Spanner::V1::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 a row_type value like:

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

#row_type=

def row_type=(value) -> ::Google::Cloud::Spanner::V1::StructType

Parameter

• value (::Google::Cloud::Spanner::V1::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 a row_type value like:

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

Returns

• (::Google::Cloud::Spanner::V1::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 a row_type value like:

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

#transaction

def transaction() -> ::Google::Cloud::Spanner::V1::Transaction

Returns

• (::Google::Cloud::Spanner::V1::Transaction) — If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

#transaction=

def transaction=(value) -> ::Google::Cloud::Spanner::V1::Transaction

Parameter

• value (::Google::Cloud::Spanner::V1::Transaction) — If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

Returns

• (::Google::Cloud::Spanner::V1::Transaction) — If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.

#undeclared_parameters

def undeclared_parameters() -> ::Google::Cloud::Spanner::V1::StructType

Returns

• (::Google::Cloud::Spanner::V1::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 a undeclared_parameters value like:

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

#undeclared_parameters=

def undeclared_parameters=(value) -> ::Google::Cloud::Spanner::V1::StructType

Parameter

• value (::Google::Cloud::Spanner::V1::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 a undeclared_parameters value like:

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

Returns

• (::Google::Cloud::Spanner::V1::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 a undeclared_parameters value like:

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