Query Operations
This reference doc is generated based on thisexample schema.
Query operations define the read-only entry points for fetching data in a GraphQL schema.
All queries are generated based on customer defined@table types.Customer defined queries are not supported.
Data Connect Generated
mainTable:MainTable
✨ Look up a singleMainTable based onid,key orfirst and return selected fields (ornull if not found).
| Field | Type | Description |
|---|---|---|
id | UUID | The unique ID of the object. |
key | MainTable_Key | The key used to identify the object. |
first | MainTable_FirstRow | Fetch the first row based on the filters and ordering. |
mainTables:[MainTable!]!
✨ ListMainTable objects in the table and return selected fields, optionally filtered bywhere conditions
| Field | Type | Description |
|---|---|---|
where | MainTable_Filter | Filter condition to narrow down the query results. |
orderBy | [MainTable_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | MainTable_Having | Filter condition to apply to the groups of aggregate queries. |
mainTables_search:[MainTable!]!
✨ Search forMainTable objects where fields with the @searchable directive contain a query string. Return selected fields, ordered by relevance of the query.)
| Field | Type | Description |
|---|---|---|
where | MainTable_Filter | Filter condition to narrow down the query results. |
orderBy | [MainTable_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | MainTable_Having | Filter condition to apply to the groups of aggregate queries. |
query | String | The search term to use. |
relevanceThreshold | Float | Relevance threshold to use for search results. If a result has a relevance score below this threshold, it will not be returned. |
queryFormat | Search_QueryFormat | The query format for the search term. |
mainTables_vectorField_similarity:[MainTable!]!
✨ ListMainTable objects and return selected fields, ordered by vector similarity between thevectorField field andcompare_embed.(Alternatively,compare can be used if the input is a raw Vector.)
| Field | Type | Description |
|---|---|---|
compare | Vector | Vector to compare with the stored vectors. |
compare_embed | Vector_Embed | ✨_embed server value variant ofcompare (Vector to compare with the stored vectors.) |
method | VectorSimilarityMethod | Similarity method to use for vector comparison (defaults toINNER_PRODUCT). |
within | Float | Threshold for distance comparison. |
where | MainTable_Filter | Filter condition to apply when searching for similar vectors. |
limit | Int | Limit the number of similar vectors returned (defaults to 100 rows). |
manyToManyJoinTable:ManyToManyJoinTable
✨ Look up a singleManyToManyJoinTable based onid,key orfirst and return selected fields (ornull if not found).
| Field | Type | Description |
|---|---|---|
key | ManyToManyJoinTable_Key | The key used to identify the object. |
first | ManyToManyJoinTable_FirstRow | Fetch the first row based on the filters and ordering. |
manyToManyJoinTables:[ManyToManyJoinTable!]!
✨ ListManyToManyJoinTable objects in the table and return selected fields, optionally filtered bywhere conditions
| Field | Type | Description |
|---|---|---|
where | ManyToManyJoinTable_Filter | Filter condition to narrow down the query results. |
orderBy | [ManyToManyJoinTable_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | ManyToManyJoinTable_Having | Filter condition to apply to the groups of aggregate queries. |
manyToOneExample:ManyToOneExample
✨ Look up a singleManyToOneExample based onid,key orfirst and return selected fields (ornull if not found).
| Field | Type | Description |
|---|---|---|
id | UUID | The unique ID of the object. |
key | ManyToOneExample_Key | The key used to identify the object. |
first | ManyToOneExample_FirstRow | Fetch the first row based on the filters and ordering. |
manyToOneExamples:[ManyToOneExample!]!
✨ ListManyToOneExample objects in the table and return selected fields, optionally filtered bywhere conditions
| Field | Type | Description |
|---|---|---|
where | ManyToOneExample_Filter | Filter condition to narrow down the query results. |
orderBy | [ManyToOneExample_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | ManyToOneExample_Having | Filter condition to apply to the groups of aggregate queries. |
oneToOneExample:OneToOneExample
✨ Look up a singleOneToOneExample based onid,key orfirst and return selected fields (ornull if not found).
| Field | Type | Description |
|---|---|---|
id | UUID | The unique ID of the object. |
key | OneToOneExample_Key | The key used to identify the object. |
first | OneToOneExample_FirstRow | Fetch the first row based on the filters and ordering. |
oneToOneExamples:[OneToOneExample!]!
✨ ListOneToOneExample objects in the table and return selected fields, optionally filtered bywhere conditions
| Field | Type | Description |
|---|---|---|
where | OneToOneExample_Filter | Filter condition to narrow down the query results. |
orderBy | [OneToOneExample_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | OneToOneExample_Having | Filter condition to apply to the groups of aggregate queries. |
stringTable:StringTable
✨ Look up a singleStringTable based onid,key orfirst and return selected fields (ornull if not found).
| Field | Type | Description |
|---|---|---|
id | UUID | The unique ID of the object. |
key | StringTable_Key | The key used to identify the object. |
first | StringTable_FirstRow | Fetch the first row based on the filters and ordering. |
stringTables:[StringTable!]!
✨ ListStringTable objects in the table and return selected fields, optionally filtered bywhere conditions
| Field | Type | Description |
|---|---|---|
where | StringTable_Filter | Filter condition to narrow down the query results. |
orderBy | [StringTable_Order!] | Order the query results by specific fields. |
offset | Int | Number of rows to skip before starting to return the results. |
limit | Int | Maximum number of rows to return (defaults to 100 rows). |
distinct | Boolean | Set to true to return distinct results. |
having | StringTable_Having | Filter condition to apply to the groups of aggregate queries. |
Built In
__schema:__Schema!
__type:__Type
| Field | Type | Description |
|---|---|---|
name | 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 2026-01-21 UTC.