mirror of
https://github.com/silverstripe/silverstripe-framework
synced 2024-09-18 23:46:21 +02:00
c1cda2b113
* DOCS: Add new graphql 4 docs * Reorganise docs * Docs done * Basic graphql index page * TOC for getting started * show folders on graphql index page * Add middleware note * Docs update * Update docs to reflect flushless schema * Docs updates * Docs for getByLink * Query caching docs * Docs on nested operations * update docs for new graphql dev admin * Docs for configurable operations * Replace readSiteTrees with readPages * Schema defaults docs * Docs for inherited plugins * Docs for customising * * Docs for field whitelisting * Change whitelist word * New docs on modelConfig * Document dev/build extension * Document default/global plugins * Document new input type fields config * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Note about when procedural schema gets built * Fix link * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Note about plugins in custom queries * DOCS Note about filter and custom resolvers * DOCS Note about canview paging * DOCS Updated guidance on _extend See https://github.com/silverstripe/silverstripe-graphql/issues/296 * Apply suggestions from code review Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> * DOCS Pre-release warning Co-authored-by: Ingo Schommer <ingo@silverstripe.com> Co-authored-by: Andre Kiste <bergice@users.noreply.github.com> Co-authored-by: Ingo Schommer <me@chillu.com>
86 lines
2.0 KiB
Markdown
86 lines
2.0 KiB
Markdown
---
|
|
title: Property mapping and dot syntax
|
|
summary: Learn how to customise field names, use dot syntax, and use aggregate functions
|
|
---
|
|
|
|
|
|
# Working with DataObjects
|
|
|
|
[CHILDREN asList]
|
|
|
|
[alert]
|
|
You are viewing docs for a pre-release version of silverstripe/graphql (4.x).
|
|
Help us improve it by joining #graphql on the [Community Slack](https://www.silverstripe.org/blog/community-slack-channel/),
|
|
and report any issues at [github.com/silverstripe/silverstripe-graphql](https://github.com/silverstripe/silverstripe-graphql).
|
|
Docs for the current stable version (3.x) can be found
|
|
[here](https://github.com/silverstripe/silverstripe-graphql/tree/3)
|
|
[/alert]
|
|
|
|
## Property mapping and dot syntax
|
|
|
|
For the most part, field names are inferred through the DataObject model, but its API affords developers full
|
|
control over naming:
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
Page:
|
|
fields:
|
|
pageContent:
|
|
type: String
|
|
property: Content
|
|
```
|
|
|
|
[notice]
|
|
When using explicit property mapping, you must also define an explicit type, as it can
|
|
no longer be inferred.
|
|
[/notice]
|
|
|
|
|
|
### Dot-separated accessors
|
|
|
|
Property mapping is particularly useful when using **dot syntax** to access fields.
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
MyProject\Pages\Blog:
|
|
fields:
|
|
title: true
|
|
authorName:
|
|
type: String
|
|
property: 'Author.FirstName'
|
|
```
|
|
|
|
Fields on plural relationships will automatically convert to a `column` array:
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
MyProject\Pages\Blog:
|
|
fields:
|
|
title: true
|
|
categoryTitles:
|
|
type: '[String]'
|
|
property: 'Categories.Title'
|
|
authorsFavourites:
|
|
type: '[String]'
|
|
property: 'Author.FavouritePosts.Title'
|
|
```
|
|
|
|
We can even use a small subset of **aggregates**, including `Count()`, `Max()`, `Min()` and `Avg()`.
|
|
|
|
*app/_graphql/models.yml*
|
|
```yaml
|
|
MyProject\Models\ProductCategory:
|
|
fields:
|
|
title: true
|
|
productCount:
|
|
type: Int
|
|
property: 'Products.Count()'
|
|
averageProductPrice:
|
|
type: Float
|
|
property: 'Products.Avg(Price)'
|
|
```
|
|
|
|
### Further reading
|
|
|
|
[CHILDREN]
|