public static interface ReadOptions.TableReadOptionsOrBuilder extends MessageOrBuilderImplements
MessageOrBuilderMethods
getRowRestriction()
public abstract String getRowRestriction()Optional. SQL text filtering statement, similar to a WHERE clause in a SQL query. Aggregates are not supported.
Examples: "int_field > 5" "date_field = CAST('2014-9-27' as DATE)" "nullable_field is not NULL" "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))" "numeric_field BETWEEN 1.0 AND 5.0"
Restricted to a maximum length for 1 MB.
string row_restriction = 2;
| Returns | |
|---|---|
| Type | Description |
String |
The rowRestriction. |
getRowRestrictionBytes()
public abstract ByteString getRowRestrictionBytes()Optional. SQL text filtering statement, similar to a WHERE clause in a SQL query. Aggregates are not supported.
Examples: "int_field > 5" "date_field = CAST('2014-9-27' as DATE)" "nullable_field is not NULL" "st_equals(geo_field, st_geofromtext("POINT(2, 2)"))" "numeric_field BETWEEN 1.0 AND 5.0"
Restricted to a maximum length for 1 MB.
string row_restriction = 2;
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes for rowRestriction. |
getSelectedFields(int index)
public abstract String getSelectedFields(int index)Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.
Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.
As an example, consider a table with the following schema:
{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }
Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 string_field2 }
Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 }
The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.
repeated string selected_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the element to return. |
| Returns | |
|---|---|
| Type | Description |
String |
The selectedFields at the given index. |
getSelectedFieldsBytes(int index)
public abstract ByteString getSelectedFieldsBytes(int index)Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.
Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.
As an example, consider a table with the following schema:
{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }
Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 string_field2 }
Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 }
The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.
repeated string selected_fields = 1;
| Parameter | |
|---|---|
| Name | Description |
index |
intThe index of the value to return. |
| Returns | |
|---|---|
| Type | Description |
ByteString |
The bytes of the selectedFields at the given index. |
getSelectedFieldsCount()
public abstract int getSelectedFieldsCount()Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.
Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.
As an example, consider a table with the following schema:
{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }
Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 string_field2 }
Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 }
The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.
repeated string selected_fields = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The count of selectedFields. |
getSelectedFieldsList()
public abstract List<String> getSelectedFieldsList()Optional. The names of the fields in the table to be returned. If no field names are specified, then all fields in the table are returned.
Nested fields -- the child elements of a STRUCT field -- can be selected individually using their fully-qualified names, and will be returned as record fields containing only the selected nested fields. If a STRUCT field is specified in the selected fields list, all of the child elements will be returned.
As an example, consider a table with the following schema:
{ "name": "struct_field", "type": "RECORD", "mode": "NULLABLE", "fields": [ { "name": "string_field1", "type": "STRING", . "mode": "NULLABLE" }, { "name": "string_field2", "type": "STRING", "mode": "NULLABLE" } ] }
Specifying "struct_field" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 string_field2 }
Specifying "struct_field.string_field1" in the selected fields list will result in a read session schema with the following logical structure:
struct_field { string_field1 }
The order of the fields in the read session schema is derived from the table schema and does not correspond to the order in which the fields are specified in this list.
repeated string selected_fields = 1;
| Returns | |
|---|---|
| Type | Description |
List<String> |
A list containing the selectedFields. |