@directus/app 9.12.1 → 9.14.0

package/dist/assets/query.dbe0b56d.js

@@ -1,152 +0,0 @@
-import{a as s,o,b as c,w as t,g as e,e as d,B as l}from"./runtime-core.esm-bundler.b1f35d24.js";var a={};const h={class:"markdown-body"},u=e("div",{class:"two-up"},[e("div",{class:"left"},[e("blockquote",null,[e("p",null,"Most Directus API Endpoint operations can be manipulated with the following parameters. It is important to understand them to get the most out of the platform.")])]),e("div",{class:"right"},[e("p"),e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#fields"},"Fields")]),e("li",null,[e("a",{href:"#filter"},"Filter")]),e("li",null,[e("a",{href:"#search"},"Search")]),e("li",null,[e("a",{href:"#sort"},"Sort")]),e("li",null,[e("a",{href:"#limit"},"Limit")]),e("li",null,[e("a",{href:"#offset"},"Offset"),l(" / "),e("a",{href:"#page"},"Page")]),e("li",null,[e("a",{href:"#aggregation-grouping"},"Aggregation & Grouping")]),e("li",null,[e("a",{href:"#deep"},"Deep")]),e("li",null,[e("a",{href:"#aliases"},"Aliases")]),e("li",null,[e("a",{href:"#export"},"Export")])]),e("p"),l(" - [Functions](#functions) "),e("p"),l(" - [Metadata](#metadata) - [Total Count](#total-count) - [Filter Count](#filter-count) ")])])],-1),p=e("hr",null,null,-1),f=e("h2",{id:"fields"},[l("Fields "),e("a",{class:"header-anchor",href:"#fields"},"#")],-1),g=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Choose the fields that are returned in the current dataset. This parameter supports dot notation to request nested relational fields. You can also use a wildcard (*) to include all fields at a specific depth.")])],-1),m=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples"},"#")]),e("p",null,[l("Get all top-level fields"),e("br"),e("code",{class:""},"*")]),e("p",null,[l("Get all top-level fields and all second-level relational fields"),e("br"),e("code",{class:""},"*.*")]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Performance & Size"),e("p",null,[l("While the fields wildcard is very useful for debugging purposes, we recommend only requesting "),e("em",null,"specific"),l(" fields for production use. By only requesting the fields you really need, you can speed up the request, and reduce the overall output size.")])]),e("p",null,[l("Get all top-level fields and second-level relational fields within images"),e("br"),e("code",{class:""},"*,images.*")]),e("p",null,[l("Get only the first_name and last_name fields"),e("br"),e("code",{class:""},"first_name,last_name")]),e("p",null,[l("Get all top-level and second-level relational fields, and third-level fields within images.thumbnails"),e("br"),e("code",{class:""},"*.*,images.thumbnails.*")]),e("h3",{id:"many-to-any-(union-types)"},[l("Many-To-Any (Union Types) "),e("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#")]),e("p",null,[l("Seeing that Many-to-Any (m2a) fields have nested data from multiple collections, it\u2019s not always safe / wanted to fetch the same field from every related collection. In m2a fields, you can use the following syntax to specify what fields to fetch from which related nested collection type:"),e("br"),e("code",{class:""},"?fields=<m2a-field>:<collection-scope>.<field>"),l(".")]),e("p",null,[l("Lets say we have a collection "),e("code",{class:""},"pages"),l(" with a many-to-any field called "),e("code",{class:""},"sections"),l(" that points to "),e("code",{class:""},"headings"),l(", "),e("code",{class:""},"paragraphs"),l(", and "),e("code",{class:""},"videos"),l(". We only want to fetch "),e("code",{class:""},"title"),l(" and "),e("code",{class:""},"level"),l(" from "),e("code",{class:""},"headings"),l(", "),e("code",{class:""},"body"),l(" from "),e("code",{class:""},"paragraphs"),l(" and "),e("code",{class:""},"source"),l(" from "),e("code",{class:""},"videos"),l(". We can achieve that by using:")]),e("pre",null,[e("code",{class:""},`sections.item:headings.title
-sections.item:headings.level
-sections.item:paragraphs.body
-sections.item:videos.source
-`)]),e("p",null,"In GraphQL, this can be achieved using Union Types.")]),e("div",{class:"right"},[e("h3",{id:"rest-api"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",{class:""},`?fields=title,body,featured_image.*
-
-// or
-
-?fields[]=title
-&fields[]=body
-&fields[]=featured_image.*
-`)]),e("h3",{id:"graphql"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("p",null,[e("em",null,"Natively supported in GraphQL")])])],-1),_=e("hr",null,null,-1),v=e("h2",{id:"filter"},[l("Filter "),e("a",{class:"header-anchor",href:"#filter"},"#")],-1),y={class:"two-up"},w={class:"left"},b=l("Used to search items in a collection that matches the filter\u2019s conditions. The filter param follows "),q=l("the Filter Rules spec"),j=l(", which includes additional information on logical operators (AND/OR), nested relational filtering, and dynamic variables."),x=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-2"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-2"},"#")]),e("p",null,[l("Retrieve all items where "),e("code",{class:""},"first_name"),l(" equals \u201CRijk\u201D")]),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"first_name"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"_eq"'),l(": "),e("span",{class:"hljs-string"},'"Rijk"'),l(`
-	}
-}
-`)])]),e("p",null,"Retrieve all items in one of the following categories: \u201Cvegetables\u201D, \u201Cfruit\u201D"),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"categories"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"_in"'),l(": ["),e("span",{class:"hljs-string"},'"vegetables"'),l(", "),e("span",{class:"hljs-string"},'"fruit"'),l(`]
-	}
-}
-`)])]),e("p",null,"Retrieve all items that are published between two dates"),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"date_published"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"_between"'),l(": ["),e("span",{class:"hljs-string"},'"2021-01-24"'),l(", "),e("span",{class:"hljs-string"},'"2021-02-23"'),l(`]
-	}
-}
-`)])]),e("p",null,"Retrieve all items where the author\u2019s \u201Cvip\u201D flag is true"),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"author"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"vip"'),l(`: {
-			`),e("span",{class:"hljs-attr"},'"_eq"'),l(": "),e("span",{class:"hljs-literal"},"true"),l(`
-		}
-	}
-}
-`)])]),e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Nested Filters"),e("p",null,[l("The above example will filter the "),e("em",null,"top level"),l(" items based on a condition "),e("em",null,"in"),l(" the related item. If you\u2019re looking to filter the related items themselves, take a look at "),e("a",{href:"#deep"},[l("the "),e("code",{class:""},"deep"),l(" parameter")]),l("!")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",{class:""},`?filter[first_name][_eq]=Rijk
-
-// or
-
-?filter={ "first_name": { "_eq": "Rijk" }}
-`)]),e("h3",{id:"graphql-2"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	users(filter: { first_name: { _eq: `),e("span",{class:"hljs-string"},'"Rijk"'),l(` } }) {
-		id
-	}
-}
-`)])])])],-1),k=e("hr",null,null,-1),G=e("h2",{id:"search"},[l("Search "),e("a",{class:"header-anchor",href:"#search"},"#")],-1),E=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The search parameter allows you to perform a search on all string and text type fields within a collection. It\u2019s an easy way to search for an item without creating complex field filters \u2013 though it is far less optimized. It only searches the root item\u2019s fields, related item fields are not included.")])],-1),A=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"example"},[l("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("p",null,[l("Find all items that mention Directus"),e("br"),e("code",{class:""},"Directus")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",{class:""},`?search=Directus
-`)]),e("h3",{id:"graphql-3"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(search: `),e("span",{class:"hljs-string"},'"Directus"'),l(`) {
-		id
-	}
-}
-`)])])])],-1),S=e("hr",null,null,-1),T=e("h2",{id:"sort"},[l("Sort "),e("a",{class:"header-anchor",href:"#sort"},"#")],-1),R=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("What field(s) to sort by. Sorting defaults to ascending, but a minus sign ("),e("code",{class:""},"-"),l(") can be used to reverse this to descending order. Fields are prioritized by the order in the parameter.")])])],-1),L=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-3"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-3"},"#")]),e("p",null,[l("Sort by creation date descending"),e("br"),e("code",{class:""},"-date_created")]),e("p",null,[l("Sort by a \u201Csort\u201D field, followed by publish date descending"),e("br"),e("code",{class:""},"sort, -publish_date")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",{class:""},`?sort=sort,-date_created
-
-// or
-
-?sort[]=sort
-&sort[]=-date_created
-`)]),e("h3",{id:"graphql-4"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(sort: [`),e("span",{class:"hljs-string"},'"sort"'),l(", "),e("span",{class:"hljs-string"},'"-date_created"'),l(`]) {
-		id
-	}
-}
-`)])])])],-1),I=e("hr",null,null,-1),P=e("h2",{id:"limit"},[l("Limit "),e("a",{class:"header-anchor",href:"#limit"},"#")],-1),Q=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Set the maximum number of items that will be returned. The default limit is set to "),e("code",{class:""},"100"),l(".")])])],-1),F=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-4"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-4"},"#")]),e("p",null,[l("Get the first 200 items"),e("br"),e("code",{class:""},"200")]),e("p",null,[l("Get all items"),e("br"),e("code",{class:""},"-1")]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"All Items"),e("p",null,"Depending on the size of your collection, fetching unlimited data may result in degraded performance or timeouts, use with caution.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",{class:""},`?limit=200
-`)]),e("h3",{id:"graphql-5"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(limit: `),e("span",{class:"hljs-number"},"200"),l(`) {
-		id
-	}
-}
-`)])])])],-1),D=e("hr",null,null,-1),N=e("h2",{id:"offset"},[l("Offset "),e("a",{class:"header-anchor",href:"#offset"},"#")],-1),C=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Skip the first "),e("code",{class:""},"n"),l(" items in the response. Can be used for pagination.")])])],-1),B=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-5"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-5"},"#")]),e("p",null,[l("Get items 101\u2014200"),e("br"),e("code",{class:""},"100")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",{class:""},`?offset=100
-`)]),e("h3",{id:"graphql-6"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(offset: `),e("span",{class:"hljs-number"},"100"),l(`) {
-		id
-	}
-}
-`)])])])],-1),M=e("hr",null,null,-1),z=e("h2",{id:"page"},[l("Page "),e("a",{class:"header-anchor",href:"#page"},"#")],-1),O=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("An alternative to "),e("code",{class:""},"offset"),l(". Page is a way to set "),e("code",{class:""},"offset"),l(" under the hood by calculating "),e("code",{class:""},"limit * page"),l(". Page is 1-indexed.")])])],-1),U=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-6"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-6"},"#")]),e("p",null,[l("Get items 1-100"),e("br"),e("code",{class:""},"1")]),e("p",null,[l("Get items 101-200"),e("br"),e("code",{class:""},"2")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-7"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-7"},"#")]),e("pre",null,[e("code",{class:""},`?page=2
-`)]),e("h3",{id:"graphql-7"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(page: `),e("span",{class:"hljs-number"},"2"),l(`) {
-		id
-	}
-}
-`)])])])],-1),W=e("hr",null,null,-1),V=e("h2",{id:"aggregation-%26-grouping"},[l("Aggregation & Grouping "),e("a",{class:"header-anchor",href:"#aggregation-%26-grouping"},"#")],-1),J=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Aggregate functions allow you to perform calculations on a set of values, returning a single result.")])],-1),Y=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"The following aggregation functions are available in Directus:"),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Name"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",{class:""},"count")]),e("td",null,"Counts how many items there are")]),e("tr",null,[e("td",null,[e("code",{class:""},"countDistinct")]),e("td",null,"Counts how many unique items there are")]),e("tr",null,[e("td",null,[e("code",{class:""},"sum")]),e("td",null,"Adds together the values in the given field")]),e("tr",null,[e("td",null,[e("code",{class:""},"sumDistinct")]),e("td",null,"Adds together the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",{class:""},"avg")]),e("td",null,"Get the average value of the given field")]),e("tr",null,[e("td",null,[e("code",{class:""},"avgDistinct")]),e("td",null,"Get the average value of the unique values in the given field")]),e("tr",null,[e("td",null,[e("code",{class:""},"min")]),e("td",null,"Return the lowest value in the field")]),e("tr",null,[e("td",null,[e("code",{class:""},"max")]),e("td",null,"Return the highest value in the field")]),e("tr",null,[e("td",null,[e("code",{class:""},"countAll")]),e("td",null,[l("Equivalent to "),e("code",{class:""},"?aggregate[count]=*"),l(" (GraphQL only)")])])])]),e("h3",{id:"grouping"},[l("Grouping "),e("a",{class:"header-anchor",href:"#grouping"},"#")]),e("p",null,[l("By default, the above aggregation functions run on the whole dataset. To allow for more flexible reporting, you can combine the above aggregation with grouping. Grouping allows for running the aggregation functions based on a shared value. This allows for things like "),e("em",null,"\u201CAverage rating per month\u201D"),l(" or "),e("em",null,"\u201CTotal sales of items in the jeans category\u201D"),l(".")]),e("p",null,[l("The "),e("code",{class:""},"groupBy"),l(" query allows for grouping on multiple fields simultaneously. Combined with the "),e("a",{href:"#functions"},"Functions"),l(", this allows for aggregate reporting per year-month-date.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-8"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-8"},"#")]),e("pre",null,[e("code",{class:""},`?aggregate[avg]=cost
-&groupBy[]=author
-&groupBy[]=year(publish_date)
-`)]),e("h3",{id:"graphql-8"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-8"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles_aggregated(groupBy: [`),e("span",{class:"hljs-string"},'"author"'),l(", "),e("span",{class:"hljs-string"},'"year(publish_date)"'),l(`]) {
-		group
-		sum {
-			revenue
-		}
-	}
-}
-`)])])])],-1),H=e("hr",null,null,-1),K=e("h2",{id:"deep"},[l("Deep "),e("a",{class:"header-anchor",href:"#deep"},"#")],-1),X=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Deep allows you to set any of the other query parameters on a nested relational dataset.")])],-1),Z=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"examples-7"},[l("Examples "),e("a",{class:"header-anchor",href:"#examples-7"},"#")]),e("p",null,"Limit the nested related articles to 3"),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"related_articles"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"_limit"'),l(": "),e("span",{class:"hljs-number"},"3"),l(`
-	}
-}
-`)])]),e("p",null,"Only get 3 related articles, with only the top rated comment nested"),e("pre",null,[e("code",{class:"language-json"},[l(`{
-	`),e("span",{class:"hljs-attr"},'"related_articles"'),l(`: {
-		`),e("span",{class:"hljs-attr"},'"_limit"'),l(": "),e("span",{class:"hljs-number"},"3"),l(`,
-		`),e("span",{class:"hljs-attr"},'"comments"'),l(`: {
-			`),e("span",{class:"hljs-attr"},'"_sort"'),l(": "),e("span",{class:"hljs-string"},'"rating"'),l(`,
-			`),e("span",{class:"hljs-attr"},'"_limit"'),l(": "),e("span",{class:"hljs-number"},"1"),l(`
-		}
-	}
-}
-`)])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-9"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-9"},"#")]),e("pre",null,[e("code",{class:""},`?deep[translations][_filter][languages_code][_eq]=en-US
-
-// or
-
-?deep={ "translations": { "_filter": { "languages_code": { "_eq": "en-US" }}}}
-`)]),e("h3",{id:"graphql-9"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-9"},"#")]),e("p",null,[e("em",null,"Natively supported in GraphQL:")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	members {
-		favorite_games(filter: { name: { _eq: `),e("span",{class:"hljs-string"},'"Mariokart 8"'),l(` } }) {
-			id
-			featured_image {
-				filename_disk
-			}
-		}
-	}
-}
-`)])])])],-1),$=e("hr",null,null,-1),ee=e("h2",{id:"aliases"},[l("Aliases "),e("a",{class:"header-anchor",href:"#aliases"},"#")],-1),le=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Aliases allow you rename fields on the fly, and request the same nested data set multiple times using different filters.")])],-1),se=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"Nested fields"),e("p",null,[l("It is only possible to alias same level fields."),e("br"),l(" Alias for nested fields, f.e. "),e("code",{class:""},"field.nested"),l(", will not work.")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-10"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-10"},"#")]),e("pre",null,[e("code",{class:""},`?alias[all_translations]=translations
-&alias[dutch_translations]=translations
-&deep[dutch_translations][_filter][code][_eq]=nl-NL
-`)]),e("h3",{id:"graphql-10"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-10"},"#")]),e("p",null,[e("em",null,"Natively supported in GraphQL:")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles {
-		dutch_translations: translations(filter: { code: { _eq: `),e("span",{class:"hljs-string"},'"nl-NL"'),l(` } }) {
-			id
-		}
-
-		all_translations: translations {
-			id
-		}
-	}
-}
-`)])])])],-1),te=e("hr",null,null,-1),ae=e("h2",{id:"export"},[l("Export "),e("a",{class:"header-anchor",href:"#export"},"#")],-1),ne=e("p",null,"Save the current API response to a file.",-1),re=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Saves the API response to a file. Accepts one of "),e("code",{class:""},"json"),l(", "),e("code",{class:""},"csv"),l(", "),e("code",{class:""},"xml"),l(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-11"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-11"},"#")]),e("pre",null,[e("code",{class:""},`?export=json
-?export=csv
-?export=xml
-`)]),e("h3",{id:"graphql-11"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-11"},"#")]),e("p",null,"n/a")])],-1),ie=e("hr",null,null,-1),oe=e("h2",{id:"functions"},[l("Functions "),e("a",{class:"header-anchor",href:"#functions"},"#")],-1),ce=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions allow for \u201Clive\u201D modification of values stored in a field. Functions can be used in any query parameter you\u2019d normally supply a field key, including fields, aggregation, and filter.")])],-1),de=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,"Functions can be used by wrapping the field key in a JavaScript like syntax, for example:"),e("p",null,[e("code",{class:""},"timestamp"),l(" -> "),e("code",{class:""},"year(timestamp)")]),e("h3",{id:"datetime-functions"},[l("DateTime Functions "),e("a",{class:"header-anchor",href:"#datetime-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",{class:""},"year")]),e("td",null,"Extract the year from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"month")]),e("td",null,"Extract the month from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"week")]),e("td",null,"Extract the week from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"day")]),e("td",null,"Extract the day from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"weekday")]),e("td",null,"Extract the weekday from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"hour")]),e("td",null,"Extract the hour from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"minute")]),e("td",null,"Extract the minute from a datetime/date/timestamp field")]),e("tr",null,[e("td",null,[e("code",{class:""},"second")]),e("td",null,"Extract the second from a datetime/date/timestamp field")])])]),e("h3",{id:"array-functions"},[l("Array Functions "),e("a",{class:"header-anchor",href:"#array-functions"},"#")]),e("table",null,[e("thead",null,[e("tr",null,[e("th",null,"Filter"),e("th",null,"Description")])]),e("tbody",null,[e("tr",null,[e("td",null,[e("code",{class:""},"count")]),e("td",null,"Extract the number of items from a JSON array or relational field")])])]),e("div",{class:"warning hint"},[e("div",{class:"hint-title"},"GraphQL"),e("p",null,[l("Names aren\u2019t allowed to include any special characters in GraphQL, preventing the "),e("code",{class:""},"()"),l(" syntax from being used.")]),e("p",null,[l("As an alternative, the above functions can be used by appending "),e("code",{class:""},"_func"),l(" at the end of the field name, and using the function name as the nested field (see the example that follows).")])])]),e("div",{class:"right"},[e("h3",{id:"rest-api-12"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-12"},"#")]),e("pre",null,[e("code",{class:""},`?fields=id,title,weekday(date_published)
-&filter[year(date_published)][_eq]=2021
-`)]),e("h3",{id:"graphql-12"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-12"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),l(` {
-	articles(filter: { date_published_func: { year: { _eq: `),e("span",{class:"hljs-number"},"2021"),l(` } } }) {
-		id
-		title
-		date_published_func {
-			weekday
-		}
-	}
-}
-`)])])])],-1),he=e("hr",null,null,-1),ue=e("h2",{id:"metadata"},[l("Metadata "),e("a",{class:"header-anchor",href:"#metadata"},"#")],-1),pe=e("div",{class:"two-up"},[e("div",{class:"left"},[e("p",null,[l("Metadata allows you to retrieve some additional information about the items in the collection you\u2019re fetching. "),e("code",{class:""},"*"),l(" can be used as a wildcard to retrieve all metadata.")])])],-1),fe=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"total-count"},[l("Total Count "),e("a",{class:"header-anchor",href:"#total-count"},"#")]),e("p",null,"Returns the total item count of the collection you\u2019re querying."),e("h3",{id:"filter-count"},[l("Filter Count "),e("a",{class:"header-anchor",href:"#filter-count"},"#")]),e("p",null,"Returns the item count of the collection you\u2019re querying, taking the current filter/search parameters into account.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-13"},[l("REST API "),e("a",{class:"header-anchor",href:"#rest-api-13"},"#")]),e("pre",null,[e("code",{class:""},`?meta=total_count
-
-?meta=filter_count
-
-?meta=*
-`)]),e("h3",{id:"graphql-13"},[l("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-13"},"#")]),e("p",null,"n/a")])],-1),ge={title:"Global Query Parameters",modularExtension:!1,pageClass:"page-reference"},me={name:"query",setup(_e,{expose:n}){return n({frontmatter:{title:"Global Query Parameters",modularExtension:!1,pageClass:"page-reference"}}),(ve,ye)=>{const r=s("router-link"),i=s("docswrapper");return o(),c(i,{frontmatter:ge},{default:t(()=>[e("div",h,[u,p,f,g,m,_,v,e("div",y,[e("div",w,[e("p",null,[b,d(r,{to:"/docs/configuration/filter-rules"},{default:t(()=>[q]),_:1}),j])])]),x,k,G,E,A,S,T,R,L,I,P,Q,F,D,N,C,B,M,z,O,U,W,V,J,Y,H,K,X,Z,$,ee,le,se,te,ae,ne,re,ie,oe,ce,de,he,ue,pe,fe])]),_:1})}}};typeof a=="function"&&a(me);export{me as default,ge as frontmatter};

package/dist/assets/quickstart.01824cc9.js

@@ -1,9 +0,0 @@
-import{a as l,o as r,b as d,w as o,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var i={};const u={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[e("This quickstart guide is designed to get you up and running with a Directus Cloud Project in a snap. Along the way, you will better understand what Directus is, setup your free Directus Cloud Account, get a "),t("em",null,"hands-on introduction"),e(" to the App and API, and find more resources to deep-dive into.")])],-1),_=t("h2",{id:"1.-create-cloud-account-and-login"},[e("1. Create Cloud Account and Login "),t("a",{class:"header-anchor",href:"#1.-create-cloud-account-and-login"},"#")],-1),p=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-account-and-login-20220427.mp4",type:"video/mp4"})],-1),m=e("First, you\u2019ll need to "),f=e("create an Account and log in"),g=e(" on "),y=t("a",{href:"https://directus.cloud/login",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),b=t("p",null,"Your Directus Cloud Account allows you to create and manage any number of Community and Standard Projects. We\u2019ve made life easier by giving you the option to create and log in to your free Cloud Account automatically with GitHub. If you don\u2019t have a GitHub account or prefer not to use this login method, email-and-password login is available as well.",-1),v=t("p",null,"The very first time you log in to your cloud account, you will be prompted to create a Team. Teams are totally free to create. Each Directus Cloud Project exists within the scope of one Team. They allow you to organize Team Members, Projects and Project Billing as desired.",-1),w=t("p",null,"Once your Team is created, it\u2019s time to create your free Community Cloud Project!",-1),C={class:"tip hint"},k=t("div",{class:"hint-title"},"Learn More About Cloud",-1),A=e("Overview"),P=e("Cloud Accounts"),j=e("Cloud Teams"),I=t("h2",{id:"2.-create-and-access-project"},[e("2. Create and Access Project "),t("a",{class:"header-anchor",href:"#2.-create-and-access-project"},"#")],-1),T=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-and-access-project-20220427A.mp4",type:"video/mp4"})],-1),S=t("p",null,"To create a Community Project, follow the steps below:",-1),D=e("Open the Team Menu in the Dashboard Header and select or "),F=e("create"),M=e(" the desired Team."),q=t("li",null,[e("Navigate to "),t("strong",null,"\u201CProjects\u201D"),e(" and click "),t("strong",null,"\u201CCreate Project\u201D"),e(".")],-1),N=t("li",null,"Set the Project Name.",-1),R=t("li",null,"Select the Community tier.",-1),x=t("li",null,[e("Scroll to the bottom of the screen and choose the "),t("strong",null,"\u201CEmpty Project\u201D"),e(" Starting Template."),t("br"),e(" Note: The "),t("strong",null,"\u201CDemo Project\u201D"),e(" adds in dummy data for in-depth feature demonstrations.")],-1),L=t("li",null,[e("Click "),t("strong",null,"\u201CCreate Project\u201D"),e(".")],-1),O=t("p",null,[t("em",null,"It should take around 90 seconds for the Cloud Project to build out. During this time, a link will be sent to the email associated with your Cloud Account. The email will contain your Project URL as well as an email and password to login. If you used GitHub to create your account, this will be your GitHub email. Once the build is complete, it\u2019s time log in!")],-1),B={start:"7"},G=e("You can "),E=e("access a Project"),H=e(" from within the Cloud Dashboard or type the URL into your browser."),U=t("li",null,"Log in with your username and password from the email.",-1),Q=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Check All Inbox Folders"),t("p",null,"Due to the algorithms used by some email providers, it is possible the email containing your Project login information will end up in another folder like \u201CSocial\u201D or \u201CPromotions\u201D.")],-1),V={class:"tip hint"},W=t("div",{class:"hint-title"},"Learn More About Cloud Projects",-1),Y=e("Overview"),z=e("Cloud Projects"),K=t("h2",{id:"3.-create-a-collection"},[e("3. Create a Collection "),t("a",{class:"header-anchor",href:"#3.-create-a-collection"},"#")],-1),J=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-collection-20220427A.mp4",type:"video/mp4"})],-1),X=e("Once logged in, you\u2019re greeted with the option to create your first "),Z=e("Collection"),$=e("."),tt=t("ol",null,[t("li",null,"Navigate into the Content Module."),t("li",null,[e("Click "),t("strong",null,"\u201CCreate Collection\u201D"),e(" and a side menu will appear.")]),t("li",null,[e("Fill in a "),t("strong",null,"Name"),e("."),t("br"),e(" For the sake of this demo, we\u2019ll call ours "),t("code",{class:""},"articles"),e(", but feel free to make it your own!")]),t("li",null,[e("Leave the other options at default. Click "),t("span",{mi:"",btn:""},"arrow_forward"),e(" and the "),t("strong",null,"\u201COptional System Fields\u201D"),e(" menu will open."),t("br"),e(" Keep the values in this menu at the default, toggled off, for now. You can adjust them later.")]),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" in the menu header.")])],-1),et={class:"tip hint"},ot=t("div",{class:"hint-title"},"Learn More About Collections",-1),st=e("The Content Module"),nt=e("Create and Manage a Collection"),lt=e("Build Relationships Between Collections"),it=e(' @TODO configuration > data-model Change the link to the "Create a Collection" format '),at=t("h2",{id:"4.-create-a-field"},[e("4. Create a Field "),t("a",{class:"header-anchor",href:"#4.-create-a-field"},"#")],-1),ct=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-field-20220427A.mp4",type:"video/mp4"})],-1),rt=e("With your first Collection created, it\u2019s time to start adding some "),dt=e("Fields"),ut=e("."),ht=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,[e("Settings Module > Data Model > "),t("code",{class:""},"Collection-Name")]),e(".")]),t("li",null,[e("Click the "),t("strong",null,"\u201CCreate Field\u201D"),e(" button and select the "),t("strong",null,"\u201CInput\u201D"),e(" Field type.")]),t("li",null,[e("Fill in a Field name under "),t("strong",null,"Key"),e(". We\u2019ll be calling our Field "),t("code",{class:""},"title"),e("."),t("br"),e(" Directus offers powerful Field customization options, but let\u2019s stick to the defaults for now.")]),t("li",null,[e("Select "),t("strong",null,"\u201CSave\u201D"),e(".")])],-1),_t={class:"tip hint"},pt=t("div",{class:"hint-title"},"Learn More About Fields",-1),mt=e("Create and Manage Fields in the App"),ft=t("h2",{id:"5.-create-an-item"},[e("5. Create an Item "),t("a",{class:"header-anchor",href:"#5.-create-an-item"},"#")],-1),gt=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-an-item-20220427B.mp4",type:"video/mp4"})],-1),yt=e("Now that we have a Collection with a Field configured, it\u2019s time to add an "),bt=e("Item"),vt=e("."),wt=t("ol",null,[t("li",null,"Navigate to the Content Module."),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"add"),e(" in the page header to open the Item Page.")]),t("li",null,"Fill in the Field Value(s) as desired."),t("li",null,[e("Click "),t("span",{mi:"",btn:""},"check"),e(" in the top-right to save your Item.")])],-1),Ct={class:"tip hint"},kt=t("div",{class:"hint-title"},"Learn More About Items",-1),At=e("The Content Module"),Pt=e("The Item Page"),jt=t("h2",{id:"6.-set-roles-%26-permissions"},[e("6. Set Roles & Permissions "),t("a",{class:"header-anchor",href:"#6.-set-roles-%26-permissions"},"#")],-1),It=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/set-read-permissions-20220427A.mp4",type:"video/mp4"})],-1),Tt=t("p",null,"Directus comes with two built-in roles: Public and Admin. The Public Role determines what data is returned to non-authenticated users. Public comes with all permissions turned off and can be reconfigured with fully granular control to expose exactly what you want unauthenticated Users to see. The Admin role has full permissions and this cannot be changed. Aside from these built-in Roles, any number of new Roles can be created, all with fully customized, granular permissions.",-1),St=t("p",null,[e("By Default, content entered into Directus will be considered private. So permissions always start off set to the default of "),t("span",{mi:"",icon:"",dngr:""},"block"),e(),t("strong",null,"No Access"),e(", with full ability to reconfigure as desired. So, in order to have the API return our Items, let\u2019s add some read permissions. For simplicity\u2019s sake, we\u2019ll do this on the Public Role, instead of creating a new Role.")],-1),Dt=t("ol",null,[t("li",null,[e("Navigate to "),t("strong",null,"Settings Module > Roles & Permissions > Public"),e(".")]),t("li",null,[e("Click "),t("span",{mi:"",icon:"",dngr:""},"block"),e(" under the "),t("span",{mi:"",icon:""},"visibility"),e(" icon on the desired Collection."),t("br"),e(" In our case, the Collection name is "),t("code",{class:""},"article"),e(".")]),t("li",null,[e("Click "),t("strong",null,"\u201CAll Access\u201D"),e(" to give the Public Role full read permissions to the Items in this Collection.")])],-1),Ft={class:"tip hint"},Mt=t("div",{class:"hint-title"},"Learn More About Roles & Permissions",-1),qt=e("Users, Roles and Permissions"),Nt=e("."),Rt=t("h2",{id:"7.-connect-to-the-api"},[e("7. Connect to the API "),t("a",{class:"header-anchor",href:"#7.-connect-to-the-api"},"#")],-1),xt=e("Now that your Project has some content in it which is exposed to the Public, it\u2019s time to start using this content externally! Data can be accessed in a number of ways, including the REST and GraphQL API Enpoints. In this case, we\u2019ll use the "),Lt=t("code",{class:""},"/items/",-1),Ot=e(),Bt=e("REST API endpoint"),Gt=e(" to retrieve the Item we just created."),Et=t("ol",null,[t("li",null,[e("Open "),t("code",{class:""},"http://your-project-url.directus.app/items/articles"),e("."),t("br"),e(" You can use the browser or an API tool like "),t("a",{href:"http://postman.com",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" or "),t("a",{href:"https://paw.cloud",target:"_blank",rel:"noopener noreferrer"},"Paw")])],-1),Ht=t("p",null,[t("em",null,"And there it is! The Article Item you just created is being served in beautiful JSON, ready to be used anywhere and everywhere!")],-1),Ut=t("pre",null,[t("code",{class:"language-json"},[e(`{
-	`),t("span",{class:"hljs-attr"},'"data"'),e(`: [
-		{
-			`),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"1"),e(`,
-			`),t("span",{class:"hljs-attr"},'"title"'),e(": "),t("span",{class:"hljs-string"},'"Hello World!"'),e(`
-		}
-	]
-}
-`)])],-1),Qt=t("p",null,[t("em",null,"In this example, we made a super-simple read request with the API, but there\u2019s more! The REST and GraphQL APIs provide exhaustive endpoints for the data model and every single action that you can do in the App can be done via the API. In fact, the App is just a GUI powered by the API.")],-1),Vt={class:"tip hint"},Wt=t("div",{class:"hint-title"},"Learn More About The API",-1),Yt=e("Intro to the API"),zt=e("JS SDK"),Kt={title:"Quickstart Guide",modularExtension:!1},Jt={name:"quickstart",setup(Xt,{expose:a}){return a({frontmatter:{title:"Quickstart Guide",modularExtension:!1}}),(Zt,$t)=>{const s=l("router-link"),c=l("docswrapper");return r(),d(c,{frontmatter:Kt},{default:o(()=>[t("div",u,[h,_,p,t("p",null,[m,n(s,{to:"/docs/cloud/accounts/#create-account-and-login"},{default:o(()=>[f]),_:1}),g,y]),b,v,w,t("div",C,[k,t("ul",null,[t("li",null,[n(s,{to:"/docs/cloud/overview/"},{default:o(()=>[A]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/accounts/"},{default:o(()=>[P]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/teams/"},{default:o(()=>[j]),_:1})])])]),I,T,S,t("ol",null,[t("li",null,[D,n(s,{to:"/docs/cloud/teams/#create-a-team"},{default:o(()=>[F]),_:1}),M]),q,N,R,x,L]),O,t("ol",B,[t("li",null,[G,n(s,{to:"/docs/cloud/projects/#access-a-project"},{default:o(()=>[E]),_:1}),H]),U]),Q,t("div",V,[W,t("ul",null,[t("li",null,[n(s,{to:"/docs/cloud/overview/"},{default:o(()=>[Y]),_:1})]),t("li",null,[n(s,{to:"/docs/cloud/projects/"},{default:o(()=>[z]),_:1})])])]),K,J,t("p",null,[X,n(s,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[Z]),_:1}),$]),tt,t("div",et,[ot,t("ul",null,[t("li",null,[n(s,{to:"/docs/app/content"},{default:o(()=>[st]),_:1})]),t("li",null,[n(s,{to:"/docs/configuration/data-model/"},{default:o(()=>[nt]),_:1})]),t("li",null,[n(s,{to:"/docs/configuration/relationships/"},{default:o(()=>[lt]),_:1})])])]),it,at,ct,t("p",null,[rt,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[dt]),_:1}),ut]),ht,t("div",_t,[pt,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/data-model/"},{default:o(()=>[mt]),_:1})])])]),ft,gt,t("p",null,[yt,n(s,{to:"/docs/getting-started/glossary/#"},{default:o(()=>[bt]),_:1}),vt]),wt,t("div",Ct,[kt,t("ul",null,[t("li",null,[n(s,{to:"/docs/app/content/"},{default:o(()=>[At]),_:1})]),t("li",null,[n(s,{to:"/docs/app/content/items"},{default:o(()=>[Pt]),_:1})])])]),jt,It,Tt,St,Dt,t("div",Ft,[Mt,t("ul",null,[t("li",null,[n(s,{to:"/docs/configuration/users-roles-permissions/"},{default:o(()=>[qt]),_:1}),Nt])])]),Rt,t("p",null,[xt,Lt,Ot,n(s,{to:"/docs/reference/items"},{default:o(()=>[Bt]),_:1}),Gt]),Et,Ht,Ut,Qt,t("div",Vt,[Wt,t("ul",null,[t("li",null,[n(s,{to:"/docs/reference/introduction/"},{default:o(()=>[Yt]),_:1})]),t("li",null,[n(s,{to:"/docs/reference/sdk/"},{default:o(()=>[zt]),_:1})])])])])]),_:1})}}};typeof i=="function"&&i(Jt);export{Jt as default,Kt as frontmatter};

package/dist/assets/quickstart.4d7c7736.js

@@ -1,20 +0,0 @@
-import{a,o as c,b as d,w as o,g as t,e as n,B as e}from"./runtime-core.esm-bundler.b1f35d24.js";var i={};const h={class:"markdown-body"},u=t("blockquote",null,[t("p",null,"If you\u2019re looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.")],-1),p=t("h2",{id:"1.-installation"},[e("1. Installation "),t("a",{class:"header-anchor",href:"#1.-installation"},"#")],-1),_=t("p",null,[e("Make sure you have the latest LTS version or newer of "),t("a",{href:"https://nodejs.dev",target:"_blank",rel:"noopener noreferrer"},"Node.js"),e(" installed, and have a running database ready to connect to.")],-1),m=t("p",null,"Run the following command in your terminal and follow the prompts.",-1),g=t("pre",null,[t("code",{class:"language-bash"},`npm init directus-project example-project
-`)],-1),f=t("p",null,"Choose SQLite from the list. Use up/down arrow keys to select the SQL type.",-1),b=t("pre",null,[t("code",{class:"language-bash"},`? Choose your database client SQLite
-`)],-1),y=t("p",null,[e("After that a file path for "),t("code",{class:""},"data.db"),e(", your database, will be suggested. Hit the enter key to stick with the default path.")],-1),w=t("pre",null,[t("code",{class:"language-bash"},`? Database File Path: <file-path>/example-project/data.db
-`)],-1),v=t("p",null,"Next you\u2019ll set your username/email and password.",-1),k=t("pre",null,[t("code",{class:"language-bash"},`Create your first admin user:
-? Email: admin@example.com
-? Password: ********
-`)],-1),I=t("p",null,"After that, you\u2019re all set!",-1),P=t("pre",null,[t("code",{class:""},`Your project has been created at <file-path>/example-project.
-
-The configuration can be found in <file-path>/example-project/.env
-`)],-1),C=t("p",null,[e("Once the installation is complete, you can start Directus by navigating to your project folder "),t("em",null,[e("(in this case "),t("code",{class:""},"example-project"),e(")")]),e(" and running:")],-1),j=t("pre",null,[t("code",{class:"language-bash"},`npx directus start
-`)],-1),x=t("p",null,"After that, you will see this message:",-1),A=t("pre",null,[t("code",{class:"language-bash"},`\u2728 Server started at http://localhost:8055
-`)],-1),D=t("h4",{id:"other-options"},[e("Other Options "),t("a",{class:"header-anchor",href:"#other-options"},"#")],-1),S=t("p",null,"When you link other types of SQL to Directus, you may have additional prompts:",-1),F=t("ul",null,[t("li",null,[t("strong",null,"Database Host"),e(" \u2013 IP address for your database.")]),t("li",null,[t("strong",null,"Port"),e(" \u2013 Port number your database is running on.")]),t("li",null,[t("strong",null,"Database Name"),e(" \u2013 Name of your existing database.")]),t("li",null,[t("strong",null,"Database User"),e(" \u2013 Name of existing user in database.")]),t("li",null,[t("strong",null,"Database Password"),e(" \u2013 Password to enter database.")]),t("li",null,[t("strong",null,"Enable SSL"),e(" \u2013 Select "),t("code",{class:""},"Y"),e(" for yes or "),t("code",{class:""},"N"),e(" for no.")]),t("li",null,[t("strong",null,"Root"),e(" \u2013 Provide the root name.")])],-1),N=t("p",null,"Simply configure these according to your project\u2019s needs.",-1),q=t("div",{class:"warning hint"},[t("div",{class:"hint-title"},"Directus seeds your database"),t("p",null,"Directus installs a few dozen tables into the database it is linked to; so if you\u2019re adding it to a database with existing data. However, installation of Directus will not alter the existing data tables.")],-1),T=t("h2",{id:"2.-login-to-app"},[e("2. Login to App "),t("a",{class:"header-anchor",href:"#2.-login-to-app"},"#")],-1),R=t("p",null,"With the server running, you\u2019re now able to login to your new Directus project and start using it.",-1),L=t("p",null,[e("Our start command stated that the server started at port "),t("code",{class:""},"8055"),e(", which means we can navigate to "),t("a",{href:"http://localhost:8055",target:"_blank",rel:"noopener noreferrer"},"http://localhost:8055"),e(" to open Directus in the browser.")],-1),E=t("p",null,"Login using the admin credentials you configured during the installation in Step 1.",-1),M=t("h2",{id:"3.-create-a-collection"},[e("3. Create a Collection "),t("a",{class:"header-anchor",href:"#3.-create-a-collection"},"#")],-1),O=t("p",null,"Once logged in, you\u2019re greeted with the option to create your first Collection:",-1),Q=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220217A/empty-state-20220217A.webp",alt:"Directus Empty State"})],-1),W=t("p",null,[e("Follow the prompts and create a Collection. For the sake of this demo, we\u2019ll be calling ours "),t("code",{class:""},"articles"),e(", but feel free to make it your own!")],-1),B={class:"tip hint"},H=t("div",{class:"hint-title"},"More Info on Collections",-1),G=e("For a more in-depth guide to setting up Collections, see "),U=e("Collections"),V=e("."),z=t("h2",{id:"4.-create-a-field"},[e("4. Create a Field "),t("a",{class:"header-anchor",href:"#4.-create-a-field"},"#")],-1),Y=t("p",null,[e("With the Collection created, it\u2019s time to start adding some Fields. Click the "),t("strong",null,"\u201CCreate Field\u201D"),e(" button, and select "),t("strong",null,"\u201CInput\u201D"),e(":")],-1),J=t("video",{autoplay:"",muted:"",loop:"",controls:""},[t("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220217A/add-field-20220217A.mp4",type:"video/mp4"})],-1),K=t("p",null,[e("We\u2019ll be calling our Field "),t("code",{class:""},"title"),e(". While Directus offers a range of powerful field customization options, we\u2019ll be sticking to the defaults for now. These defaults use the \u201CString\u201D datatype.")],-1),X={class:"tip hint"},Z=t("div",{class:"hint-title"},"More Info on Fields",-1),$=e("To learn more about the different types of Fields, and all available options, see "),tt=e("Fields"),et=e("."),ot=t("h2",{id:"5.-create-an-item"},[e("5. Create an Item "),t("a",{class:"header-anchor",href:"#5.-create-an-item"},"#")],-1),st=t("p",null,[e("Now that we have a Collection with a Field configured, it\u2019s time to start adding some content. Navigate to the Content Module (top left), and click "),t("span",{mi:"",btn:""},"add"),e(" in the top-right to get started. This will take you to the Create/Edit Item page:")],-1),nt=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220217A/create-item-20220217A.webp",alt:"Directus Create Item"})],-1),at=t("p",null,[e("Once you\u2019re happy with your creation, click "),t("span",{mi:"",btn:""},"check"),e(" in the top-right to save your Item to the database.")],-1),it={class:"tip hint"},lt=t("div",{class:"hint-title"},"More Info on Items",-1),rt=e("To learn more about the different types of Items, and all available options, see "),ct=e("Items"),dt=e("."),ht=t("h2",{id:"6.-set-role%2Fpublic-permissions"},[e("6. Set Role/Public Permissions "),t("a",{class:"header-anchor",href:"#6.-set-role%2Fpublic-permissions"},"#")],-1),ut=t("p",null,[e("By default, all content entered into Directus is considered private. This means that no data will be returned by the API, unless requested by an authenticated user that has the correct permissions. In order to have the API return our items, we\u2019ll have to setup some permissions. Navigate to "),t("strong",null,[e("Settings Module "),t("span",{mi:"",icon:"",dark:""},"chevron_right"),e(" Roles & Permissions")]),e(".")],-1),pt=t("p",null,[e("Directus ships with a special "),t("strong",null,"\u201CPublic\u201D"),e(" role that controls what data is returned to non-authenticated users. Select the Public Role, find your Collection, and click the icon under the "),t("span",{mi:"",icon:""},"visibility"),e(" icon (read/view permission) to allow the Public Role to read the Items in your Collection.")],-1),_t=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220217A/permissions-20220217A.webp",alt:"Directus Permissions"})],-1),mt={class:"tip hint"},gt=t("div",{class:"hint-title"},"More Info on Roles & Permissions",-1),ft=e("Roles & Permissions are extremely powerful and can get pretty in-depth. To learn all about the nuances in setting these up, see "),bt=e("Roles"),yt=e(" & "),wt=e("Permissions"),vt=e("."),kt=t("h2",{id:"7.-connect-to-the-api"},[e("7. Connect to the API "),t("a",{class:"header-anchor",href:"#7.-connect-to-the-api"},"#")],-1),It=e("Now that your project has some content in it, it\u2019s time to start using this content externally. Data can be accessed in a number of ways, including the REST API, GraphQL, the CLI, or even straight from the database. In this case, we\u2019ll use "),Pt=e("the "),Ct=t("code",{class:""},"/items/",-1),jt=e(" REST API endpoint"),xt=e(" to retrieve the item we just created."),At=t("p",null,[e("Using your browser, or an API tool like "),t("a",{href:"http://postman.com",target:"_blank",rel:"noopener noreferrer"},"Postman"),e(" or "),t("a",{href:"https://paw.cloud",target:"_blank",rel:"noopener noreferrer"},"Paw"),e(", open "),t("a",{href:"http://localhost:8055/items/articles",target:"_blank",rel:"noopener noreferrer"},"http://localhost:8055/items/articles"),e(".")],-1),Dt=t("p",null,"And there it is! The Article Item you just created is being served in beautiful JSON, ready to be used anywhere and everywhere!",-1),St=t("pre",null,[t("code",{class:"language-json"},[e(`{
-	`),t("span",{class:"hljs-attr"},'"data"'),e(`: [
-		{
-			`),t("span",{class:"hljs-attr"},'"id"'),e(": "),t("span",{class:"hljs-number"},"1"),e(`,
-			`),t("span",{class:"hljs-attr"},'"title"'),e(": "),t("span",{class:"hljs-string"},'"Hello World!"'),e(`
-		}
-	]
-}
-`)])],-1),Ft={title:"Quickstart Guide",modularExtension:!1},Nt={name:"quickstart",setup(qt,{expose:l}){return l({frontmatter:{title:"Quickstart Guide",modularExtension:!1}}),(Tt,Rt)=>{const s=a("router-link"),r=a("docswrapper");return c(),d(r,{frontmatter:Ft},{default:o(()=>[t("div",h,[u,p,_,m,g,f,b,y,w,v,k,I,P,C,j,x,A,D,S,F,N,q,T,R,L,E,M,O,Q,W,t("div",B,[H,t("p",null,[G,n(s,{to:"/docs/app/content-collections"},{default:o(()=>[U]),_:1}),V])]),z,Y,J,K,t("div",X,[Z,t("p",null,[$,n(s,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[tt]),_:1}),et])]),ot,st,nt,at,t("div",it,[lt,t("p",null,[rt,n(s,{to:"/docs/app/content-items/"},{default:o(()=>[ct]),_:1}),dt])]),ht,ut,pt,_t,t("div",mt,[gt,t("p",null,[ft,n(s,{to:"/docs/reference/system/roles"},{default:o(()=>[bt]),_:1}),yt,n(s,{to:"/docs/reference/system/permissions"},{default:o(()=>[wt]),_:1}),vt])]),kt,t("p",null,[It,n(s,{to:"/docs/reference/items"},{default:o(()=>[Pt,Ct,jt]),_:1}),xt]),At,Dt,St])]),_:1})}}};typeof i=="function"&&i(Nt);export{Nt as default,Ft as frontmatter};

package/dist/assets/relations.d29aa86d.js

@@ -1,115 +0,0 @@
-import{a,o as i,b as c,w as l,g as e,e as h,B as s}from"./runtime-core.esm-bundler.b1f35d24.js";var t={};const d={class:"markdown-body"},p={class:"two-up"},u={class:"left"},_=s("What data is linked to what other data. Allows you to assign authors to articles, products to sales, and whatever other structures you can think of. "),g=s("Learn more about Relationships"),f=s("."),m=e("div",{class:"right"},[e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#the-relation-object"},"The Relation Object")]),e("li",null,[e("a",{href:"#list-relations"},"List relations")]),e("li",null,[e("a",{href:"#list-relations-in-collection"},"List relations in collection")]),e("li",null,[e("a",{href:"#retrieve-a-relation"},"Retrieve a relation")]),e("li",null,[e("a",{href:"#create-a-relation"},"Create a Relation")]),e("li",null,[e("a",{href:"#update-a-relation"},"Update a Relation")]),e("li",null,[e("a",{href:"#delete-a-relation"},"Delete a Relation")])])])])],-1),y=e("hr",null,null,-1),j=e("h2",{id:"the-relation-object"},[s("The Relation Object "),e("a",{class:"header-anchor",href:"#the-relation-object"},"#")],-1),b=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"collection"),s(),e("strong",null,"string"),e("br"),s(" Name of the collection. This matches the table name in the database.")]),e("p",null,[e("code",{class:""},"field"),s(),e("strong",null,"string"),e("br"),s(" Name of the field that holds the related primary key. This matches the column name in the database.")]),e("p",null,[e("code",{class:""},"related_collection"),s(),e("strong",null,"string"),e("br"),s(" Name of the related collection. This matches the table name in the database.")])]),e("h4",{id:"meta"},[s("Meta "),e("a",{class:"header-anchor",href:"#meta"},"#")]),e("p",null,"Directus metadata. Used to enable non-database relationship types"),e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"id"),s(),e("strong",null,"integer"),e("br"),s(" Primary key of the metadata row in "),e("code",{class:""},"directus_relations"),s(".")]),e("p",null,[e("code",{class:""},"many_collection"),s(),e("strong",null,"string"),e("br"),s(" Name of the collection. Matches the top level "),e("code",{class:""},"collection"),s(" field.")]),e("p",null,[e("code",{class:""},"many_field"),s(),e("strong",null,"string"),e("br"),s(" Name of the field. Matches the top level "),e("code",{class:""},"field"),s(" field.")]),e("p",null,[e("code",{class:""},"one_collection"),s(),e("strong",null,"string"),e("br"),s(" Name of the related collection. Matches the top level "),e("code",{class:""},"related_collection"),s(" field.")]),e("p",null,[e("code",{class:""},"one_field"),s(),e("strong",null,"string"),e("br"),s(" Name of the one to many field on the other side of the relation.")]),e("p",null,[e("code",{class:""},"one_allowed_collections"),s(),e("strong",null,"string"),e("br"),s(" What collections are allowed to be used in a many-to-any context.")]),e("p",null,[e("code",{class:""},"one_collection_field"),s(),e("strong",null,"string"),e("br"),s(" Field that holds the collection name in a many-to-any context.")]),e("p",null,[e("code",{class:""},"one_deselect_action"),s(),e("strong",null,"nullify | delete"),e("br"),s(" Whether to nullify or delete related one-to-many records.")]),e("p",null,[e("code",{class:""},"sort_field"),s(),e("strong",null,"string"),e("br"),s(" What field is used to hold the sort field.")]),e("p",null,[e("code",{class:""},"junction_field"),s(),e("strong",null,"string"),e("br"),s(" What field connects two relations in a many-to-many (o2m-m2o) context.")])]),e("h4",{id:"schema"},[s("Schema "),e("a",{class:"header-anchor",href:"#schema"},"#")]),e("p",null,"\u201CRaw\u201D database information. Based on the database vendor used, different information might be returned. The following are available for all drivers."),e("div",{class:"definitions"},[e("p",null,[e("code",{class:""},"table"),s(),e("strong",null,"string"),e("br"),s(" The table name.")]),e("p",null,[e("code",{class:""},"column"),s(),e("strong",null,"string"),e("br"),s(" The column name.")]),e("p",null,[e("code",{class:""},"foreign_key_table"),s(),e("strong",null,"string"),e("br"),s(" Related table name.")]),e("p",null,[e("code",{class:""},"foreign_key_column"),s(),e("strong",null,"string"),e("br"),s(" Related column name.")]),e("p",null,[e("code",{class:""},"constraint_name"),s(),e("strong",null,"string"),e("br"),s(" Name for the foreign key constraint.")]),e("p",null,[e("code",{class:""},"on_update"),s(),e("strong",null,"string"),e("br"),s(" Update trigger for the foreign key constraint.")]),e("p",null,[e("code",{class:""},"on_delete"),s(),e("strong",null,"string"),e("br"),s(" Delete trigger for the foreign key constraint.")])])]),e("div",{class:"right"},[e("pre",null,[e("code",{class:"language-json"},[s(`{
-	`),e("span",{class:"hljs-attr"},'"collection"'),s(": "),e("span",{class:"hljs-string"},'"about_us"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"field"'),s(": "),e("span",{class:"hljs-string"},'"logo"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"related_collection"'),s(": "),e("span",{class:"hljs-string"},'"directus_files"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"schema"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"table"'),s(": "),e("span",{class:"hljs-string"},'"about_us"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"column"'),s(": "),e("span",{class:"hljs-string"},'"logo"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"foreign_key_table"'),s(": "),e("span",{class:"hljs-string"},'"directus_files"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"foreign_key_column"'),s(": "),e("span",{class:"hljs-string"},'"id"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"constraint_name"'),s(": "),e("span",{class:"hljs-string"},'"about_us_logo_foreign"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"on_update"'),s(": "),e("span",{class:"hljs-string"},'"NO ACTION"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"on_delete"'),s(": "),e("span",{class:"hljs-string"},'"SET NULL"'),s(`
-	},
-	`),e("span",{class:"hljs-attr"},'"meta"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"id"'),s(": "),e("span",{class:"hljs-number"},"1"),s(`,
-		`),e("span",{class:"hljs-attr"},'"junction_field"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-		`),e("span",{class:"hljs-attr"},'"many_collection"'),s(": "),e("span",{class:"hljs-string"},'"about_us"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"many_field"'),s(": "),e("span",{class:"hljs-string"},'"logo"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"one_allowed_collections"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-		`),e("span",{class:"hljs-attr"},'"one_collection"'),s(": "),e("span",{class:"hljs-string"},'"directus_files"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"one_collection_field"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-		`),e("span",{class:"hljs-attr"},'"one_deselect_action"'),s(": "),e("span",{class:"hljs-string"},'"nullify"'),s(`,
-		`),e("span",{class:"hljs-attr"},'"one_field"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`,
-		`),e("span",{class:"hljs-attr"},'"sort_field"'),s(": "),e("span",{class:"hljs-literal"},"null"),s(`
-	}
-}
-`)])])])],-1),q=e("hr",null,null,-1),v=e("h2",{id:"list-relations"},[s("List relations "),e("a",{class:"header-anchor",href:"#list-relations"},"#")],-1),x=e("p",null,"List all relations that exist in Directus.",-1),w=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Permissions"),e("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),e("h3",{id:"query-parameters"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns"},"#")]),e("p",null,[s("Array of "),e("a",{href:"#the-relation-object"},"relation objects"),s(". If no items are available, data will be an empty array.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api"},"#")]),e("pre",null,[e("code",{class:""},`GET /relations
-`)]),e("h3",{id:"graphql"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	relations: [directus_relations]
-}
-`)])]),e("h5",{id:"example"},[s("Example "),e("a",{class:"header-anchor",href:"#example"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	relations {
-		collection
-		field
-	}
-}
-`)])])])],-1),T=e("hr",null,null,-1),R=e("h2",{id:"list-relations-in-collection"},[s("List relations in collection "),e("a",{class:"header-anchor",href:"#list-relations-in-collection"},"#")],-1),E=e("p",null,"List all relations that exist in a given collection.",-1),k=e("div",{class:"two-up"},[e("div",{class:"left"},[e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Permissions"),e("p",null,"The data returned in this endpoint will be filtered based on the user\u2019s permissions. For example, relations that apply to a collection that the current user doesn\u2019t have access to are stripped out.")]),e("h3",{id:"query-parameters-2"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-2"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns-2"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-2"},"#")]),e("p",null,[s("Array of "),e("a",{href:"#the-relation-object"},"relation objects"),s(". If no items are available, data will be an empty array.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-2"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /relations/:collection
-`)]),e("h5",{id:"example-2"},[s("Example "),e("a",{class:"header-anchor",href:"#example-2"},"#")]),e("pre",null,[e("code",{class:""},`GET /relations/articles
-`)]),e("h3",{id:"graphql-2"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-2"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	relations_in_collection(collection:`),e("span",{class:"hljs-type"}," String"),s(`!): [directus_relations]
-}
-`)])]),e("h5",{id:"example-3"},[s("Example "),e("a",{class:"header-anchor",href:"#example-3"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	relations_in_collection(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(`) {
-		collection
-		field
-	}
-}
-`)])])])],-1),P=e("hr",null,null,-1),S=e("h2",{id:"retrieve-a-relation"},[s("Retrieve a relation "),e("a",{class:"header-anchor",href:"#retrieve-a-relation"},"#")],-1),L=e("p",null,"List an existing relation by collection/field name.",-1),A=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-3"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-3"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"returns-3"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-3"},"#")]),e("p",null,[s("Returns the requested "),e("a",{href:"#the-relation-object"},"relation object"),s(".")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-3"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-3"},"#")]),e("pre",null,[e("code",{class:""},`GET /relations/:collection/:field
-`)]),e("h5",{id:"example-4"},[s("Example "),e("a",{class:"header-anchor",href:"#example-4"},"#")]),e("pre",null,[e("code",{class:""},`GET /relations/articles/featured_image
-`)]),e("h3",{id:"graphql-3"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-3"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Query"),s(` {
-	relations_by_name(collection:`),e("span",{class:"hljs-type"}," String"),s("!, field:"),e("span",{class:"hljs-type"}," String"),s(`!): directus_relations
-}
-`)])]),e("h5",{id:"example-5"},[s("Example "),e("a",{class:"header-anchor",href:"#example-5"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"query"),s(` {
-	relations_by_name(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", field: "),e("span",{class:"hljs-string"},'"featured_image"'),s(`) {
-		collection
-		field
-		related_collection
-	}
-}
-`)])])])],-1),N=e("hr",null,null,-1),Q=e("h2",{id:"create-a-relation"},[s("Create a Relation "),e("a",{class:"header-anchor",href:"#create-a-relation"},"#")],-1),D=e("p",null,"Create a new relation.",-1),O=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-4"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-4"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"request-body"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body"},"#")]),e("p",null,[s("A partial "),e("a",{href:"#the-relation-object"},"relation object"),s(".")]),e("h3",{id:"returns-4"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-4"},"#")]),e("p",null,[s("Returns the "),e("a",{href:"#the-relation-object"},"relation object"),s(" for the created relation.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-4"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /relations
-`)]),e("h5",{id:"example-6"},[s("Example "),e("a",{class:"header-anchor",href:"#example-6"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// POST /relations"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"collection"'),s(": "),e("span",{class:"hljs-string"},'"articles"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"field"'),s(": "),e("span",{class:"hljs-string"},'"featured_image"'),s(`,
-	`),e("span",{class:"hljs-attr"},'"related_collection"'),s(": "),e("span",{class:"hljs-string"},'"directus_files"'),s(`
-}
-`)])]),e("h3",{id:"graphql-4"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-4"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	create_relations_item(data: create_directus_relations_input!): directus_relations
-}
-`)])]),e("h5",{id:"example-7"},[s("Example "),e("a",{class:"header-anchor",href:"#example-7"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	create_relations_item(
-		data: { collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", field: "),e("span",{class:"hljs-string"},'"featured_image"'),s(", related_collection: "),e("span",{class:"hljs-string"},'"directus_files"'),s(` }
-	) {
-		collection
-		field
-		related_collection
-	}
-}
-`)])])])],-1),G=e("hr",null,null,-1),C=e("h2",{id:"update-a-relation"},[s("Update a Relation "),e("a",{class:"header-anchor",href:"#update-a-relation"},"#")],-1),I=e("p",null,"Update an existing relation.",-1),B=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"query-parameters-5"},[s("Query Parameters "),e("a",{class:"header-anchor",href:"#query-parameters-5"},"#")]),e("p",null,"Doesn\u2019t support any query parameters."),e("h3",{id:"request-body-2"},[s("Request Body "),e("a",{class:"header-anchor",href:"#request-body-2"},"#")]),e("p",null,[s("A partial "),e("a",{href:"#the-relation-object"},"relation object"),s(".")]),e("h3",{id:"returns-5"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-5"},"#")]),e("p",null,[s("Returns the "),e("a",{href:"#the-relation-object"},"relation object"),s(" for the created relation.")])]),e("div",{class:"right"},[e("h3",{id:"rest-api-5"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-5"},"#")]),e("pre",null,[e("code",{class:""},`PATCH /relations/:collection/:field
-`)]),e("h5",{id:"example-8"},[s("Example "),e("a",{class:"header-anchor",href:"#example-8"},"#")]),e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-comment"},"// PATCH /relations/articles/author"),s(`
-
-{
-	`),e("span",{class:"hljs-attr"},'"meta"'),s(`: {
-		`),e("span",{class:"hljs-attr"},'"one_field"'),s(": "),e("span",{class:"hljs-string"},'"articles"'),s(`
-	}
-}
-`)])]),e("h3",{id:"graphql-5"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-5"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	update_relations_item(collection:`),e("span",{class:"hljs-type"}," String"),s("!, field:"),e("span",{class:"hljs-type"}," String"),s(`!, data: update_directus_relations_input!): directus_relations
-}
-`)])]),e("h5",{id:"example-9"},[s("Example "),e("a",{class:"header-anchor",href:"#example-9"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	update_relations_item(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", field: "),e("span",{class:"hljs-string"},'"author"'),s(", data: { meta: { one_field: "),e("span",{class:"hljs-string"},'"articles"'),s(` } }) {
-		collection
-		field
-		related_collection
-	}
-}
-`)])])])],-1),M=e("hr",null,null,-1),U=e("h2",{id:"delete-a-relation"},[s("Delete a Relation "),e("a",{class:"header-anchor",href:"#delete-a-relation"},"#")],-1),W=e("p",null,"Delete an existing relation.",-1),F=e("div",{class:"two-up"},[e("div",{class:"left"},[e("h3",{id:"returns-6"},[s("Returns "),e("a",{class:"header-anchor",href:"#returns-6"},"#")]),e("p",null,"Empty body.")]),e("div",{class:"right"},[e("h3",{id:"rest-api-6"},[s("REST API "),e("a",{class:"header-anchor",href:"#rest-api-6"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /relations/:collection/:field
-`)]),e("h5",{id:"example-10"},[s("Example "),e("a",{class:"header-anchor",href:"#example-10"},"#")]),e("pre",null,[e("code",{class:""},`DELETE /relations/articles/author
-`)]),e("h3",{id:"graphql-6"},[s("GraphQL "),e("a",{class:"header-anchor",href:"#graphql-6"},"#")]),e("pre",null,[e("code",{class:""},`POST /graphql/system
-`)]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"type"),e("span",{class:"hljs-type"}," Mutation"),s(` {
-	delete_relations_item(collection:`),e("span",{class:"hljs-type"}," String"),s("!, field:"),e("span",{class:"hljs-type"}," String"),s(`!): delete_one
-}
-`)])]),e("h5",{id:"example-11"},[s("Example "),e("a",{class:"header-anchor",href:"#example-11"},"#")]),e("pre",null,[e("code",{class:"language-graphql"},[e("span",{class:"hljs-keyword"},"mutation"),s(` {
-	delete_relations_item(collection: `),e("span",{class:"hljs-string"},'"articles"'),s(", field: "),e("span",{class:"hljs-string"},'"author"'),s(`) {
-		collection
-		field
-	}
-}
-`)])])])],-1),V={title:"Relations",modularExtension:!1,pageClass:"page-reference"},H={name:"relations",setup(z,{expose:n}){return n({frontmatter:{title:"Relations",modularExtension:!1,pageClass:"page-reference"}}),(J,K)=>{const r=a("router-link"),o=a("docswrapper");return i(),c(o,{frontmatter:V},{default:l(()=>[e("div",d,[e("div",p,[e("div",u,[e("blockquote",null,[e("p",null,[_,h(r,{to:"/docs/getting-started/glossary/#relationships"},{default:l(()=>[g]),_:1}),f])])]),m]),y,j,b,q,v,x,w,T,R,E,k,P,S,L,A,N,Q,D,O,G,C,I,B,M,U,W,F])]),_:1})}}};typeof t=="function"&&t(H);export{H as default,V as frontmatter};

package/dist/assets/relationships.c9c5db8a.js

@@ -1,55 +0,0 @@
-import{a as i,o as c,b as d,w as n,g as e,e as l,B as t}from"./runtime-core.esm-bundler.b1f35d24.js";var s={};const h={class:"markdown-body"},u=e("blockquote",null,[e("p",null,[t("As you might have guessed, relationships are a crucial part of any relational database. Directus supports all standard relationship types, as well as a few more "),e("em",null,"compound"),t(" types that offer greater flexibility.")])],-1),f=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#many-to-one-(m2o)"},"Many-to-One (M2O)")]),e("li",null,[e("a",{href:"#one-to-many-(o2m)"},"One-to-Many (O2M)")]),e("li",null,[e("a",{href:"#translations-(o2m)"},"Translations (O2M)")]),e("li",null,[e("a",{href:"#many-to-many-(m2m)"},"Many-to-Many (M2M)")]),e("li",null,[e("a",{href:"#many-to-any-(m2a)"},"Many-to-Any (M2A)")]),e("li",null,[e("a",{href:"#one-to-one-(o2o)"},"One-to-One (O2O)")])])])],-1),p=e("h3",{id:"introduction"},[t("Introduction "),e("a",{class:"header-anchor",href:"#introduction"},"#")],-1),m=e("p",null,"While it may seem complex at first, relational data is actually quite straightforward once you understand what\u2019s happening behind the sometimes confusing terminology. Before diving into the details of each type, let\u2019s first cover a few basics that will help you better visualize them in your mind\u2019s eye.",-1),_=e("h3",{id:"primary-and-foreign-keys"},[t("Primary and Foreign Keys "),e("a",{class:"header-anchor",href:"#primary-and-foreign-keys"},"#")],-1),y=t("Every "),g=t("Item"),w=t(" in a relational database has a unique "),M=t("Primary Key"),b=t(" (or \u201CPK\u201D) that identifies it within its "),v=t("Collection"),O=t(". Because it\u2019s required, the key is the first "),k=t("field"),T=t(" created within a collection, typically storing an \u201Cauto-increment\u201D number, an automatically generated unique hash, or a manually entered value. They are often abbreviated to \u201CPK\u201D (Primary Key), \u201CID\u201D (Identifier), \u201CUID\u201D (Unique Identifier), or \u201CUUID\u201D (Universally Unique Identifier), depending on the type of value they store. After it\u2019s created, the value of an item\u2019s PK should "),x=e("em",null,"never",-1),C=t(" change."),A=e("p",null,[t("To link items together relationally, you simply save a reference to an item\u2019s PK in a different field. That "),e("em",null,"reference"),t(" is called a Foreign Key (FK). If the primary key is a "),e("em",null,"person"),t(", the foreign key is like their "),e("em",null,"business card"),t(". It references the actual person, providing just enough information to find them.")],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Composite & Compound Keys"),e("p",null,[t("In the above explanation we\u2019ve ignored "),e("em",null,"composite"),t(" and "),e("em",null,"compound"),t(" keys, which are essentially unique keys created by combining "),e("em",null,"multiple"),t(" field/column values.")])],-1),I=e("h3",{id:"perspective-matters"},[t("Perspective Matters "),e("a",{class:"header-anchor",href:"#perspective-matters"},"#")],-1),P=e("p",null,"Just like primary and foreign keys, relationships are always described relative to their \u201Cparent\u201D collection. Looking at the same relationship/key from the perspective of the opposite collection would reverse it. This means that a many-to-one relationship can also be seen as a one-to-many relationship, it just depends on which collection is considered the parent.",-1),D=e("h2",{id:"many-to-one-(m2o)"},[t("Many-to-One (M2O) "),e("a",{class:"header-anchor",href:"#many-to-one-(m2o)"},"#")],-1),S=e("p",null,[t("The Many-to-One is the only relationship type with an actual field on the parent Collection. This field saves the foreign key to a single related item. For example, a "),e("em",null,"city"),t(" can only be in one "),e("em",null,"country"),t(", but a "),e("em",null,"country"),t(" can have many "),e("em",null,"cities"),t(".")],-1),R=e("p",null,"Below is an example of a M2O relationship:",-1),F=e("pre",null,[e("code",{class:""},`cities (the "Many" Collection)
-- id (Primary Key)
-- name
-- country (the M2O field that stores the country key)
-
-countries (the "One" Collection)
-- id (Primary Key)
-- name
-`)],-1),K=e("h3",{id:"setup"},[t("Setup "),e("a",{class:"header-anchor",href:"#setup"},"#")],-1),N=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/M2O-20220216A.webp",alt:"M2O"})],-1),q=e("p",null,"The parent collection and field are already known (it\u2019s the field you\u2019re currently creating), so configuring those are disabled. All you need to configure is the related collection and its primary key field.",-1),B=e("p",null,[t("If you select or enter an "),e("strong",null,"existing"),t(" Related Collection (highlights green) then the primary key field is known and automatically selected. If you enter the name of a "),e("strong",null,"new"),t(" Related Collection (doesn\u2019t already exist), you will also be prompted to enter the name of its primary key field, which will default to an auto-increment integer type.")],-1),J=e("p",null,[t("You also have the option to create a "),e("strong",null,"Corresponding Field"),t(" during this process. This allows you to more easily create the O2M alias (see below) that pairs with this M2O.")],-1),W=e("p",null,[e("strong",null,"Relational Triggers"),t(" allow for control over what happens when a relationship is broken. There is one option:")],-1),Y=e("ul",null,[e("li",null,[e("strong",null,"On Delete of [Related Collection]"),t(" \u2014 When the related item (O2M) is deleted\u2026 "),e("ul",null,[e("li",null,"Nullify the parent M2O field (default)"),e("li",null,"Set the parent M2O field to its default value"),e("li",null,"Delete the parent collection\u2019s item (cascade)"),e("li",null,"Prevent the deletion")])])],-1),U=e("h2",{id:"one-to-many-(o2m)"},[t("One-to-Many (O2M) "),e("a",{class:"header-anchor",href:"#one-to-many-(o2m)"},"#")],-1),L=t("The One-to-Many relationship is the "),E=e("strong",null,"exact same relationship",-1),z=t(" as a Many-to-One (above), just seen from the opposite collection\u2019s perspective. The O2M is stored as an "),H=t("Alias"),V=t(" field on its parent Collection that dynamically lists all items connected via the opposite Many-to-One. So, while the M2O will show a single country for the parent city, the O2M shows all cities for the parent country."),G=e("p",null,"Below is an example of a O2M relationship:",-1),Q=e("pre",null,[e("code",{class:""},`countries (the "One" Collection)
-- id (Primary Key)
-- name
-- *cities* (the O2M alias field that lists references from "cities.country")
-
-cities (the "Many" Collection)
-- id (Primary Key)
-- name
-- country (the M2O field that stores the country key)
-`)],-1),X=e("h3",{id:"setup-2"},[t("Setup "),e("a",{class:"header-anchor",href:"#setup-2"},"#")],-1),Z=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/O2M-20220216A.webp",alt:"O2M"})],-1),$=e("p",null,"The parent collection and field are already known (it\u2019s the field you\u2019re currently creating), so configuring those are disabled. All you need to configure is the related collection and its M2O field.",-1),ee=e("p",null,[t("You can select or enter an "),e("strong",null,"existing"),t(" Related Collection (highlights green) or create a "),e("strong",null,"new"),t(" one by entering a unique collection name. Next, you can select an existing field (highlights green) or create a new one by entering a field name unique to its collection.")],-1),te=e("p",null,"The related field will store the value of this collection\u2019s primary key field, so both must have the same type. For this reason, when selecting existing fields, options will be disabled if they don\u2019t have a matching type.",-1),ne=e("p",null,[t("You also have the option to create a "),e("strong",null,"Corresponding Field"),t(" during this process. This allows you to more easily create the M2O field (see above) that pairs with this O2M.")],-1),oe=e("p",null,[t("The optional "),e("strong",null,"Sort Field"),t(" can be used to enable manual reordering of items within this O2M field. This is configured by selecting an existing numeric type field (highlights green) from the Related Collection, or entering the name of a new field to be created.")],-1),le=e("p",null,[e("strong",null,"Relational Triggers"),t(" allow for control over what happens when a relationship is broken. There are two options:")],-1),ie=e("ul",null,[e("li",null,[e("strong",null,"On Deselect of [Related Collection]"),t(" \u2014 When the value of the M2O is deselected\u2026 "),e("ul",null,[e("li",null,"Nullify the M2O field value (default)"),e("li",null,"Delete the M2O item (cascade)")])]),e("li",null,[e("strong",null,"On Delete of [Parent Collection Item]"),t(" \u2014 When this O2M item is deleted\u2026 "),e("ul",null,[e("li",null,"Nullify the related M2O field (default)"),e("li",null,"Set the related M2O field to its default value"),e("li",null,"Delete the related collection\u2019s item (cascade)"),e("li",null,"Prevent the deletion")])])],-1),se=e("h2",{id:"translations-(o2m)"},[t("Translations (O2M) "),e("a",{class:"header-anchor",href:"#translations-(o2m)"},"#")],-1),ae=t("The Translations relationship is just a special version of the standard O2M. Just like the O2M, it creates an "),re=t("Alias"),ce=t(" field that is used to list all related items (the translations). Translations themselves are stored in a separate collection, which is then further related to a "),de=e("em",null,"third",-1),he=t(" collection that stores all languages."),ue=e("h3",{id:"setup-3"},[t("Setup "),e("a",{class:"header-anchor",href:"#setup-3"},"#")],-1),fe=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/translations-wizard-20220216A.webp",alt:"Translations"})],-1),pe=e("p",null,"The easiest way to add translations is to use the wizard, which only asks for the Translation field name. All required fields and relationships will then be automatically created and configured.",-1),me=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/translations-relations-20220216A.webp",alt:"Translations"})],-1),_e=e("p",null,[t("If you choose to switch to "),e("strong",null,"manual setup"),t(", you will be presented with a similar relationship setup to O2M or M2M. The parent collection and primary key are known, so those fields are disabled.")],-1),ye=e("p",null,"Next, we configure the Translation Collection. Set to \u201CAuto Fill\u201D by default, this will enter intelligent naming based on related names, and disables all fields. Disabling Auto Fill will enable all fields, allowing you to name the collection that holds the translations, as well as the two fields (each a M2O) that store foreign keys to the parent item and language.",-1),ge=e("p",null,[t("Lastly, you would select/create the Languages collection, which stores the languages available for this translations field. It is common practice to reuse a single languages collection throughout your project, unless translation fields need to support different language sets. For the language "),e("code",{class:""},"code"),t(" we recommend using the IETF language tag (eg: "),e("code",{class:""},"en-US"),t(") which combines the ISO 639-1 and ISO 3166\u20111 standards, but anything can be used (eg: "),e("code",{class:""},"english"),t(").")],-1),we=e("h2",{id:"many-to-many-(m2m)"},[t("Many-to-Many (M2M) "),e("a",{class:"header-anchor",href:"#many-to-many-(m2m)"},"#")],-1),Me=t("The Many-to-Many relationship is actually just "),be=e("strong",null,"two relationships combined",-1),ve=t(" (O2M+M2O) that join together three different collections. The M2M is stored as an "),Oe=t("Alias"),ke=t(" field on its parent Collection that dynamically lists all items connected via a "),Te=t("junction collection"),xe=t(". For example, a "),Ce=e("em",null,"recipe",-1),Ae=t(" can have many "),je=e("em",null,"ingredients",-1),Ie=t(", and "),Pe=e("em",null,"ingredients",-1),De=t(" can be in many "),Se=e("em",null,"recipes",-1),Re=t("."),Fe=e("p",null,"Below is an example of a M2M relationship:",-1),Ke=e("pre",null,[e("code",{class:""},`recipes (Collection)
-- id (Primary Key)
-- name
-- *ingredients* (M2M/O2M alias field that lists references from "recipe_ingredients")
-
-ingredients (Collection)
-- id (Primary Key)
-- name
-- *recipes* (M2M/O2M alias field that lists references from "recipe_ingredients")
-
-recipe_ingredients (Junction Collection)
-- id (Primary Key)
-- recipe (stores the recipe key)
-- ingredient (stores ingredient key)
-- quantity (other optional data on the connection)
-`)],-1),Ne=e("p",null,[t("Notice that the example above also has a "),e("code",{class:""},"quantity"),t(" field on the Junction Collection, which tracks how much of each ingredient is needed for the recipe. You can add any other "),e("em",null,"contextual"),t(" fields to the junction, and they will also be included at the top of the App\u2019s relational Item Page form.")],-1),qe=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Self-Referencing"),e("p",null,[t("You can also have a M2M relationship that connects items within the "),e("em",null,"same"),t(" collection. An example of this is \u201CRelated Articles\u201D, where an article might relate to many other articles.")])],-1),Be=e("h3",{id:"setup-4"},[t("Setup "),e("a",{class:"header-anchor",href:"#setup-4"},"#")],-1),Je=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/M2M-20220216A.webp",alt:"M2M"})],-1),We=e("p",null,"The parent collection and field are already known (it\u2019s the field you\u2019re currently creating), so configuring those are disabled.",-1),Ye=e("p",null,[t("Next you should configure the Related Collection. If you select or enter an "),e("strong",null,"existing"),t(" Related Collection (highlights green) then the primary key field is known and automatically selected. If you enter the name of a "),e("strong",null,"new"),t(" Related Collection (doesn\u2019t already exist), you will also be prompted to enter the name of its primary key field, which will default to an auto-increment integer type.")],-1),Ue=t("Lastly, we configure the "),Le=t("Junction Collection"),Ee=t(", which sits between the two related collections, storing all links between the two. You can leave this set to \u201CAuto-Fill\u201D, which sets intelligent naming defaults, or disable it to select existing options or enter custom names."),ze=e("p",null,[t("You also have the option to create a "),e("strong",null,"Corresponding Field"),t(" during this process. This allows you to more easily create the reverse M2M field on the "),e("em",null,"related"),t(" collection.")],-1),He=e("p",null,[t("The optional "),e("strong",null,"Sort Field"),t(" can be used to enable manual reordering of items within this O2M field. This is configured by selecting an existing numeric type field (highlights green) from the Junction Collection, or entering the name of a new field to be created.")],-1),Ve=e("p",null,[e("strong",null,"Relational Triggers"),t(" allow for control over what happens when a relationship is broken. There are three options:")],-1),Ge=e("ul",null,[e("li",null,[e("strong",null,"On Deselect of [Junction Collection]"),t(" \u2014 When the value of this M2M is deselected\u2026 "),e("ul",null,[e("li",null,"Nullify the junction field (default)"),e("li",null,"Delete the junction item (cascade)")])]),e("li",null,[e("strong",null,"On Delete of [Parent Collection Item]"),t(" \u2014 When this M2M item is deleted\u2026 "),e("ul",null,[e("li",null,"Nullify the junction field (default)"),e("li",null,"Set the junction field to its default value"),e("li",null,"Delete the related junction item (cascade)"),e("li",null,"Prevent the deletion")])]),e("li",null,[e("strong",null,"On Delete of [Related Collection Item]"),t(" \u2014 When the related M2M item is deleted\u2026 "),e("ul",null,[e("li",null,"Nullify the junction field (default)"),e("li",null,"Set the junction field to its default value"),e("li",null,"Delete the related junction item (cascade)"),e("li",null,"Prevent the deletion")])])],-1),Qe=e("h2",{id:"many-to-any-(m2a)"},[t("Many-to-Any (M2A) "),e("a",{class:"header-anchor",href:"#many-to-any-(m2a)"},"#")],-1),Xe=t("Sometimes called a \u201Cmatrix field\u201D or \u201Creplicator\u201D. Like the M2M, the M2A is stored as an "),Ze=t("Alias"),$e=t(" field on its parent Collection that dynamically lists all items connected via a "),et=t("junction collection"),tt=t(". However, there is one key difference: one side of the junction also stores a "),nt=e("strong",null,"collection key",-1),ot=t(". This combination of collection name and primary key means that you can effectively store a reference to "),lt=e("em",null,"any",-1),it=t(" item in the database. You can then artificially limit which collections are valid through a related collections \u201Callow list\u201D."),st=e("p",null,[t("A common example of a M2A is a \u201CPage Builder\u201D, which has a "),e("em",null,"Pages"),t(" collection that includes any number of different \u201Csection\u201D Collections, such as: \u201CHeading\u201D, \u201CText\u201D, and \u201CImage\u201D. In this example the junction table will link different sections (from different collections) with a page, creating relational layouts.")],-1),at=e("p",null,"Below is an example of a M2A relationship:",-1),rt=e("pre",null,[e("code",{class:""},`pages (Collection)
-- id
-- name
-- *sections* (O2M/M2A alias field that lists references from "page_sections")
-
-page_sections (Junction Collection)
-- id
-- pages_id (stores the primary key of the parent page)
-- collection (stores name of the related collection, for example "headings", "text", or "images")
-- item (stores the primary key of the related item)
-
-headings (Collection)
-- id
-- title
-
-text (Collection)
-- id
-- text
-
-images (Collection)
-- id
-- file
-`)],-1),ct=e("h3",{id:"setup-5"},[t("Setup "),e("a",{class:"header-anchor",href:"#setup-5"},"#")],-1),dt=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/configuration/data-model/relationships/M2A-20220216A.webp",alt:"M2A"})],-1),ht=e("p",null,"The parent collection and field are already known (it\u2019s the field you\u2019re currently creating), so configuring those are disabled.",-1),ut=t("Next, we configure the "),ft=t("Junction Collection"),pt=t(", which sits between the related collections, storing all links between them. You can leave this set to \u201CAuto-Fill\u201D, which sets intelligent naming defaults, or disable it to select existing options or enter custom names."),mt=e("p",null,[t("Lastly, you should select any desired Related Collections. Unlike other relationships, you can\u2019t "),e("em",null,"create"),t(" these related collections here, so ensure all related collections you need are created beforehand.")],-1),_t=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Auto-generating"),e("p",null,"If you enter a collection/field name that doesn\u2019t exist yet, Directus will auto-generate these collections/fields once you save the changes on the new M2A field.")],-1),yt=e("p",null,[t("The optional "),e("strong",null,"Sort Field"),t(" can be used to enable manual reordering of items within this M2A field. This is configured by selecting an existing numeric type field (highlights green) from the Junction Collection, or entering the name of a new field to be created.")],-1),gt=e("p",null,[e("strong",null,"Relational Triggers"),t(" allow for control over what happens when a relationship is broken. There are three options:")],-1),wt=e("ul",null,[e("li",null,[e("strong",null,"On Delete of [Parent Collection Item]"),t(" \u2014 When a M2A item is deleted\u2026 "),e("ul",null,[e("li",null,"Nullify the junction field (default)"),e("li",null,"Set the junction field to its default value"),e("li",null,"Delete the related junction item (cascade)"),e("li",null,"Prevent the deletion")])]),e("li",null,[e("strong",null,"On Deselect of [Junction Collection]"),t(" \u2014 When the value of this M2A is deselected\u2026 "),e("ul",null,[e("li",null,"Nullify the junction field (default)"),e("li",null,"Delete the junction item (cascade)")])])],-1),Mt=e("h2",{id:"one-to-one-(o2o)"},[t("One-to-One (O2O) "),e("a",{class:"header-anchor",href:"#one-to-one-(o2o)"},"#")],-1),bt=t("Directus does not include a dedicated One-to-One (O2O) relationship type or interface. However, O2O is essentially the same as a M2O (storing a foreign key). The only difference is that a O2O enforces the cardinality. In other words, selecting a relational item in a O2O means that item can not be selected elsewhere (it can only be used once). This functionality can be added by checking and constraining uniqueness via a "),vt=t("custom event hook"),Ot=t(" or "),kt=t("custom interface"),Tt=t("."),xt=e("p",null,[t("An example of this is a "),e("em",null,"person"),t(" only has one unique set of "),e("em",null,"fingerprints"),t(", and those "),e("em",null,"fingerprints"),t(" only belong to one "),e("em",null,"person"),t(".")],-1),Ct={title:"Relationships",modularExtension:!1},At={name:"relationships",setup(jt,{expose:a}){return a({frontmatter:{title:"Relationships",modularExtension:!1}}),(It,Pt)=>{const o=i("router-link"),r=i("docswrapper");return c(),d(r,{frontmatter:Ct},{default:n(()=>[e("div",h,[u,f,p,m,_,e("p",null,[y,l(o,{to:"/docs/getting-started/glossary/#items"},{default:n(()=>[g]),_:1}),w,l(o,{to:"/docs/getting-started/glossary/#primary-key-pk"},{default:n(()=>[M]),_:1}),b,l(o,{to:"/docs/getting-started/glossary/#collections"},{default:n(()=>[v]),_:1}),O,l(o,{to:"/docs/getting-started/glossary/#fields"},{default:n(()=>[k]),_:1}),T,x,C]),A,j,I,P,D,S,R,F,K,N,q,B,J,W,Y,U,e("p",null,[L,E,z,l(o,{to:"/docs/getting-started/glossary/#alias"},{default:n(()=>[H]),_:1}),V]),G,Q,X,Z,$,ee,te,ne,oe,le,ie,se,e("p",null,[ae,l(o,{to:"/docs/getting-started/glossary/#alias"},{default:n(()=>[re]),_:1}),ce,de,he]),ue,fe,pe,me,_e,ye,ge,we,e("p",null,[Me,be,ve,l(o,{to:"/docs/getting-started/glossary/#alias"},{default:n(()=>[Oe]),_:1}),ke,l(o,{to:"/docs/getting-started/glossary/#junction-collections"},{default:n(()=>[Te]),_:1}),xe,Ce,Ae,je,Ie,Pe,De,Se,Re]),Fe,Ke,Ne,qe,Be,Je,We,Ye,e("p",null,[Ue,l(o,{to:"/docs/getting-started/glossary/#junction-collections"},{default:n(()=>[Le]),_:1}),Ee]),ze,He,Ve,Ge,Qe,e("p",null,[Xe,l(o,{to:"/docs/getting-started/glossary/#alias"},{default:n(()=>[Ze]),_:1}),$e,l(o,{to:"/docs/getting-started/glossary/#junction-collections"},{default:n(()=>[et]),_:1}),tt,nt,ot,lt,it]),st,at,rt,ct,dt,ht,e("p",null,[ut,l(o,{to:"/docs/getting-started/glossary/#junction-collections"},{default:n(()=>[ft]),_:1}),pt]),mt,_t,yt,gt,wt,Mt,e("p",null,[bt,l(o,{to:"/docs/extensions/hooks/"},{default:n(()=>[vt]),_:1}),Ot,l(o,{to:"/docs/extensions/interfaces/"},{default:n(()=>[kt]),_:1}),Tt]),xt])]),_:1})}}};typeof s=="function"&&s(At);export{At as default,Ct as frontmatter};