This reference doc is generated based on this example 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 single MainTable based on id, key or first and return selected fields (or null 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!]!
✨ List MainTable objects in the table, optionally filtered by where 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). |
mainTables_vectorField_similarity: [MainTable!]!
✨ List MainTable objects ordered by vector similarity between the vectorField field and compare_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 of compare (Vector to compare with the stored vectors.) |
method |
VectorSimilarityMethod |
Similarity method to use for vector comparison (defaults to INNER_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 single ManyToManyJoinTable based on id, key or first and return selected fields (or null 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!]!
✨ List ManyToManyJoinTable objects in the table, optionally filtered by where 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). |
manyToOneExample: ManyToOneExample
✨ Look up a single ManyToOneExample based on id, key or first and return selected fields (or null 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!]!
✨ List ManyToOneExample objects in the table, optionally filtered by where 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). |
oneToOneExample: OneToOneExample
✨ Look up a single OneToOneExample based on id, key or first and return selected fields (or null 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!]!
✨ List OneToOneExample objects in the table, optionally filtered by where 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). |
stringTable: StringTable
✨ Look up a single StringTable based on id, key or first and return selected fields (or null 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!]!
✨ List StringTable objects in the table, optionally filtered by where 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). |
Built In
__schema: __Schema!
__type: __Type
| Field | Type | Description |
|---|---|---|
name |
String! |