Fields and projections
This is the official documentation of the @forestadmin/agent
Node.js agent.
Fields
Field identifiers simply are strings that identify a column in the context of a collection.
Let’s consider the following database structure; collections, fields and relationships:
In this context, you’ll find below some examples that show valid and invalid field calls:
Collection
Field
Valid?
Books
"title"
🟢 Yes
Books
"myAuthor:firstname"
🟢 Yes
Books
"myReviews:content"
❌ No, only relationships which yield one record can be traversed
Reviews
"content"
🟢 Yes
Reviews
"myBook:title"
❌ No, reverse relationships are not automatically defined
Projections
Projections are mainly used to fetch partial records and automatically fetch linked records.
Projections simply are an array of fields.
Last updated
Was this helpful?