@directus/app 9.22.0 → 9.22.2

package/dist/assets/query-a77a683c.js

@@ -0,0 +1,166 @@
+import{a,o as c,e as u,y as l,u as s,q as n,z as h}from"./runtime-core.esm-bundler-753bcc58.js";const r={class:"markdown-body"},p=s("blockquote",null,[s("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.")],-1),d=s("ul",null,[s("li",null,[s("a",{href:"#fields"},"Fields")]),s("li",null,[s("a",{href:"#filter"},"Filter")]),s("li",null,[s("a",{href:"#search"},"Search")]),s("li",null,[s("a",{href:"#sort"},"Sort")]),s("li",null,[s("a",{href:"#limit"},"Limit")]),s("li",null,[s("a",{href:"#offset"},"Offset"),n(" / "),s("a",{href:"#page"},"Page")]),s("li",null,[s("a",{href:"#aggregation-grouping"},"Aggregation & Grouping")]),s("li",null,[s("a",{href:"#deep"},"Deep")]),s("li",null,[s("a",{href:"#aliases"},"Aliases")]),s("li",null,[s("a",{href:"#export"},"Export")]),s("li",null,[s("a",{href:"#functions"},"Functions")]),s("li",null,[s("a",{href:"#metadata"},"Metadata"),s("ul",null,[s("li",null,[s("a",{href:"#total-count"},"Total Count")]),s("li",null,[s("a",{href:"#filter-count"},"Filter Count")])])])],-1),_=s("hr",null,null,-1),f=s("h2",{id:"fields",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#fields"},"#"),n(" Fields")],-1),m=s("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),j=s("h3",{id:"examples",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples"},"#"),n(" Examples")],-1),g=s("p",null,[n("Get all top-level fields"),s("br"),s("code",null,"*")],-1),b=s("p",null,[n("Get all top-level fields and all second-level relational fields"),s("br"),s("code",null,"*.*")],-1),y=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Performance & Size"),s("p",null,[n("While the fields wildcard is very useful for debugging purposes, we recommend only requesting "),s("em",null,"specific"),n(" fields for production use. By only requesting the fields you really need, you can speed up the request, and reduce the overall output size.")])],-1),x=s("p",null,[n("Get all top-level fields and second-level relational fields within images"),s("br"),s("code",null,"*,images.*")],-1),v=s("p",null,[n("Get only the first_name and last_name fields"),s("br"),s("code",null,"first_name,last_name")],-1),w=s("p",null,[n("Get all top-level and second-level relational fields, and third-level fields within images.thumbnails"),s("br"),s("code",null,"*.*,images.thumbnails.*")],-1),q=s("h3",{id:"many-to-any-(union-types)",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#many-to-any-(union-types)"},"#"),n(" Many-To-Any (Union Types)")],-1),k=s("p",null,[n("Seeing that Many-to-Any (M2A) fields have nested data from multiple collections, it’s 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:"),s("br"),s("code",null,"?fields=<m2a-field>:<collection-scope>.<field>"),n(".")],-1),G=s("p",null,[n("Lets say we have a collection "),s("code",null,"pages"),n(" with a many-to-any field called "),s("code",null,"sections"),n(" that points to "),s("code",null,"headings"),n(", "),s("code",null,"paragraphs"),n(", and "),s("code",null,"videos"),n(". We only want to fetch "),s("code",null,"title"),n(" and "),s("code",null,"level"),n(" from "),s("code",null,"headings"),n(", "),s("code",null,"body"),n(" from "),s("code",null,"paragraphs"),n(" and "),s("code",null,"source"),n(" from "),s("code",null,"videos"),n(". We can achieve that by using:")],-1),A=s("pre",null,[s("code",null,`sections.item:headings.title
+sections.item:headings.level
+sections.item:paragraphs.body
+sections.item:videos.source
+`)],-1),E=s("p",null,"In GraphQL, this can be achieved using Union Types.",-1),T=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),n(" REST API")],-1),S=s("pre",null,[s("code",null,`?fields=title,body,featured_image.*
+
+// or
+
+?fields[]=title
+&fields[]=body
+&fields[]=featured_image.*
+`)],-1),R=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),n(" GraphQL")],-1),L=s("p",null,[s("em",null,"Natively supported in GraphQL")],-1),I=s("hr",null,null,-1),P=s("h2",{id:"filter",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#filter"},"#"),n(" Filter")],-1),Q=s("h3",{id:"examples-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-1"},"#"),n(" Examples")],-1),F=s("p",null,[n("Retrieve all items where "),s("code",null,"first_name"),n(" equals “Rijk”")],-1),D=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"first_name"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"_eq"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Rijk"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),N=s("p",null,"Retrieve all items in one of the following categories: “vegetables”, “fruit”",-1),C=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"categories"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"_in"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"vegetables"'),s("span",{class:"hljs-punctuation"},","),n(),s("span",{class:"hljs-string"},'"fruit"'),s("span",{class:"hljs-punctuation"},"]"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),B=s("p",null,"Retrieve all items that are published between two dates",-1),M=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"date_published"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"_between"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"2021-01-24"'),s("span",{class:"hljs-punctuation"},","),n(),s("span",{class:"hljs-string"},'"2021-02-23"'),s("span",{class:"hljs-punctuation"},"]"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),z=s("p",null,"Retrieve all items where the author’s “vip” flag is true",-1),O=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"author"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"vip"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+			`),s("span",{class:"hljs-attr"},'"_eq"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"true")]),n(`
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),U=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Nested Filters"),s("p",null,[n("The above example will filter the "),s("em",null,"top level"),n(" items based on a condition "),s("em",null,"in"),n(" the related item. If you’re looking to filter the related items themselves, take a look at "),s("a",{href:"#deep"},[n("the "),s("code",null,"deep"),n(" parameter")]),n("!")])],-1),W=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),n(" REST API")],-1),V=s("pre",null,[s("code",null,`?filter[first_name][_eq]=Rijk
+
+// or
+
+?filter={ "first_name": { "_eq": "Rijk" }}
+`)],-1),J=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),n(" GraphQL")],-1),Y=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	users`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"filter"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"first_name"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"_eq"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Rijk"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),H=s("hr",null,null,-1),K=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Filtering M2A fields"),s("p",null,[n("Because attribute names in GraphQL cannot contain the "),s("code",null,":"),n(" character, you will need to replace it with a double underscore. For example, instead of using "),s("code",null,"sections.item:heading"),n(" in your filter, you will need to use "),s("code",null,"sections.item__heading"),n(" (see the full example below).")]),s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+    articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"filter"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+        `),s("span",{class:"hljs-symbol"},"sections"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+            `),s("span",{class:"hljs-symbol"},"item__headings"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n("  "),s("span",{class:"hljs-comment"},"# Instead of: item:headings"),n(`
+                `),s("span",{class:"hljs-symbol"},"title"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+                    `),s("span",{class:"hljs-symbol"},"_eq"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Section 1"'),n(`
+                `),s("span",{class:"hljs-punctuation"},"}"),n(`
+            `),s("span",{class:"hljs-punctuation"},"}"),n(`
+        `),s("span",{class:"hljs-punctuation"},"}"),n(`
+    `),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+        id
+    `),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])])],-1),X=s("h2",{id:"search",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#search"},"#"),n(" Search")],-1),Z=s("p",null,"The search parameter allows you to perform a search on all string and text type fields within a collection. It’s an easy way to search for an item without creating complex field filters – though it is far less optimized. It only searches the root item’s fields, related item fields are not included.",-1),$=s("h3",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),n(" Example")],-1),ss=s("p",null,[n("Find all items that mention Directus"),s("br"),s("code",null,"Directus")],-1),ns=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),n(" REST API")],-1),ts=s("pre",null,[s("code",null,`?search=Directus
+`)],-1),as=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),n(" GraphQL")],-1),ls=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"search"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Directus"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),es=s("hr",null,null,-1),os=s("h2",{id:"sort",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#sort"},"#"),n(" Sort")],-1),is=s("p",null,[n("What field(s) to sort by. Sorting defaults to ascending, but a minus sign ("),s("code",null,"-"),n(") can be used to reverse this to descending order. Fields are prioritized by the order in the parameter. The dot-notation has to be used when sorting with values of nested fields.")],-1),cs=s("h3",{id:"examples-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-2"},"#"),n(" Examples")],-1),us=s("p",null,[n("Sort by creation date descending"),s("br"),s("code",null,"-date_created")],-1),hs=s("p",null,[n("Sort by a “sort” field, followed by publish date descending"),s("br"),s("code",null,"sort, -publish_date")],-1),rs=s("p",null,[n("Sort by a “sort” field, followed by a nested author’s name"),s("br"),s("code",null,"sort, -author.name")],-1),ps=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),n(" REST API")],-1),ds=s("pre",null,[s("code",null,`?sort=sort,-date_created,author.name
+
+// or
+
+?sort[]=sort
+&sort[]=-date_created
+&sort[]=-author.name
+`)],-1),_s=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),n(" GraphQL")],-1),fs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"sort"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"sort"'),n(", "),s("span",{class:"hljs-string"},'"-date_created"'),n(", "),s("span",{class:"hljs-string"},'"author.name"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ms=s("hr",null,null,-1),js=s("h2",{id:"limit",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#limit"},"#"),n(" Limit")],-1),gs=s("p",null,[n("Set the maximum number of items that will be returned. The default limit is set to "),s("code",null,"100"),n(".")],-1),bs=s("h3",{id:"examples-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-3"},"#"),n(" Examples")],-1),ys=s("p",null,[n("Get the first 200 items"),s("br"),s("code",null,"200")],-1),xs=s("p",null,[n("Get all items"),s("br"),s("code",null,"-1")],-1),vs=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"All Items"),s("p",null,"Depending on the size of your collection, fetching unlimited data may result in degraded performance or timeouts, use with caution.")],-1),ws=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),n(" REST API")],-1),qs=s("pre",null,[s("code",null,`?limit=200
+`)],-1),ks=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),n(" GraphQL")],-1),Gs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"limit"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"200"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),As=s("hr",null,null,-1),Es=s("h2",{id:"offset",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#offset"},"#"),n(" Offset")],-1),Ts=s("p",null,[n("Skip the first "),s("code",null,"n"),n(" items in the response. Can be used for pagination.")],-1),Ss=s("h3",{id:"examples-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-4"},"#"),n(" Examples")],-1),Rs=s("p",null,[n("Get items 101—200"),s("br"),s("code",null,"100")],-1),Ls=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),n(" REST API")],-1),Is=s("pre",null,[s("code",null,`?offset=100
+`)],-1),Ps=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),n(" GraphQL")],-1),Qs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"offset"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"100"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Fs=s("hr",null,null,-1),Ds=s("h2",{id:"page",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#page"},"#"),n(" Page")],-1),Ns=s("p",null,[n("An alternative to "),s("code",null,"offset"),n(". Page is a way to set "),s("code",null,"offset"),n(" under the hood by calculating "),s("code",null,"limit * page"),n(". Page is 1-indexed.")],-1),Cs=s("h3",{id:"examples-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-5"},"#"),n(" Examples")],-1),Bs=s("p",null,[n("Get items 1-100"),s("br"),s("code",null,"1")],-1),Ms=s("p",null,[n("Get items 101-200"),s("br"),s("code",null,"2")],-1),zs=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),n(" REST API")],-1),Os=s("pre",null,[s("code",null,`?page=2
+`)],-1),Us=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),n(" GraphQL")],-1),Ws=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"page"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"2"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Vs=s("hr",null,null,-1),Js=s("h2",{id:"aggregation-%26-grouping",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#aggregation-%26-grouping"},"#"),n(" Aggregation & Grouping")],-1),Ys=s("p",null,"Aggregate functions allow you to perform calculations on a set of values, returning a single result.",-1),Hs=s("p",null,"The following aggregation functions are available in Directus:",-1),Ks=s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"Name"),s("th",null,"Description")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("code",null,"count")]),s("td",null,"Counts how many items there are")]),s("tr",null,[s("td",null,[s("code",null,"countDistinct")]),s("td",null,"Counts how many unique items there are")]),s("tr",null,[s("td",null,[s("code",null,"sum")]),s("td",null,"Adds together the values in the given field")]),s("tr",null,[s("td",null,[s("code",null,"sumDistinct")]),s("td",null,"Adds together the unique values in the given field")]),s("tr",null,[s("td",null,[s("code",null,"avg")]),s("td",null,"Get the average value of the given field")]),s("tr",null,[s("td",null,[s("code",null,"avgDistinct")]),s("td",null,"Get the average value of the unique values in the given field")]),s("tr",null,[s("td",null,[s("code",null,"min")]),s("td",null,"Return the lowest value in the field")]),s("tr",null,[s("td",null,[s("code",null,"max")]),s("td",null,"Return the highest value in the field")]),s("tr",null,[s("td",null,[s("code",null,"countAll")]),s("td",null,[n("Equivalent to "),s("code",null,"?aggregate[count]=*"),n(" (GraphQL only)")])])])],-1),Xs=s("h3",{id:"grouping",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#grouping"},"#"),n(" Grouping")],-1),Zs=s("p",null,[n("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 "),s("em",null,"“Average rating per month”"),n(" or "),s("em",null,"“Total sales of items in the jeans category”"),n(".")],-1),$s=s("p",null,[n("The "),s("code",null,"groupBy"),n(" query allows for grouping on multiple fields simultaneously. Combined with the "),s("a",{href:"#functions"},"Functions"),n(", this allows for aggregate reporting per year-month-date.")],-1),sn=s("h3",{id:"rest-api-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-7"},"#"),n(" REST API")],-1),nn=s("pre",null,[s("code",null,`?aggregate[avg]=cost
+&groupBy[]=author
+&groupBy[]=year(publish_date)
+`)],-1),tn=s("h3",{id:"graphql-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-7"},"#"),n(" GraphQL")],-1),an=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles_aggregated`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"groupBy"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"author"'),n(", "),s("span",{class:"hljs-string"},'"year(publish_date)"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		group
+		sum `),s("span",{class:"hljs-punctuation"},"{"),n(`
+			revenue
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ln=s("hr",null,null,-1),en=s("h2",{id:"deep",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#deep"},"#"),n(" Deep")],-1),on=s("p",null,"Deep allows you to set any of the other query parameters on a nested relational dataset.",-1),cn=s("h3",{id:"examples-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#examples-6"},"#"),n(" Examples")],-1),un=s("p",null,"Limit the nested related articles to 3",-1),hn=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"related_articles"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"_limit"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"3"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),rn=s("p",null,"Only get 3 related articles, with only the top rated comment nested",-1),pn=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"related_articles"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"_limit"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"3"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"comments"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+			`),s("span",{class:"hljs-attr"},'"_sort"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"rating"'),s("span",{class:"hljs-punctuation"},","),n(`
+			`),s("span",{class:"hljs-attr"},'"_limit"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"1"),n(`
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),dn=s("h3",{id:"rest-api-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-8"},"#"),n(" REST API")],-1),_n=s("pre",null,[s("code",null,`?deep[translations][_filter][languages_code][_eq]=en-US
+
+// or
+
+?deep={ "translations": { "_filter": { "languages_code": { "_eq": "en-US" }}}}
+`)],-1),fn=s("h3",{id:"graphql-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-8"},"#"),n(" GraphQL")],-1),mn=s("p",null,[s("em",null,"Natively supported in GraphQL:")],-1),jn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	members `),s("span",{class:"hljs-punctuation"},"{"),n(`
+		favorite_games`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"filter"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"name"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"_eq"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"Mariokart 8"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+			id
+			featured_image `),s("span",{class:"hljs-punctuation"},"{"),n(`
+				filename_disk
+			`),s("span",{class:"hljs-punctuation"},"}"),n(`
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),gn=s("hr",null,null,-1),bn=s("h2",{id:"aliases",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#aliases"},"#"),n(" Aliases")],-1),yn=s("p",null,"Aliases allow you rename fields on the fly, and request the same nested data set multiple times using different filters.",-1),xn=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Nested fields"),s("p",null,[n("It is only possible to alias same level fields."),s("br"),n(" Alias for nested fields, f.e. "),s("code",null,"field.nested"),n(", will not work.")])],-1),vn=s("h3",{id:"rest-api-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-9"},"#"),n(" REST API")],-1),wn=s("pre",null,[s("code",null,`?alias[all_translations]=translations
+&alias[dutch_translations]=translations
+&deep[dutch_translations][_filter][code][_eq]=nl-NL
+`)],-1),qn=s("h3",{id:"graphql-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-9"},"#"),n(" GraphQL")],-1),kn=s("p",null,[s("em",null,"Natively supported in GraphQL:")],-1),Gn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles `),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-symbol"},"dutch_translations"),s("span",{class:"hljs-punctuation"},":"),n(" translations"),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"filter"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"code"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"_eq"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"nl-NL"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+			id
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+
+		`),s("span",{class:"hljs-symbol"},"all_translations"),s("span",{class:"hljs-punctuation"},":"),n(" translations "),s("span",{class:"hljs-punctuation"},"{"),n(`
+			id
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),An=s("hr",null,null,-1),En=s("h2",{id:"export",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#export"},"#"),n(" Export")],-1),Tn=s("p",null,"Save the current API response to a file.",-1),Sn=s("p",null,[n("Saves the API response to a file. Accepts one of "),s("code",null,"json"),n(", "),s("code",null,"csv"),n(", "),s("code",null,"xml"),n(".")],-1),Rn=s("h3",{id:"rest-api-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-10"},"#"),n(" REST API")],-1),Ln=s("pre",null,[s("code",null,`?export=json
+?export=csv
+?export=xml
+`)],-1),In=s("h3",{id:"graphql-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-10"},"#"),n(" GraphQL")],-1),Pn=s("p",null,"n/a",-1),Qn=s("hr",null,null,-1),Fn=s("h2",{id:"functions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#functions"},"#"),n(" Functions")],-1),Dn=s("p",null,"Functions allow for “live” modification of values stored in a field. Functions can be used in any query parameter you’d normally supply a field key, including fields, aggregation, and filter.",-1),Nn=s("p",null,"Functions can be used by wrapping the field key in a JavaScript like syntax, for example:",-1),Cn=s("p",null,[s("code",null,"timestamp"),n(" -> "),s("code",null,"year(timestamp)")],-1),Bn=s("h3",{id:"datetime-functions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#datetime-functions"},"#"),n(" DateTime Functions")],-1),Mn=s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"Filter"),s("th",null,"Description")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("code",null,"year")]),s("td",null,"Extract the year from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"month")]),s("td",null,"Extract the month from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"week")]),s("td",null,"Extract the week from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"day")]),s("td",null,"Extract the day from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"weekday")]),s("td",null,"Extract the weekday from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"hour")]),s("td",null,"Extract the hour from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"minute")]),s("td",null,"Extract the minute from a datetime/date/timestamp field")]),s("tr",null,[s("td",null,[s("code",null,"second")]),s("td",null,"Extract the second from a datetime/date/timestamp field")])])],-1),zn=s("h3",{id:"array-functions",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#array-functions"},"#"),n(" Array Functions")],-1),On=s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"Filter"),s("th",null,"Description")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("code",null,"count")]),s("td",null,"Extract the number of items from a JSON array or relational field")])])],-1),Un=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"GraphQL"),s("p",null,[n("Names aren’t allowed to include any special characters in GraphQL, preventing the "),s("code",null,"()"),n(" syntax from being used.")]),s("p",null,[n("As an alternative, the above functions can be used by appending "),s("code",null,"_func"),n(" at the end of the field name, and using the function name as the nested field (see the example that follows).")])],-1),Wn=s("h3",{id:"rest-api-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-11"},"#"),n(" REST API")],-1),Vn=s("pre",null,[s("code",null,`?fields=id,title,weekday(date_published)
+&filter[year(date_published)][_eq]=2021
+`)],-1),Jn=s("h3",{id:"graphql-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-11"},"#"),n(" GraphQL")],-1),Yn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	articles`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"filter"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"date_published_func"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"year"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"_eq"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"2021"),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		id
+		title
+		date_published_func `),s("span",{class:"hljs-punctuation"},"{"),n(`
+			weekday
+		`),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Hn=s("hr",null,null,-1),Kn=s("h2",{id:"metadata",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#metadata"},"#"),n(" Metadata")],-1),Xn=s("p",null,[n("Metadata allows you to retrieve some additional information about the items in the collection you’re fetching. "),s("code",null,"*"),n(" can be used as a wildcard to retrieve all metadata.")],-1),Zn=s("h3",{id:"total-count",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#total-count"},"#"),n(" Total Count")],-1),$n=s("p",null,"Returns the total item count of the collection you’re querying.",-1),st=s("h3",{id:"filter-count",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#filter-count"},"#"),n(" Filter Count")],-1),nt=s("p",null,"Returns the item count of the collection you’re querying, taking the current filter/search parameters into account.",-1),tt=s("h3",{id:"rest-api-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-12"},"#"),n(" REST API")],-1),at=s("pre",null,[s("code",null,`?meta=total_count
+
+?meta=filter_count
+
+?meta=*
+`)],-1),lt=s("h3",{id:"graphql-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-12"},"#"),n(" GraphQL")],-1),et=s("p",null,"n/a",-1),ht="Global Query Parameters",rt=!1,pt="REST and GraphQL API documentation to run queries in Directus.",dt="9 min read",_t="page-reference",ft={__name:"query",setup(ot,{expose:e}){const t={title:"Global Query Parameters",modularExtension:!1,description:"REST and GraphQL API documentation to run queries in Directus.",readTime:"9 min read",pageClass:"page-reference"};return e({frontmatter:t}),(it,ct)=>{const o=a("router-link"),i=a("docs-wrapper");return c(),u(i,{frontmatter:t},{default:l(()=>[s("div",r,[p,d,_,f,m,j,g,b,y,x,v,w,q,k,G,A,E,T,S,R,L,I,P,s("p",null,[n("Used to search items in a collection that matches the filter’s conditions. The filter param follows "),h(o,{to:"/docs/reference/filter-rules"},{default:l(()=>[n("the Filter Rules spec")]),_:1}),n(", which includes additional information on logical operators (AND/OR), nested relational filtering, and dynamic variables.")]),Q,F,D,N,C,B,M,z,O,U,W,V,J,Y,H,K,X,Z,$,ss,ns,ts,as,ls,es,os,is,cs,us,hs,rs,ps,ds,_s,fs,ms,js,gs,bs,ys,xs,vs,ws,qs,ks,Gs,As,Es,Ts,Ss,Rs,Ls,Is,Ps,Qs,Fs,Ds,Ns,Cs,Bs,Ms,zs,Os,Us,Ws,Vs,Js,Ys,Hs,Ks,Xs,Zs,$s,sn,nn,tn,an,ln,en,on,cn,un,hn,rn,pn,dn,_n,fn,mn,jn,gn,bn,yn,xn,vn,wn,qn,kn,Gn,An,En,Tn,Sn,Rn,Ln,In,Pn,Qn,Fn,Dn,Nn,Cn,Bn,Mn,zn,On,Un,Wn,Vn,Jn,Yn,Hn,Kn,Xn,Zn,$n,st,nt,tt,at,lt,et])]),_:1})}}};export{ft as default,pt as description,rt as modularExtension,_t as pageClass,dt as readTime,ht as title};

package/dist/assets/quickstart-1a47c6b5.js

@@ -0,0 +1,26 @@
+import{a as i,o as c,e as d,y as s,u as t,q as e,z as o}from"./runtime-core.esm-bundler-753bcc58.js";const h={class:"markdown-body"},u=t("blockquote",null,[t("p",null,"If you’re 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:"requirements",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#requirements"},"#"),e(" Requirements")],-1),_=t("ul",null,[t("li",null,[t("a",{href:"https://docs.docker.com/get-docker/",target:"_blank",rel:"noopener noreferrer"},"Docker")]),t("li",null,[t("a",{href:"https://docs.docker.com/compose/install/",target:"_blank",rel:"noopener noreferrer"},"Docker Compose"),e(" (often included with newer Docker installations)")])],-1),m=t("h2",{id:"1.-installation",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#1.-installation"},"#"),e(" 1. Installation")],-1),g=t("p",null,[e("You can use the following configuration to get started using Docker Compose. Make sure to change all sensitive values like "),t("code",null,"KEY"),e(", "),t("code",null,"SECRET"),e(", "),t("code",null,"ADMIN_PASSWORD"),e(", "),t("em",null,"etc.")],-1),f=t("pre",null,[t("code",{class:"language-yaml"},[t("span",{class:"hljs-attr"},"version:"),e(),t("span",{class:"hljs-string"},"'3'"),e(`
+`),t("span",{class:"hljs-attr"},"services:"),e(`
+  `),t("span",{class:"hljs-attr"},"directus:"),e(`
+    `),t("span",{class:"hljs-attr"},"image:"),e(),t("span",{class:"hljs-string"},"directus/directus:latest"),e(`
+    `),t("span",{class:"hljs-attr"},"volumes:"),e(`
+      `),t("span",{class:"hljs-bullet"},"-"),e(),t("span",{class:"hljs-string"},"./uploads:/directus/uploads"),e(`
+      `),t("span",{class:"hljs-bullet"},"-"),e(),t("span",{class:"hljs-string"},"./database:/directus/database"),e(`
+    `),t("span",{class:"hljs-attr"},"environment:"),e(`
+      `),t("span",{class:"hljs-attr"},"KEY:"),e(),t("span",{class:"hljs-string"},"'255d861b-5ea1-5996-9aa3-922530ec40b1'"),e(`
+      `),t("span",{class:"hljs-attr"},"SECRET:"),e(),t("span",{class:"hljs-string"},"'6116487b-cda1-52c2-b5b5-c8022c45e263'"),e(`
+
+      `),t("span",{class:"hljs-attr"},"DB_CLIENT:"),e(),t("span",{class:"hljs-string"},"'sqlite3'"),e(`
+      `),t("span",{class:"hljs-attr"},"DB_FILENAME:"),e(),t("span",{class:"hljs-string"},"'./data.db'"),e(`
+
+      `),t("span",{class:"hljs-attr"},"ADMIN_EMAIL:"),e(),t("span",{class:"hljs-string"},"'admin@example.com'"),e(`
+      `),t("span",{class:"hljs-attr"},"ADMIN_PASSWORD:"),e(),t("span",{class:"hljs-string"},"'d1r3ctu5'"),e(`
+`)])],-1),b=t("p",null,[e("Save this in your project as a file named "),t("code",null,"docker-compose.yml"),e(" and run:")],-1),w=t("pre",null,[t("code",null,`docker-compose up -d
+`)],-1),k={class:"tip hint"},y=t("div",{class:"hint-title"},"More Info on Docker",-1),j=t("h2",{id:"2.-login-to-app",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#2.-login-to-app"},"#"),e(" 2. Login to App")],-1),v=t("p",null,"With the server running, you’re now able to login to your new Directus project and start using it.",-1),I=t("p",null,[e("Our start command stated that the server started at port "),t("code",null,"8055"),e(", which means we can navigate to "),t("code",null,"http://localhost:8055"),e(" to open Directus in the browser.")],-1),C=t("p",null,"Login using the admin credentials you configured during the installation in Step 1.",-1),D=t("h2",{id:"3.-create-a-collection",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#3.-create-a-collection"},"#"),e(" 3. Create a Collection")],-1),A=t("p",null,"Once logged in, you’re greeted with the option to create your first Collection:",-1),P=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),x=t("p",null,[e("Follow the prompts and create a Collection. For the sake of this demo, we’ll be calling ours "),t("code",null,"articles"),e(", but feel free to make it your own!")],-1),T={class:"tip hint"},q=t("div",{class:"hint-title"},"More Info on Collections",-1),E=t("h2",{id:"4.-create-a-field",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#4.-create-a-field"},"#"),e(" 4. Create a Field")],-1),S=t("p",null,[e("With the Collection created, it’s time to start adding some Fields. Click the "),t("strong",null,"“Create Field”"),e(" button, and select "),t("strong",null,"“Input”"),e(":")],-1),R=t("video",{autoplay:"",playsinline:"",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),M=t("p",null,[e("We’ll be calling our Field "),t("code",null,"title"),e(". While Directus offers a range of powerful field customization options, we’ll be sticking to the defaults for now. These defaults use the “String” datatype.")],-1),N={class:"tip hint"},F=t("div",{class:"hint-title"},"More Info on Fields",-1),L=t("h2",{id:"5.-create-an-item",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#5.-create-an-item"},"#"),e(" 5. Create an Item")],-1),W=t("p",null,[e("Now that we have a Collection with a Field configured, it’s 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),B=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),O=t("p",null,[e("Once you’re happy with your creation, click "),t("span",{mi:"",btn:""},"check"),e(" in the top-right to save your Item to the database.")],-1),G={class:"tip hint"},Q=t("div",{class:"hint-title"},"More Info on Items",-1),V=t("h2",{id:"6.-set-role%2Fpublic-permissions",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#6.-set-role%2Fpublic-permissions"},"#"),e(" 6. Set Role/Public Permissions")],-1),Y=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’ll 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),z=t("p",null,[e("Directus ships with a special "),t("strong",null,"“Public”"),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),K=t("p",null,[t("img",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220217A/permissions-20220217A.webp",alt:"Directus Permissions"})],-1),H={class:"tip hint"},J=t("div",{class:"hint-title"},"More Info on Roles & Permissions",-1),U=t("h2",{id:"7.-connect-to-the-api",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#7.-connect-to-the-api"},"#"),e(" 7. Connect to the API")],-1),X=t("code",null,"/items/",-1),Z=t("p",null,[e("Use 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(" to open "),t("code",null,"http://localhost:8055/items/articles"),e(".")],-1),$=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),tt=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),e(`
+	`),t("span",{class:"hljs-attr"},'"data"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-punctuation"},"["),e(`
+		`),t("span",{class:"hljs-punctuation"},"{"),e(`
+			`),t("span",{class:"hljs-attr"},'"id"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-number"},"1"),t("span",{class:"hljs-punctuation"},","),e(`
+			`),t("span",{class:"hljs-attr"},'"title"'),t("span",{class:"hljs-punctuation"},":"),e(),t("span",{class:"hljs-string"},'"Hello World!"'),e(`
+		`),t("span",{class:"hljs-punctuation"},"}"),e(`
+	`),t("span",{class:"hljs-punctuation"},"]"),e(`
+`),t("span",{class:"hljs-punctuation"},"}"),e(`
+`)])],-1),at="Quickstart Guide",it=!1,lt="If you're looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.",rt="5 min read",ct={__name:"quickstart",setup(et,{expose:l}){const a={title:"Quickstart Guide",modularExtension:!1,description:"If you're looking for the fastest way to get up-and-running with Directus, this guide will walk you through getting things installed, configured, and modeled.",readTime:"5 min read"};return l({frontmatter:a}),(st,nt)=>{const n=i("router-link"),r=i("docs-wrapper");return c(),d(r,{frontmatter:a},{default:s(()=>[t("div",h,[u,p,_,m,g,f,b,w,t("div",k,[y,t("p",null,[e("To learn more, visit the "),o(n,{to:"/docs/self-hosted/docker-guide"},{default:s(()=>[e("Docker Guide")]),_:1}),e(".")])]),j,v,I,C,D,A,P,x,t("div",T,[q,t("p",null,[e("To learn more, see our documentation "),o(n,{to:"/docs/app/content/collections"},{default:s(()=>[e("Collections")]),_:1}),e(".")])]),E,S,R,M,t("div",N,[F,t("p",null,[e("To learn more, see our documentation on "),o(n,{to:"/docs/getting-started/glossary#fields"},{default:s(()=>[e("Fields")]),_:1}),e(".")])]),L,W,B,O,t("div",G,[Q,t("p",null,[e("To learn more, see our documentation on "),o(n,{to:"/docs/app/content/items"},{default:s(()=>[e("Items")]),_:1}),e(".")])]),V,Y,z,K,t("div",H,[J,t("p",null,[e("Roles & Permissions are extremely powerful and can get pretty in-depth. To learn all about the nuances in setting these up, see "),o(n,{to:"/docs/reference/system/roles"},{default:s(()=>[e("Roles")]),_:1}),e(" & "),o(n,{to:"/docs/reference/system/permissions"},{default:s(()=>[e("Permissions")]),_:1}),e(".")])]),U,t("p",null,[e("Now that your project has some content in it, it’s 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’ll use "),o(n,{to:"/docs/reference/items"},{default:s(()=>[e("the "),X,e(" REST API endpoint")]),_:1}),e(" to retrieve the item we just created.")]),Z,$,tt])]),_:1})}}};export{ct as default,lt as description,it as modularExtension,rt as readTime,at as title};

package/dist/assets/quickstart-4eb8fd60.js

@@ -0,0 +1,9 @@
+import{a as i,o as r,e as d,y as o,u as e,q as t,z as l}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,[t("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 "),e("em",null,"hands-on introduction"),t(" to the App and API, and find more resources to deep-dive into.")])],-1),p=e("h2",{id:"1.-create-cloud-account-and-login",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#1.-create-cloud-account-and-login"},"#"),t(" 1. Create Cloud Account and Login")],-1),m=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-account-and-login-20220427.mp4",type:"video/mp4"})],-1),_=e("a",{href:"https://directus.cloud/login",target:"_blank",rel:"noopener noreferrer"},"Directus Cloud",-1),g=e("p",null,"Your Directus Cloud Account allows you to create and manage any number of Community and Standard Projects. We’ve made life easier by giving you the option to create and log in to your free Cloud Account automatically with GitHub. If you don’t have a GitHub account or prefer not to use this login method, email-and-password login is available as well.",-1),f=e("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),y=e("p",null,"Once your Team is created, it’s time to create your free Community Cloud Project!",-1),b={class:"tip hint"},w=e("div",{class:"hint-title"},"Learn More About Cloud",-1),v=e("h2",{id:"2.-create-and-access-project",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#2.-create-and-access-project"},"#"),t(" 2. Create and Access Project")],-1),C=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-and-access-project-20220427A.mp4",type:"video/mp4"})],-1),A=e("p",null,"To create a Community Project, follow the steps below:",-1),k=e("li",null,[t("Navigate to "),e("strong",null,"“Projects”"),t(" and click "),e("strong",null,"“Create Project”"),t(".")],-1),P=e("li",null,"Set the Project Name.",-1),j=e("li",null,"Select the Community tier.",-1),I=e("li",null,[t("Scroll to the bottom of the screen and choose the "),e("strong",null,"“Empty Project”"),t(" Starting Template."),e("br"),t(" Note: The "),e("strong",null,"“Demo Project”"),t(" adds in dummy data for in-depth feature demonstrations.")],-1),T=e("li",null,[t("Click "),e("strong",null,"“Create Project”"),t(".")],-1),x=e("p",null,[e("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’s time log in!")],-1),D={start:"7"},S=e("li",null,"Log in with your username and password from the email.",-1),F=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Check All Inbox Folders"),e("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 “Social” or “Promotions”.")],-1),M={class:"tip hint"},q=e("div",{class:"hint-title"},"Learn More About Cloud Projects",-1),L=e("h2",{id:"3.-create-a-collection",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#3.-create-a-collection"},"#"),t(" 3. Create a Collection")],-1),N=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-collection-20220427A.mp4",type:"video/mp4"})],-1),R=e("ol",null,[e("li",null,"Navigate into the Content Module."),e("li",null,[t("Click "),e("strong",null,"“Create Collection”"),t(" and a side menu will appear.")]),e("li",null,[t("Fill in a "),e("strong",null,"Name"),t("."),e("br"),t(" For the sake of this demo, we’ll call ours "),e("code",null,"articles"),t(", but feel free to make it your own!")]),e("li",null,[t("Leave the other options at default. Click "),e("span",{mi:"",btn:""},"arrow_forward"),t(" and the "),e("strong",null,"“Optional System Fields”"),t(" menu will open."),e("br"),t(" Keep the values in this menu at the default, toggled off, for now. You can adjust them later.")]),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" in the menu header.")])],-1),G={class:"tip hint"},O=e("div",{class:"hint-title"},"Learn More About Collections",-1),B=e("h2",{id:"4.-create-a-field",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#4.-create-a-field"},"#"),t(" 4. Create a Field")],-1),E=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-a-field-20220427A.mp4",type:"video/mp4"})],-1),H=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,[t("Settings Module > Data Model > "),e("code",null,"Collection-Name")]),t(".")]),e("li",null,[t("Click the "),e("strong",null,"“Create Field”"),t(" button and select the "),e("strong",null,"“Input”"),t(" Field type.")]),e("li",null,[t("Fill in a Field name under "),e("strong",null,"Key"),t(". We’ll be calling our Field "),e("code",null,"title"),t("."),e("br"),t(" Directus offers powerful Field customization options, but let’s stick to the defaults for now.")]),e("li",null,[t("Select "),e("strong",null,"“Save”"),t(".")])],-1),U={class:"tip hint"},z=e("div",{class:"hint-title"},"Learn More About Fields",-1),Q=e("h2",{id:"5.-create-an-item",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#5.-create-an-item"},"#"),t(" 5. Create an Item")],-1),V=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/create-an-item-20220427B.mp4",type:"video/mp4"})],-1),W=e("ol",null,[e("li",null,"Navigate to the Content Module."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"add"),t(" in the page header to open the Item Page.")]),e("li",null,"Fill in the Field Value(s) as desired."),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"check"),t(" in the top-right to save your Item.")])],-1),Y={class:"tip hint"},K=e("div",{class:"hint-title"},"Learn More About Items",-1),J=e("h2",{id:"6.-set-roles-%26-permissions",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#6.-set-roles-%26-permissions"},"#"),t(" 6. Set Roles & Permissions")],-1),X=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:""},[e("source",{src:"https://cdn.directus.io/docs/v9/getting-started/quickstart/quickstart-20220427A/set-read-permissions-20220427A.mp4",type:"video/mp4"})],-1),Z=e("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),$=e("p",null,[t("By Default, content entered into Directus will be considered private. So permissions always start off set to the default of "),e("span",{mi:"",icon:"",dngr:""},"block"),t(),e("strong",null,"No Access"),t(", with full ability to reconfigure as desired. So, in order to have the API return our Items, let’s add some read permissions. For simplicity’s sake, we’ll do this on the Public Role, instead of creating a new Role.")],-1),ee=e("ol",null,[e("li",null,[t("Navigate to "),e("strong",null,"Settings Module > Roles & Permissions > Public"),t(".")]),e("li",null,[t("Click "),e("span",{mi:"",icon:"",dngr:""},"block"),t(" under the "),e("span",{mi:"",icon:""},"visibility"),t(" icon on the desired Collection."),e("br"),t(" In our case, the Collection name is "),e("code",null,"article"),t(".")]),e("li",null,[t("Click "),e("strong",null,"“All Access”"),t(" to give the Public Role full read permissions to the Items in this Collection.")])],-1),te={class:"tip hint"},oe=e("div",{class:"hint-title"},"Learn More About Roles & Permissions",-1),ne=e("h2",{id:"7.-connect-to-the-api",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#7.-connect-to-the-api"},"#"),t(" 7. Connect to the API")],-1),le=e("code",null,"/items/",-1),se=e("ol",null,[e("li",null,[t("Open "),e("code",null,"http://your-project-url.directus.app/items/articles"),t("."),e("br"),t(" You can use the browser or an API tool like "),e("a",{href:"http://postman.com",target:"_blank",rel:"noopener noreferrer"},"Postman"),t(" or "),e("a",{href:"https://paw.cloud",target:"_blank",rel:"noopener noreferrer"},"Paw")])],-1),ie=e("p",null,[e("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),ae=e("pre",null,[e("code",{class:"language-json"},[e("span",{class:"hljs-punctuation"},"{"),t(`
+	`),e("span",{class:"hljs-attr"},'"data"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-punctuation"},"["),t(`
+		`),e("span",{class:"hljs-punctuation"},"{"),t(`
+			`),e("span",{class:"hljs-attr"},'"id"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-number"},"1"),e("span",{class:"hljs-punctuation"},","),t(`
+			`),e("span",{class:"hljs-attr"},'"title"'),e("span",{class:"hljs-punctuation"},":"),t(),e("span",{class:"hljs-string"},'"Hello World!"'),t(`
+		`),e("span",{class:"hljs-punctuation"},"}"),t(`
+	`),e("span",{class:"hljs-punctuation"},"]"),t(`
+`),e("span",{class:"hljs-punctuation"},"}"),t(`
+`)])],-1),ce=e("p",null,[e("em",null,"In this example, we made a super-simple read request with the API, but there’s 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),re={class:"tip hint"},de=e("div",{class:"hint-title"},"Learn More About The API",-1),_e="Quickstart Guide",ge=!1,fe="Get up and running with Directus Cloud in minutes. Learn the basics of building your data model and managing permissions.",ye="7 min read",be={__name:"quickstart",setup(ue,{expose:a}){const s={title:"Quickstart Guide",modularExtension:!1,description:"Get up and running with Directus Cloud in minutes. Learn the basics of building your data model and managing permissions.",readTime:"7 min read"};return a({frontmatter:s}),(he,pe)=>{const n=i("router-link"),c=i("docs-wrapper");return r(),d(c,{frontmatter:s},{default:o(()=>[e("div",u,[h,p,m,e("p",null,[t("First, you’ll need to "),l(n,{to:"/docs/cloud/accounts#create-account-and-login"},{default:o(()=>[t("create an Account and log in")]),_:1}),t(" on "),_]),g,f,y,e("div",b,[w,e("ul",null,[e("li",null,[l(n,{to:"/docs/cloud/overview"},{default:o(()=>[t("Overview")]),_:1})]),e("li",null,[l(n,{to:"/docs/cloud/accounts"},{default:o(()=>[t("Cloud Accounts")]),_:1})]),e("li",null,[l(n,{to:"/docs/cloud/teams"},{default:o(()=>[t("Cloud Teams")]),_:1})])])]),v,C,A,e("ol",null,[e("li",null,[t("Open the Team Menu in the Dashboard Header and select or "),l(n,{to:"/docs/cloud/teams#create-a-team"},{default:o(()=>[t("create")]),_:1}),t(" the desired Team.")]),k,P,j,I,T]),x,e("ol",D,[e("li",null,[t("You can "),l(n,{to:"/docs/cloud/projects#access-a-project"},{default:o(()=>[t("access a Project")]),_:1}),t(" from within the Cloud Dashboard or type the URL into your browser.")]),S]),F,e("div",M,[q,e("ul",null,[e("li",null,[l(n,{to:"/docs/cloud/overview"},{default:o(()=>[t("Overview")]),_:1})]),e("li",null,[l(n,{to:"/docs/cloud/projects"},{default:o(()=>[t("Cloud Projects")]),_:1})])])]),L,N,e("p",null,[t("Once logged in, you’re greeted with the option to create your first "),l(n,{to:"/docs/getting-started/glossary#collections"},{default:o(()=>[t("Collection")]),_:1}),t(".")]),R,e("div",G,[O,e("ul",null,[e("li",null,[l(n,{to:"/docs/app/content"},{default:o(()=>[t("The Content Module")]),_:1})]),e("li",null,[l(n,{to:"/docs/configuration/data-model/collections.md"},{default:o(()=>[t("Create and Manage a Collection")]),_:1})]),e("li",null,[l(n,{to:"/docs/configuration/data-model/relationships"},{default:o(()=>[t("Build Relationships Between Collections")]),_:1})])])]),B,E,e("p",null,[t("With your first Collection created, it’s time to start adding some "),l(n,{to:"/docs/getting-started/glossary#fields"},{default:o(()=>[t("Fields")]),_:1}),t(".")]),H,e("div",U,[z,e("ul",null,[e("li",null,[l(n,{to:"/docs/configuration/data-model"},{default:o(()=>[t("Create and Manage Fields in the App")]),_:1})])])]),Q,V,e("p",null,[t("Now that we have a Collection with a Field configured, it’s time to add an "),l(n,{to:"/docs/getting-started/glossary#"},{default:o(()=>[t("Item")]),_:1}),t(".")]),W,e("div",Y,[K,e("ul",null,[e("li",null,[l(n,{to:"/docs/app/content"},{default:o(()=>[t("The Content Module")]),_:1})]),e("li",null,[l(n,{to:"/docs/app/content/items"},{default:o(()=>[t("The Item Page")]),_:1})])])]),J,X,Z,$,ee,e("div",te,[oe,e("ul",null,[e("li",null,[l(n,{to:"/docs/configuration/users-roles-permissions"},{default:o(()=>[t("Users, Roles and Permissions")]),_:1}),t(".")])])]),ne,e("p",null,[t("Now that your Project has some content in it which is exposed to the Public, it’s time to start using this content externally! Data can be accessed in a number of ways, including the REST and GraphQL API endpoints. In this case, we’ll use the "),le,t(),l(n,{to:"/docs/reference/items"},{default:o(()=>[t("REST API endpoint")]),_:1}),t(" to retrieve the Item we just created.")]),se,ie,ae,ce,e("div",re,[de,e("ul",null,[e("li",null,[l(n,{to:"/docs/reference/introduction"},{default:o(()=>[t("Intro to the API")]),_:1})]),e("li",null,[l(n,{to:"/docs/reference/sdk"},{default:o(()=>[t("JS SDK")]),_:1})])])])])]),_:1})}}};export{be as default,fe as description,ge as modularExtension,ye as readTime,_e as title};

package/dist/assets/r-787b0c09.js

@@ -0,0 +1 @@
+import{z as S}from"./index.5b245cc4.entry.js";function z(a,d){for(var o=0;o<d.length;o++){const f=d[o];if(typeof f!="string"&&!Array.isArray(f)){for(const l in f)if(l!=="default"&&!(l in a)){const u=Object.getOwnPropertyDescriptor(f,l);u&&Object.defineProperty(a,l,u.get?u:{enumerable:!0,get:()=>f[l]})}}}return Object.freeze(Object.defineProperty(a,Symbol.toStringTag,{value:"Module"}))}var _={};(function(a,d){(function(o){o(S)})(function(o){o.registerHelper("wordChars","r",/[\w.]/),o.defineMode("r",function(f){function l(e){for(var n={},r=0;r<e.length;++r)n[e[r]]=!0;return n}var u=["NULL","NA","Inf","NaN","NA_integer_","NA_real_","NA_complex_","NA_character_","TRUE","FALSE"],g=["list","quote","bquote","eval","return","call","parse","deparse"],k=["if","else","repeat","while","function","for","in","next","break"],A=["if","else","repeat","while","function","for"];o.registerHelper("hintWords","r",u.concat(g,k));var E=l(u),w=l(g),N=l(k),I=l(A),y=/[+\-*\/^<>=!&|~$:]/,t;function s(e,n){t=null;var r=e.next();if(r=="#")return e.skipToEnd(),"comment";if(r=="0"&&e.eat("x"))return e.eatWhile(/[\da-f]/i),"number";if(r=="."&&e.eat(/\d/))return e.match(/\d*(?:e[+\-]?\d+)?/),"number";if(/\d/.test(r))return e.match(/\d*(?:\.\d+)?(?:e[+\-]\d+)?L?/),"number";if(r=="'"||r=='"')return n.tokenize=L(r),"string";if(r=="`")return e.match(/[^`]+`/),"variable-3";if(r=="."&&e.match(/.(?:[.]|\d+)/))return"keyword";if(/[a-zA-Z\.]/.test(r)){e.eatWhile(/[\w\.]/);var i=e.current();return E.propertyIsEnumerable(i)?"atom":N.propertyIsEnumerable(i)?(I.propertyIsEnumerable(i)&&!e.match(/\s*if(\s+|$)/,!1)&&(t="block"),"keyword"):w.propertyIsEnumerable(i)?"builtin":"variable"}else return r=="%"?(e.skipTo("%")&&e.next(),"operator variable-2"):r=="<"&&e.eat("-")||r=="<"&&e.match("<-")||r=="-"&&e.match(/>>?/)?"operator arrow":r=="="&&n.ctx.argList?"arg-is":y.test(r)?r=="$"?"operator dollar":(e.eatWhile(y),"operator"):/[\(\){}\[\];]/.test(r)?(t=r,r==";"?"semi":null):null}function L(e){return function(n,r){if(n.eat("\\")){var i=n.next();return i=="x"?n.match(/^[a-f0-9]{2}/i):(i=="u"||i=="U")&&n.eat("{")&&n.skipTo("}")?n.next():i=="u"?n.match(/^[a-f0-9]{4}/i):i=="U"?n.match(/^[a-f0-9]{8}/i):/[0-7]/.test(i)&&n.match(/^[0-7]{1,2}/),"string-2"}else{for(var c;(c=n.next())!=null;){if(c==e){r.tokenize=s;break}if(c=="\\"){n.backUp(1);break}}return"string"}}}var h=1,v=2,b=4;function p(e,n,r){e.ctx={type:n,indent:e.indent,flags:0,column:r.column(),prev:e.ctx}}function m(e,n){var r=e.ctx;e.ctx={type:r.type,indent:r.indent,flags:r.flags|n,column:r.column,prev:r.prev}}function x(e){e.indent=e.ctx.indent,e.ctx=e.ctx.prev}return{startState:function(){return{tokenize:s,ctx:{type:"top",indent:-f.indentUnit,flags:v},indent:0,afterIdent:!1}},token:function(e,n){if(e.sol()&&(n.ctx.flags&3||(n.ctx.flags|=v),n.ctx.flags&b&&x(n),n.indent=e.indentation()),e.eatSpace())return null;var r=n.tokenize(e,n);return r!="comment"&&!(n.ctx.flags&v)&&m(n,h),(t==";"||t=="{"||t=="}")&&n.ctx.type=="block"&&x(n),t=="{"?p(n,"}",e):t=="("?(p(n,")",e),n.afterIdent&&(n.ctx.argList=!0)):t=="["?p(n,"]",e):t=="block"?p(n,"block",e):t==n.ctx.type?x(n):n.ctx.type=="block"&&r!="comment"&&m(n,b),n.afterIdent=r=="variable"||r=="keyword",r},indent:function(e,n){if(e.tokenize!=s)return 0;var r=n&&n.charAt(0),i=e.ctx,c=r==i.type;return i.flags&b&&(i=i.prev),i.type=="block"?i.indent+(r=="{"?0:f.indentUnit):i.flags&h?i.column+(c?0:1):i.indent+(c?0:f.indentUnit)},lineComment:"#"}}),o.defineMIME("text/x-rsrc","r")})})();const O=z({__proto__:null,default:_},[_]);export{O as r};

package/dist/assets/readme-13e376ea.js

@@ -0,0 +1 @@
+import{a as l,o as s,e as a,y as i,u as e,q as r}from"./runtime-core.esm-bundler-753bcc58.js";const u=e("div",{class:"markdown-body"},[e("p",{align:"center"},[e("img",{alt:"Directus Logo",src:"https://user-images.githubusercontent.com/522079/158864859-0fbeae62-9d7a-4619-b35e-f8fa5f68e0c8.png"})]),e("br"),e("h2",{id:"%F0%9F%90%B0-introduction",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#%F0%9F%90%B0-introduction"},"#"),r(" 🐰 Introduction")]),e("p",null,[r("This is the official documentation for the Directus data platform. These docs are also available via "),e("a",{href:"https://docs.directus.io",target:"_blank",rel:"noopener noreferrer"},"a public website"),r(".")]),e("p",null,[e("strong",null,[e("a",{href:"https://directus.io",target:"_blank",rel:"noopener noreferrer"},"Learn more about Directus")]),e("br"),r(),e("strong",null,[e("a",{href:"https://directus.cloud",target:"_blank",rel:"noopener noreferrer"},"Create your Free Project")])]),e("br"),e("h2",{id:"%F0%9F%A4%94-community-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#%F0%9F%A4%94-community-help"},"#"),r(" 🤔 Community Help")]),e("p",null,[e("a",{href:"https://docs.directus.io",target:"_blank",rel:"noopener noreferrer"},"The Directus Documentation"),r(" is a great place to start, or explore these other channels:")]),e("ul",null,[e("li",null,[e("a",{href:"https://directus.chat",target:"_blank",rel:"noopener noreferrer"},"Discord"),r(" (Live Discussions)")]),e("li",null,[e("a",{href:"https://github.com/directus/directus/issues",target:"_blank",rel:"noopener noreferrer"},"GitHub Issues"),r(" (Report Bugs)")]),e("li",null,[e("a",{href:"https://github.com/directus/directus/discussions",target:"_blank",rel:"noopener noreferrer"},"GitHub Discussions"),r(" (Questions, Feature Requests)")]),e("li",null,[e("a",{href:"https://twitter.com/directus",target:"_blank",rel:"noopener noreferrer"},"Twitter"),r(" (Latest News)")]),e("li",null,[e("a",{href:"https://www.youtube.com/c/DirectusVideos/featured",target:"_blank",rel:"noopener noreferrer"},"YouTube"),r(" (Video Tutorials)")])]),e("br"),e("h2",{id:"contributing",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#contributing"},"#"),r(" Contributing")]),e("blockquote",null,[e("p",null,[e("strong",null,"Note")]),e("p",null,[r("This project uses "),e("a",{href:"https://pnpm.io",target:"_blank",rel:"noopener noreferrer"},[e("code",null,"pnpm")]),r(" to manage the dependencies, install it if you haven’t via "),e("code",null,"npm i -g pnpm"),r(".")])]),e("ol",null,[e("li",null,"Fork and clone the repo"),e("li",null,[r("Install the dependencies through "),e("code",null,"pnpm install")]),e("li",null,[r("Run the docs website by running "),e("code",null,"pnpm dev")])])],-1),f="null",b=!1,m={__name:"readme",setup(c,{expose:n}){const t={title:"null",modularExtension:!1};return n({frontmatter:t}),(p,d)=>{const o=l("docs-wrapper");return s(),a(o,{frontmatter:t},{default:i(()=>[u]),_:1})}}};export{m as default,b as modularExtension,f as title};

package/dist/assets/relations-0ed36a6a.js

@@ -0,0 +1,115 @@
+import{a as t,o as i,e as r,y as l,u as s,q as n,z as h}from"./runtime-core.esm-bundler-753bcc58.js";const p={class:"markdown-body"},u=s("hr",null,null,-1),d=s("h2",{id:"the-relation-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-relation-object"},"#"),n(" The Relation Object")],-1),_=s("p",null,[s("code",null,"collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the collection. This matches the table name in the database.")],-1),j=s("p",null,[s("code",null,"field"),n(),s("strong",null,"string"),s("br"),n(" Name of the field that holds the related primary key. This matches the column name in the database.")],-1),m=s("p",null,[s("code",null,"related_collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the related collection. This matches the table name in the database.")],-1),g=s("h4",{id:"meta",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#meta"},"#"),n(" Meta")],-1),f=s("p",null,"Directus metadata. Used to enable non-database relationship types",-1),b=s("p",null,[s("code",null,"id"),n(),s("strong",null,"integer"),s("br"),n(" Primary key of the metadata row in "),s("code",null,"directus_relations"),n(".")],-1),y=s("p",null,[s("code",null,"many_collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the collection. Matches the top level "),s("code",null,"collection"),n(" field.")],-1),x=s("p",null,[s("code",null,"many_field"),n(),s("strong",null,"string"),s("br"),n(" Name of the field. Matches the top level "),s("code",null,"field"),n(" field.")],-1),q=s("p",null,[s("code",null,"one_collection"),n(),s("strong",null,"string"),s("br"),n(" Name of the related collection. Matches the top level "),s("code",null,"related_collection"),n(" field.")],-1),w=s("p",null,[s("code",null,"one_field"),n(),s("strong",null,"string"),s("br"),n(" Name of the one to many field on the other side of the relation.")],-1),k=s("p",null,[s("code",null,"one_allowed_collections"),n(),s("strong",null,"string"),s("br"),n(" What collections are allowed to be used in a many-to-any context.")],-1),T=s("p",null,[s("code",null,"one_collection_field"),n(),s("strong",null,"string"),s("br"),n(" Field that holds the collection name in a many-to-any context.")],-1),E=s("p",null,[s("code",null,"one_deselect_action"),n(),s("strong",null,"nullify | delete"),s("br"),n(" Whether to nullify or delete related one-to-many records.")],-1),R=s("p",null,[s("code",null,"sort_field"),n(),s("strong",null,"string"),s("br"),n(" What field is used to hold the sort field.")],-1),P=s("p",null,[s("code",null,"junction_field"),n(),s("strong",null,"string"),s("br"),n(" What field connects two relations in a many-to-many (O2M-M2O) context.")],-1),S=s("h4",{id:"schema",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#schema"},"#"),n(" Schema")],-1),v=s("p",null,"“Raw” database information. Based on the database vendor used, different information might be returned. The following are available for all drivers.",-1),L=s("p",null,[s("code",null,"table"),n(),s("strong",null,"string"),s("br"),n(" The table name.")],-1),A=s("p",null,[s("code",null,"column"),n(),s("strong",null,"string"),s("br"),n(" The column name.")],-1),Q=s("p",null,[s("code",null,"foreign_key_table"),n(),s("strong",null,"string"),s("br"),n(" Related table name.")],-1),D=s("p",null,[s("code",null,"foreign_key_column"),n(),s("strong",null,"string"),s("br"),n(" Related column name.")],-1),N=s("p",null,[s("code",null,"constraint_name"),n(),s("strong",null,"string"),s("br"),n(" Name for the foreign key constraint.")],-1),G=s("p",null,[s("code",null,"on_update"),n(),s("strong",null,"string"),s("br"),n(" Update trigger for the foreign key constraint.")],-1),O=s("p",null,[s("code",null,"on_delete"),n(),s("strong",null,"string"),s("br"),n(" Delete trigger for the foreign key constraint.")],-1),I=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"about_us"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"logo"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"related_collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"directus_files"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"schema"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"table"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"about_us"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"column"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"logo"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"foreign_key_table"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"directus_files"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"foreign_key_column"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"id"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"constraint_name"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"about_us_logo_foreign"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"on_update"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"NO ACTION"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"on_delete"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"SET NULL"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-number"},"1"),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"junction_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"many_collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"about_us"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"many_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"logo"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"one_allowed_collections"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"one_collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"directus_files"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"one_collection_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"one_deselect_action"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"nullify"'),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"one_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),n(`
+		`),s("span",{class:"hljs-attr"},'"sort_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),C=s("hr",null,null,-1),M=s("h2",{id:"list-relations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-relations"},"#"),n(" List relations")],-1),B=s("p",null,"List all relations that exist in Directus.",-1),U=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user’s permissions. For example, relations that apply to a collection that the current user doesn’t have access to are stripped out.")],-1),W=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),n(" Query Parameters")],-1),F=s("p",null,"Doesn’t support any query parameters.",-1),V=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),n(" Returns")],-1),H=s("p",null,[n("Array of "),s("a",{href:"#the-relation-object"},"relation objects"),n(". If no items are available, data will be an empty array.")],-1),z=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),n(" REST API")],-1),J=s("pre",null,[s("code",null,`GET /relations
+`)],-1),K=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),n(" GraphQL")],-1),X=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Y=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-symbol"},"relations"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n("directus_relations"),s("span",{class:"hljs-punctuation"},"]"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Z=s("h5",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),n(" Example")],-1),$=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	relations `),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),ss=s("hr",null,null,-1),ns=s("h2",{id:"list-relations-in-collection",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-relations-in-collection"},"#"),n(" List relations in collection")],-1),as=s("p",null,"List all relations that exist in a given collection.",-1),ts=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Permissions"),s("p",null,"The data returned in this endpoint will be filtered based on the user’s permissions. For example, relations that apply to a collection that the current user doesn’t have access to are stripped out.")],-1),ls=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),n(" Query Parameters")],-1),es=s("p",null,"Doesn’t support any query parameters.",-1),os=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),n(" Returns")],-1),cs=s("p",null,[n("Array of "),s("a",{href:"#the-relation-object"},"relation objects"),n(". If no items are available, data will be an empty array.")],-1),is=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),n(" REST API")],-1),rs=s("pre",null,[s("code",null,`GET /relations/:collection
+`)],-1),hs=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),n(" Example")],-1),ps=s("pre",null,[s("code",null,`GET /relations/articles
+`)],-1),us=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),n(" GraphQL")],-1),ds=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),_s=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	relations_in_collection`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"["),n("directus_relations"),s("span",{class:"hljs-punctuation"},"]"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),js=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),n(" Example")],-1),ms=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	relations_in_collection`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),gs=s("hr",null,null,-1),fs=s("h2",{id:"retrieve-a-relation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-relation"},"#"),n(" Retrieve a relation")],-1),bs=s("p",null,"List an existing relation by collection/field name.",-1),ys=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),n(" Query Parameters")],-1),xs=s("p",null,"Doesn’t support any query parameters.",-1),qs=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),n(" Returns")],-1),ws=s("p",null,[n("Returns the requested "),s("a",{href:"#the-relation-object"},"relation object"),n(".")],-1),ks=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),n(" REST API")],-1),Ts=s("pre",null,[s("code",null,`GET /relations/:collection/:field
+`)],-1),Es=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),n(" Example")],-1),Rs=s("pre",null,[s("code",null,`GET /relations/articles/featured_image
+`)],-1),Ps=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),n(" GraphQL")],-1),Ss=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),vs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	relations_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_relations
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Ls=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),n(" Example")],-1),As=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	relations_by_name`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"featured_image"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+		related_collection
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Qs=s("hr",null,null,-1),Ds=s("h2",{id:"create-a-relation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#create-a-relation"},"#"),n(" Create a Relation")],-1),Ns=s("p",null,"Create a new relation.",-1),Gs=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),n(" Query Parameters")],-1),Os=s("p",null,"Doesn’t support any query parameters.",-1),Is=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),n(" Request Body")],-1),Cs=s("p",null,[n("A partial "),s("a",{href:"#the-relation-object"},"relation object"),n(".")],-1),Ms=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),n(" Returns")],-1),Bs=s("p",null,[n("Returns the "),s("a",{href:"#the-relation-object"},"relation object"),n(" for the created relation.")],-1),Us=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),n(" REST API")],-1),Ws=s("pre",null,[s("code",null,`POST /relations
+`)],-1),Fs=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),n(" Example")],-1),Vs=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /relations"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"featured_image"'),s("span",{class:"hljs-punctuation"},","),n(`
+	`),s("span",{class:"hljs-attr"},'"related_collection"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"directus_files"'),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Hs=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),n(" GraphQL")],-1),zs=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Js=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_relations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" create_directus_relations_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_relations
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Ks=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),n(" Example")],-1),Xs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	create_relations_item`),s("span",{class:"hljs-punctuation"},"("),n(`
+		`),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"featured_image"'),n(", "),s("span",{class:"hljs-symbol"},"related_collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"directus_files"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(`
+	`),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+		related_collection
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Ys=s("hr",null,null,-1),Zs=s("h2",{id:"update-a-relation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-relation"},"#"),n(" Update a Relation")],-1),$s=s("p",null,"Update an existing relation.",-1),sn=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),n(" Query Parameters")],-1),nn=s("p",null,"Doesn’t support any query parameters.",-1),an=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),n(" Request Body")],-1),tn=s("p",null,[n("A partial "),s("a",{href:"#the-relation-object"},"relation object"),n(".")],-1),ln=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),n(" Returns")],-1),en=s("p",null,[n("Returns the "),s("a",{href:"#the-relation-object"},"relation object"),n(" for the created relation.")],-1),on=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),n(" REST API")],-1),cn=s("pre",null,[s("code",null,`PATCH /relations/:collection/:field
+`)],-1),rn=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),n(" Example")],-1),hn=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /relations/articles/author"),n(`
+
+`),s("span",{class:"hljs-punctuation"},"{"),n(`
+	`),s("span",{class:"hljs-attr"},'"meta"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		`),s("span",{class:"hljs-attr"},'"one_field"'),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(`
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),pn=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),n(" GraphQL")],-1),un=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),dn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_relations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(" update_directus_relations_input"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` directus_relations
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),_n=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),n(" Example")],-1),jn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	update_relations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"author"'),n(", "),s("span",{class:"hljs-symbol"},"data"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"meta"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-punctuation"},"{"),n(),s("span",{class:"hljs-symbol"},"one_field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(),s("span",{class:"hljs-punctuation"},"}"),n(),s("span",{class:"hljs-punctuation"},"}"),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+		related_collection
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),mn=s("hr",null,null,-1),gn=s("h2",{id:"delete-a-relation",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-relation"},"#"),n(" Delete a Relation")],-1),fn=s("p",null,"Delete an existing relation.",-1),bn=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),n(" Returns")],-1),yn=s("p",null,"Empty body.",-1),xn=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),n(" REST API")],-1),qn=s("pre",null,[s("code",null,`DELETE /relations/:collection/:field
+`)],-1),wn=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),n(" Example")],-1),kn=s("pre",null,[s("code",null,`DELETE /relations/articles/author
+`)],-1),Tn=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),n(" GraphQL")],-1),En=s("pre",null,[s("code",null,`POST /graphql/system
+`)],-1),Rn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),n(),s("span",{class:"hljs-keyword"},"Mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_relations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(" String"),s("span",{class:"hljs-punctuation"},"!"),s("span",{class:"hljs-punctuation"},")"),s("span",{class:"hljs-punctuation"},":"),n(` delete_one
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Pn=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),n(" Example")],-1),Sn=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+	delete_relations_item`),s("span",{class:"hljs-punctuation"},"("),s("span",{class:"hljs-symbol"},"collection"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"articles"'),n(", "),s("span",{class:"hljs-symbol"},"field"),s("span",{class:"hljs-punctuation"},":"),n(),s("span",{class:"hljs-string"},'"author"'),s("span",{class:"hljs-punctuation"},")"),n(),s("span",{class:"hljs-punctuation"},"{"),n(`
+		collection
+		field
+	`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`),s("span",{class:"hljs-punctuation"},"}"),n(`
+`)])],-1),Dn="Relations",Nn=!1,Gn="REST and GraphQL API documentation on the Relations collection in Directus.",On="5 min read",In="page-reference",Cn={__name:"relations",setup(vn,{expose:e}){const a={title:"Relations",modularExtension:!1,description:"REST and GraphQL API documentation on the Relations collection in Directus.",readTime:"5 min read",pageClass:"page-reference"};return e({frontmatter:a}),(Ln,An)=>{const o=t("router-link"),c=t("docs-wrapper");return i(),r(c,{frontmatter:a},{default:l(()=>[s("div",p,[s("blockquote",null,[s("p",null,[n("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. "),h(o,{to:"/docs/getting-started/glossary#relationships"},{default:l(()=>[n("Learn more about Relationships")]),_:1}),n(".")])]),u,d,_,j,m,g,f,b,y,x,q,w,k,T,E,R,P,S,v,L,A,Q,D,N,G,O,I,C,M,B,U,W,F,V,H,z,J,K,X,Y,Z,$,ss,ns,as,ts,ls,es,os,cs,is,rs,hs,ps,us,ds,_s,js,ms,gs,fs,bs,ys,xs,qs,ws,ks,Ts,Es,Rs,Ps,Ss,vs,Ls,As,Qs,Ds,Ns,Gs,Os,Is,Cs,Ms,Bs,Us,Ws,Fs,Vs,Hs,zs,Js,Ks,Xs,Ys,Zs,$s,sn,nn,an,tn,ln,en,on,cn,rn,hn,pn,un,dn,_n,jn,mn,gn,fn,bn,yn,xn,qn,wn,kn,Tn,En,Rn,Pn,Sn])]),_:1})}}};export{Cn as default,Gn as description,Nn as modularExtension,In as pageClass,On as readTime,Dn as title};

