Package com.google.spanner.v1

Interface ResultSetMetadataOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

ResultSetMetadata, ResultSetMetadata.Builder

public interface ResultSetMetadataOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method	Description
StructType	getRowType()	Indicates the field names and types for the rows in the result set.
StructTypeOrBuilder	getRowTypeOrBuilder()	Indicates the field names and types for the rows in the result set.
Transaction	getTransaction()	If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
TransactionOrBuilder	getTransactionOrBuilder()	If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
StructType	getUndeclaredParameters()	A SQL query can be parameterized.
StructTypeOrBuilder	getUndeclaredParametersOrBuilder()	A SQL query can be parameterized.
boolean	hasRowType()	Indicates the field names and types for the rows in the result set.
boolean	hasTransaction()	If the read or SQL query began a transaction as a side-effect, the information about the new transaction is yielded here.
boolean	hasUndeclaredParameters()	A SQL query can be parameterized.

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Method Details

hasRowType

boolean hasRowType()

 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" } },
     ]
 

.google.spanner.v1.StructType row_type = 1;

Returns:

Whether the rowType field is set.

getRowType

StructType getRowType()

 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" } },
     ]
 

.google.spanner.v1.StructType row_type = 1;

Returns:

The rowType.

getRowTypeOrBuilder

StructTypeOrBuilder getRowTypeOrBuilder()

 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" } },
     ]
 

.google.spanner.v1.StructType row_type = 1;

hasTransaction

boolean hasTransaction()

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

.google.spanner.v1.Transaction transaction = 2;

Returns:

Whether the transaction field is set.

getTransaction

Transaction getTransaction()

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

.google.spanner.v1.Transaction transaction = 2;

Returns:

The transaction.

getTransactionOrBuilder

TransactionOrBuilder getTransactionOrBuilder()

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

.google.spanner.v1.Transaction transaction = 2;

hasUndeclaredParameters

boolean hasUndeclaredParameters()

 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" } },
     ]
 

.google.spanner.v1.StructType undeclared_parameters = 3;

Returns:

Whether the undeclaredParameters field is set.

getUndeclaredParameters

StructType getUndeclaredParameters()

 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" } },
     ]
 

.google.spanner.v1.StructType undeclared_parameters = 3;

Returns:

The undeclaredParameters.

getUndeclaredParametersOrBuilder

StructTypeOrBuilder getUndeclaredParametersOrBuilder()

 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" } },
     ]
 

.google.spanner.v1.StructType undeclared_parameters = 3;