Query operations define the read-only entry points for fetching data in a GraphQL schema.
Data Connect Generated
basicTable: BasicTable
✨ Look up a single BasicTable
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 |
BasicTable_Key |
The key used to identify the object. |
first |
BasicTable_FirstRow |
Fetch the first row based on the filters and ordering. |
basicTables: [BasicTable!]!
✨ List BasicTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
BasicTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[BasicTable_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). |
basicTables_vectorField_similarity: [BasicTable!]!
✨ List BasicTable
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 |
BasicTable_Filter |
Filter condition to apply when searching for similar vectors. |
limit |
Int |
Limit the number of similar vectors returned (defaults to 100 rows). |
joinTable: JoinTable
✨ Look up a single JoinTable
based on id
, key
or first
and return selected fields (or null
if not found).
Field | Type | Description |
---|---|---|
key |
JoinTable_Key |
The key used to identify the object. |
first |
JoinTable_FirstRow |
Fetch the first row based on the filters and ordering. |
joinTables: [JoinTable!]!
✨ List JoinTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
JoinTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[JoinTable_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). |
leftTable: LeftTable
✨ Look up a single LeftTable
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 |
LeftTable_Key |
The key used to identify the object. |
first |
LeftTable_FirstRow |
Fetch the first row based on the filters and ordering. |
leftTables: [LeftTable!]!
✨ List LeftTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
LeftTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[LeftTable_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). |
manyTable: ManyTable
✨ Look up a single ManyTable
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 |
ManyTable_Key |
The key used to identify the object. |
first |
ManyTable_FirstRow |
Fetch the first row based on the filters and ordering. |
manyTables: [ManyTable!]!
✨ List ManyTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
ManyTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[ManyTable_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). |
maybeTable: MaybeTable
✨ Look up a single MaybeTable
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 |
MaybeTable_Key |
The key used to identify the object. |
first |
MaybeTable_FirstRow |
Fetch the first row based on the filters and ordering. |
maybeTables: [MaybeTable!]!
✨ List MaybeTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
MaybeTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[MaybeTable_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). |
oneTable: OneTable
✨ Look up a single OneTable
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 |
OneTable_Key |
The key used to identify the object. |
first |
OneTable_FirstRow |
Fetch the first row based on the filters and ordering. |
oneTables: [OneTable!]!
✨ List OneTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
OneTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[OneTable_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). |
rightTable: RightTable
✨ Look up a single RightTable
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 |
RightTable_Key |
The key used to identify the object. |
first |
RightTable_FirstRow |
Fetch the first row based on the filters and ordering. |
rightTables: [RightTable!]!
✨ List RightTable
objects in the table, optionally filtered by where
conditions.
Field | Type | Description |
---|---|---|
where |
RightTable_Filter |
Filter condition to narrow down the query results. |
orderBy |
[RightTable_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! |