package/dist/assets/relationship-aba70908.js

@@ -0,0 +1 @@
+import{a as s,o as d,e as c,y as t,u as o,z as a,q as n}from"./runtime-core.esm-bundler-753bcc58.js";const u={class:"markdown-body"},p=o("p",null,"This pane is only shown when configuring relational fields (including images and translations). Depending on the type of relationship, you’ll be presented with one of the following set of options:",-1),m=o("li",null,"One-to-One",-1),_={class:"tip hint"},h=o("div",{class:"hint-title"},"Corresponding Field",-1),x="Relationship",k=!1,v={__name:"relationship",setup(f,{expose:l}){const i={title:"Relationship",modularExtension:!1};return l({frontmatter:i}),(y,g)=>{const e=s("router-link"),r=s("docs-wrapper");return d(),c(r,{frontmatter:i},{default:t(()=>[o("div",u,[p,o("ul",null,[o("li",null,[a(e,{to:"/docs/configuration/data-model/relationships#many-to-one-m2o"},{default:t(()=>[n("Many-to-One")]),_:1})]),o("li",null,[a(e,{to:"/docs/configuration/data-model/relationships#one-to-many-o2m"},{default:t(()=>[n("One-to-Many")]),_:1})]),o("li",null,[a(e,{to:"/docs/configuration/data-model/relationships#many-to-many-m2m"},{default:t(()=>[n("Many-to-Many")]),_:1})]),o("li",null,[a(e,{to:"/docs/configuration/data-model/relationships#many-to-many-m2m"},{default:t(()=>[n("Many-to-Any")]),_:1})]),o("li",null,[a(e,{to:"/docs/configuration/data-model/relationships#translations-o2m"},{default:t(()=>[n("Translations")]),_:1})]),m]),o("div",_,[h,o("p",null,[a(e,{to:"/docs/configuration/data-model/relationships#perspective-matters"},{default:t(()=>[n("Relationships go both ways")]),_:1}),n(", so when creating a new relation Field, Directus offers to automatically create the corresponding Field on the related Collection.")])])])]),_:1})}}};export{v as default,k as modularExtension,x as title};