@directus/app 9.18.1 → 9.19.1

package/dist/assets/files.1cb7ba05.js

@@ -1,189 +0,0 @@
-import{a as o,o as r,b as h,w as t,l as s,e as n,E as e}from"./runtime-core.esm-bundler.32cac88a.js";const d={class:"markdown-body"},u=s("blockquote",null,[s("p",null,[e("Every file managed by the platform is uploaded to the configured storage adapter, and its associated metadata is tracked within the "),s("code",null,"directus_files"),e(" system collection. Any requested file transformations are handled on the fly, and are only saved to storage.")])],-1),p=s("hr",null,null,-1),_=s("h2",{id:"accessing-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#accessing-a-file"},"#"),e(" Accessing a File")],-1),f=s("p",null,"The location of your actual file originals is based on the project\u2019s configuration, but you can consistently access them via the API using the following URL.",-1),m=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>
-example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4
-`)],-1),g=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"SEO"),s("p",null,"You can provide an optional filename after the UUID to optimize for SEO, for example:"),s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>/<filename>
-example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4/directus-logo.png
-`)]),s("p",null,[e("This optional filename is also used in the Content-Disposition header when the "),s("code",null,"?download"),e(" query parameter is used.")])],-1),j=s("div",{class:"warning hint"},[s("div",{class:"hint-title"},"Direct File Access"),s("p",null,[e("While you may "),s("em",null,"technically"),e(" be able to expose your storage adapters root file system and access your raw files through there, it is recommended that you always use the Directus API. This is the only way that you can take advantage of file permissions and other built-in features.")])],-1),b=s("p",null,[s("img",{src:"https://cdn.directus.io/docs/v9/reference/files/original-20220216A.jpg",alt:"Original File"}),e(),s("em",null,"Original File Used \u2014 602KB and 1800x1200")],-1),y=s("hr",null,null,-1),x=s("h2",{id:"downloading-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#downloading-a-file"},"#"),e(" Downloading a File")],-1),q=s("p",null,[e("To download an asset with the correct filename, you need to add the "),s("code",null,"?download"),e(" query parameter to the request and the "),s("code",null,"download"),e(" attribute to your anchor tag. This will ensure the appropriate "),s("a",{href:"https://www.w3.org/Protocols/rfc2616/rfc2616-sec19.html",target:"_blank",rel:"noopener noreferrer"},"Content-Disposition"),e(" headers are added. Without this, the download will work on the "),s("em",null,"same"),e(" domain, however it will have the file\u2019s \u201Cid\u201D as the filename for cross-origin requests.")],-1),w=s("h3",{id:"example",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example"},"#"),e(" Example")],-1),v=s("pre",null,[s("code",{class:"language-html"},[s("span",{class:"hljs-tag"},[e("<"),s("span",{class:"hljs-name"},"a"),e(),s("span",{class:"hljs-attr"},"href"),e("="),s("span",{class:"hljs-string"},'"https://your-directus.com/assets/<file-id>?download"'),e(),s("span",{class:"hljs-attr"},"target"),e("="),s("span",{class:"hljs-string"},'"_blank"'),e(),s("span",{class:"hljs-attr"},"download"),e("="),s("span",{class:"hljs-string"},'"Your File.pdf"'),e(">")]),e("Download"),s("span",{class:"hljs-tag"},[e("</"),s("span",{class:"hljs-name"},"a"),e(">")]),e(`
-`)])],-1),T=s("hr",null,null,-1),k=s("h2",{id:"requesting-a-thumbnail",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#requesting-a-thumbnail"},"#"),e(" Requesting a Thumbnail")],-1),E=s("p",null,[e("Fetching thumbnails is as easy as adding a "),s("code",null,"key"),e(" query parameter to the original file\u2019s URL. In the Admin App, you can configure different asset presets that control the output of any given image. If a requested thumbnail doesn\u2019t yet exist, it is dynamically generated and immediately returned.")],-1),R=s("h3",{id:"preset-transformations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#preset-transformations"},"#"),e(" Preset Transformations")],-1),A=s("strong",null,[s("code",null,"key")],-1),S=e(" \u2014 This "),D=s("strong",null,"key",-1),P=e(" of the "),I=e("Storage Asset Preset"),C=e(", a shortcut for the below parameters"),F=s("h3",{id:"custom-transformations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#custom-transformations"},"#"),e(" Custom Transformations")],-1),O=s("p",null,"Alternatively, if you have \u201CStorage Asset Transform\u201D set to all, you can use the following parameters for more fine grained control:",-1),Q=s("ul",null,[s("li",null,[s("strong",null,[s("code",null,"fit")]),e(" \u2014 The "),s("strong",null,"fit"),e(" of the thumbnail while always preserving the aspect ratio, can be any of the following options: "),s("ul",null,[s("li",null,[s("code",null,"cover"),e(" \u2014 Covers both width/height by cropping/clipping to fit")]),s("li",null,[s("code",null,"contain"),e(" \u2014 Contain within both width/height using \u201Cletterboxing\u201D as needed")]),s("li",null,[s("code",null,"inside"),e(" \u2014 Resize to be as large as possible, ensuring dimensions are less than or equal to the requested width and height")]),s("li",null,[s("code",null,"outside"),e(" \u2014 Resize to be as small as possible, ensuring dimensions are greater than or equal to the requested width and height")])])]),s("li",null,[s("strong",null,[s("code",null,"width")]),e(" \u2014 The "),s("strong",null,"width"),e(" of the thumbnail in pixels")]),s("li",null,[s("strong",null,[s("code",null,"height")]),e(" \u2014 The "),s("strong",null,"height"),e(" of the thumbnail in pixels")]),s("li",null,[s("strong",null,[s("code",null,"quality")]),e(" \u2014 The optional "),s("strong",null,"quality"),e(" of the thumbnail ("),s("code",null,"1"),e(" to "),s("code",null,"100"),e(")")]),s("li",null,[s("strong",null,[s("code",null,"withoutEnlargement")]),e(" \u2014 Disable image up-scaling")]),s("li",null,[s("strong",null,[s("code",null,"format")]),e(" \u2014 What file format to return the thumbnail in. One of "),s("code",null,"jpg"),e(", "),s("code",null,"png"),e(", "),s("code",null,"webp"),e(", "),s("code",null,"tiff")])],-1),L=s("h3",{id:"advanced-transformations",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#advanced-transformations"},"#"),e(" Advanced Transformations")],-1),X=s("p",null,[e("For even more advanced control over the file generation, Directus exposes "),s("a",{href:"https://sharp.pixelplumbing.com/api-operation",target:"_blank",rel:"noopener noreferrer"},[e("the full "),s("code",null,"sharp"),e(" API")]),e(" through the "),s("code",null,"transforms"),e(" query parameter. This parameter accepts a two-dimensional array with the format "),s("code",null,"[Operation, ...arguments]"),e(".")],-1),B=s("h3",{id:"quality-vs-file-size",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#quality-vs-file-size"},"#"),e(" Quality vs File Size")],-1),U=s("p",null,[e("The quality parameter can be any integer from "),s("code",null,"0-100"),e(". Qualities closer to "),s("code",null,"0"),e(" have lower file sizes, but also poor image quality due to compression artifacts. Values closer to "),s("code",null,"100"),e(" have larger file sizes, but better image quality. Below are four possible qualities (200x200 cover) to visually compare the balance between compression and file size.")],-1),Y=s("table",null,[s("thead",null,[s("tr",null,[s("th",null,"25%"),s("th",null,"50%"),s("th",null,"75%"),s("th",null,"100%")])]),s("tbody",null,[s("tr",null,[s("td",null,[s("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-25-20220216A.jpg",alt:"25%"}),s("br"),s("em",null,"4KB")]),s("td",null,[s("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-50-20220216A.jpg",alt:"50%"}),s("br"),s("em",null,"6KB")]),s("td",null,[s("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-75-20220216A.jpg",alt:"75%"}),s("br"),s("em",null,"8KB")]),s("td",null,[s("img",{src:"https://cdn.directus.io/docs/v9/reference/files/200-200-cover-100-20220216A.jpg",alt:"100%"}),s("br"),s("em",null,"38KB")])])])],-1),G=s("h3",{id:"preset",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#preset"},"#"),e(" Preset")],-1),M=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>?key=<key>
-`)],-1),z=s("h3",{id:"custom",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#custom"},"#"),e(" Custom")],-1),N=s("pre",null,[s("code",{class:"language-txt"},`example.com/assets/<file-id>?fit=<fit>&width=<width>&height=<height>&quality=<quality>
-example.com/assets/1ac73658-8b62-4dea-b6da-529fbc9d01a4?fit=cover&width=200&height=200&quality=80
-`)],-1),Z=s("h3",{id:"advanced",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#advanced"},"#"),e(" Advanced")],-1),H=s("pre",null,[s("code",{class:"language-txt"},`?transforms=[
-	["blur", 45],
-	["tint", "rgb(255, 0, 0)"],
-	["expand", { "right": 200, "bottom": 150 }]
-]
-`)],-1),W=s("hr",null,null,-1),K=s("h2",{id:"the-file-object",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#the-file-object"},"#"),e(" The File Object")],-1),J=s("p",null,[s("code",null,"id"),e(),s("strong",null,"uuid"),s("br"),e(" Primary key of the file")],-1),V=s("p",null,[s("code",null,"storage"),e(),s("strong",null,"string"),s("br"),e(" Storage adapter used for the file.")],-1),$=s("p",null,[s("code",null,"filename_disk"),e(),s("strong",null,"string"),s("br"),e(" Name of the file as saved on the storage adapter.")],-1),ss=s("p",null,[s("code",null,"filename_download"),e(),s("strong",null,"string"),s("br"),e(" Preferred filename when file is downloaded.")],-1),es=s("p",null,[s("code",null,"title"),e(),s("strong",null,"string"),s("br"),e(" Title for the file.")],-1),ts=s("p",null,[s("code",null,"type"),e(),s("strong",null,"string"),s("br"),e(" Mimetype of the file.")],-1),as=s("code",null,"folder",-1),ns=e(),ls=s("strong",null,"many-to-one",-1),os=s("br",null,null,-1),is=e(" What (virtual) folder the file is in. Many-to-one to "),cs=e("folders"),rs=e("."),hs=s("code",null,"uploaded_by",-1),ds=e(),us=s("strong",null,"many-to-one",-1),ps=s("br",null,null,-1),_s=e(" Who uploaded the file. Many-to-one to "),fs=e("users"),ms=e("."),gs=s("p",null,[s("code",null,"uploaded_on"),e(),s("strong",null,"datetime"),s("br"),e(" When the file was uploaded.")],-1),js=s("code",null,"modified_by",-1),bs=e(),ys=s("strong",null,"many-to-one",-1),xs=s("br",null,null,-1),qs=e(" Who updated the file last. Many-to-one to "),ws=e("users"),vs=e("."),Ts=s("p",null,[s("code",null,"filesize"),e(),s("strong",null,"number"),s("br"),e(" Size of the file in bytes.")],-1),ks=s("p",null,[s("code",null,"width"),e(),s("strong",null,"number"),s("br"),e(" If the file is a(n) image/video, it\u2019s the width in px.")],-1),Es=s("p",null,[s("code",null,"height"),e(),s("strong",null,"number"),s("br"),e(" If the file is a(n) image/video, it\u2019s the height in px.")],-1),Rs=s("p",null,[s("code",null,"duration"),e(),s("strong",null,"number"),s("br"),e(" If the file contains audio/video, it\u2019s the duration in milliseconds.")],-1),As=s("p",null,[s("code",null,"description"),e(),s("strong",null,"string"),s("br"),e(" Description of the file.")],-1),Ss=s("p",null,[s("code",null,"location"),e(),s("strong",null,"string"),s("br"),e(" Location of the file.")],-1),Ds=s("p",null,[s("code",null,"tags"),e(),s("strong",null,"array"),s("br"),e(" Tags for the file.")],-1),Ps=s("p",null,[s("code",null,"metadata"),e(),s("strong",null,"object"),s("br"),e(" Any additional metadata Directus was able to scrape from the file. For images, this includes EXIF, IPTC, and ICC information.")],-1),Is=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"id"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"storage"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"local"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"filename_disk"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"4f4b14fa-a43a-46d0-b7ad-90af5919bebb.jpeg"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"filename_download"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"paulo-silva-vSRgXtQuns8-unsplash.jpg"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Paulo Silva (via Unsplash)"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"type"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"image/jpeg"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"folder"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"uploaded_by"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"0bc7b36a-9ba9-4ce0-83f0-0a526f354e07"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"uploaded_on"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2021-02-04T11:37:41-05:00"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"modified_by"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"modified_on"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2021-02-04T11:37:42-05:00"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"filesize"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"3442252"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"width"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"3456"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"height"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-number"},"5184"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"duration"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"location"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-literal"},[s("span",{class:"hljs-keyword"},"null")]),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"tags"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"photo"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"pretty"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"metadata"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"icc"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-			`),s("span",{class:"hljs-attr"},'"version"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"2.1"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"intent"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Perceptual"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"cmm"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"lcms"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"deviceClass"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Monitor"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"colorSpace"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"RGB"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"connectionSpace"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"XYZ"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"platform"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Apple"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"creator"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"lcms"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"description"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"c2"'),s("span",{class:"hljs-punctuation"},","),e(`
-			`),s("span",{class:"hljs-attr"},'"copyright"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'""'),e(`
-		`),s("span",{class:"hljs-punctuation"},"}"),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Cs=s("hr",null,null,-1),Fs=s("h2",{id:"list-files",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#list-files"},"#"),e(" List Files")],-1),Os=s("p",null,"List all files that exist in Directus.",-1),Qs=s("h3",{id:"query-parameters",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters"},"#"),e(" Query Parameters")],-1),Ls=e("Supports all "),Xs=e("global query parameters"),Bs=e("."),Us=s("h3",{id:"returns",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns"},"#"),e(" Returns")],-1),Ys=e("An array of up to "),Gs=e("limit"),Ms=e(),zs=s("a",{href:"#the-file-object"},"file objects",-1),Ns=e(". If no items are available, data will be an empty array."),Zs=s("h3",{id:"rest-api",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api"},"#"),e(" REST API")],-1),Hs=s("pre",null,[s("code",null,`GET /files
-SEARCH /files
-`)],-1),Ws=e("Learn more about SEARCH ->"),Ks=s("h3",{id:"graphql",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql"},"#"),e(" GraphQL")],-1),Js=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),Vs=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	files: [directus_files]
-}
-`)])],-1),$s=s("h5",{id:"example-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-1"},"#"),e(" Example")],-1),se=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	files {
-		id
-		filename_disk
-	}
-}
-`)])],-1),ee=s("hr",null,null,-1),te=s("h2",{id:"retrieve-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#retrieve-a-file"},"#"),e(" Retrieve a File")],-1),ae=s("p",null,"Retrieve a single file by primary key.",-1),ne=s("h3",{id:"query-parameters-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-1"},"#"),e(" Query Parameters")],-1),le=e("Supports all "),oe=e("global query parameters"),ie=e("."),ce=s("h3",{id:"returns-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-1"},"#"),e(" Returns")],-1),re=s("p",null,[e("Returns a "),s("a",{href:"#the-file-object"},"file object"),e(" if a valid primary key was provided.")],-1),he=s("h3",{id:"rest-api-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-1"},"#"),e(" REST API")],-1),de=s("pre",null,[s("code",{class:"language-txt"},`GET /files/:id
-`)],-1),ue=s("h5",{id:"example-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-2"},"#"),e(" Example")],-1),pe=s("pre",null,[s("code",{class:"language-txt"},`GET /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
-`)],-1),_e=s("h3",{id:"graphql-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-1"},"#"),e(" GraphQL")],-1),fe=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),me=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Query"),e(` {
-	files_by_id(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): directus_files
-}
-`)])],-1),ge=s("h5",{id:"example-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-3"},"#"),e(" Example")],-1),je=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"query"),e(` {
-	files_by_id(id: `),s("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),e(`) {
-		id
-		filename_disk
-	}
-}
-`)])],-1),be=s("h2",{id:"upload-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#upload-a-file"},"#"),e(" Upload a File")],-1),ye=s("p",null,"Upload/create a new file.",-1),xe=s("p",null,[e("To upload a file, use "),s("code",null,"multipart/form-data"),e(" as the encoding type, instead of JSON.")],-1),qe=s("p",null,[e("The file contents has to be provided in a part called "),s("code",null,"file"),e(". All other properties of "),s("a",{href:"#the-file-object"},"the file object"),e(" can be provided as parts as well.")],-1),we=s("div",{class:"tip hint"},[s("div",{class:"hint-title"},"Order Matters"),s("p",null,[e("Make sure to define the non-file properties "),s("em",null,"first"),e(". This ensures that the file metadata is associated with the correct file.")])],-1),ve=s("p",null,"You can upload multiple files at a time by repeating the payload with different contents, for example:",-1),Te=s("pre",null,[s("code",null,`--__X_BOUNDARY__
-Content-Disposition: form-data; name="title"
-
-Example
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
-Content-Type: image/jpeg
-
-// binary data
-
---__X_BOUNDARY__
-Content-Disposition: form-data; name="title"
-
-Another Title
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="mae-mu-GFhqNX1gE9E-unsplash.jpg"
-Content-Type: image/jpeg
-
-// binary data
-`)],-1),ke=s("p",null,[e("In JavaScript, this can be achieved using the native "),s("code",null,"FormData"),e(" class:")],-1),Ee=s("pre",null,[s("code",{class:"language-js"},[s("span",{class:"hljs-keyword"},"import"),e(" axios "),s("span",{class:"hljs-keyword"},"from"),e(),s("span",{class:"hljs-string"},"'axios'"),e(`;
-
-`),s("span",{class:"hljs-keyword"},"const"),e(" fileInput = "),s("span",{class:"hljs-variable language_"},"document"),e("."),s("span",{class:"hljs-title function_"},"querySelector"),e("("),s("span",{class:"hljs-string"},`'input[type="file"]'`),e(`);
-`),s("span",{class:"hljs-keyword"},"const"),e(" formData = "),s("span",{class:"hljs-keyword"},"new"),e(),s("span",{class:"hljs-title class_"},"FormData"),e(`();
-
-formData.`),s("span",{class:"hljs-title function_"},"append"),e("("),s("span",{class:"hljs-string"},"'title'"),e(", "),s("span",{class:"hljs-string"},"'My First File'"),e(`);
-formData.`),s("span",{class:"hljs-title function_"},"append"),e("("),s("span",{class:"hljs-string"},"'file'"),e(", fileInput."),s("span",{class:"hljs-property"},"files"),e("["),s("span",{class:"hljs-number"},"0"),e(`]);
-
-`),s("span",{class:"hljs-keyword"},"await"),e(" axios."),s("span",{class:"hljs-title function_"},"post"),e("("),s("span",{class:"hljs-string"},"'/files'"),e(`, formData);
-`)])],-1),Re=s("h3",{id:"query-parameters-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-2"},"#"),e(" Query Parameters")],-1),Ae=e("Supports all "),Se=e("global query parameters"),De=e("."),Pe=s("h3",{id:"returns-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-2"},"#"),e(" Returns")],-1),Ie=s("p",null,[e("Returns the "),s("a",{href:"#the-file-object"},"file object"),e(" for the uploaded file, or an array of "),s("a",{href:"#the-file-object"},"file objects"),e(" if multiple files were uploaded at once.")],-1),Ce=s("pre",null,[s("code",{class:"language-txt"},`POST /files
-`)],-1),Fe=s("pre",null,[s("code",null,`// Request
-
-Content-Type: multipart/form-data; charset=utf-8; boundary=__X_BOUNDARY__
-Content-Length: 3442422
-
---__X_BOUNDARY__
-Content-Disposition: form-data; name="file"; filename="paulo-silva-vSRgXtQuns8-unsplash.jpg"
-Content-Type: image/jpeg
-
-\xFF\xD8\xFF\xE0JFIF


HH\xFF\xE2ICC_PROFILE

\flcmsmntrRGB XYZ \x07\xDC
)9acspAPPL\xF6\xD6
\xD3-lcms
-desc\xFC^cprt
\\\vwtpt
hbkpt
|rXYZ
\x90gXYZ
\xA4bXYZ
\xB8rTRC
\xCC@gTRC
\xCC@bTRC
\xCC@descc2textIXXYZ \xF6\xD6
\xD3-XYZ 3\xA4XYZ o\xA28\xF5\x90XYZ b\x99\xB7\x85\xDAXYZ $\xA0\x84\xB6\xCFcurv\xCB
\xC9c\x92\bk\v\xF6?Q\x1B4!\xF1)\x902;\x92FQw]\xEDkpz\x89\xB1\x9A|\xACi\xBF}\xD3\xC3\xE90\xFF\xFF\xFF\xDB\x84\b\b\x07\x07
-`)],-1),Oe=s("hr",null,null,-1),Qe=s("h2",{id:"import-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#import-a-file"},"#"),e(" Import a File")],-1),Le=s("p",null,"Import a file from the web",-1),Xe=s("h3",{id:"query-parameters-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-3"},"#"),e(" Query Parameters")],-1),Be=e("Supports all "),Ue=e("global query parameters"),Ye=e("."),Ge=s("h3",{id:"request-body",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body"},"#"),e(" Request Body")],-1),Me=s("p",null,[s("code",null,"url"),e(),s("strong",null,"Required"),s("br"),e(" The URL to download the file from.")],-1),ze=s("p",null,[s("code",null,"data"),s("br"),e(" Any of "),s("a",{href:"#the-file-object"},"the file object"),e("\u2019s properties.")],-1),Ne=s("h3",{id:"returns-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-3"},"#"),e(" Returns")],-1),Ze=s("p",null,[e("Returns the "),s("a",{href:"#the-file-object"},"file object"),e(" for the imported file.")],-1),He=s("h3",{id:"rest-api-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-2"},"#"),e(" REST API")],-1),We=s("pre",null,[s("code",{class:"language-txt"},`POST /files/import
-`)],-1),Ke=s("h5",{id:"example-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-4"},"#"),e(" Example")],-1),Je=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// POST /files/import"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"url"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Example"'),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Ve=s("h3",{id:"graphql-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-2"},"#"),e(" GraphQL")],-1),$e=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),st=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	import_file(url:`),s("span",{class:"hljs-type"}," String"),e(`!, data: create_directus_files_input!): directus_files
-}
-`)])],-1),et=s("h5",{id:"example-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-5"},"#"),e(" Example")],-1),tt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	import_file(url: `),s("span",{class:"hljs-string"},'"https://source.unsplash.com/random"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"Example"'),e(` }) {
-		id
-	}
-}
-`)])],-1),at=s("hr",null,null,-1),nt=s("h2",{id:"update-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-a-file"},"#"),e(" Update a File")],-1),lt=s("p",null,"Update an existing file, and/or replace it\u2019s file contents.",-1),ot=s("h3",{id:"query-parameters-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-4"},"#"),e(" Query Parameters")],-1),it=e("Supports all "),ct=e("global query parameters"),rt=e("."),ht=s("h3",{id:"request-body-1",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-1"},"#"),e(" Request Body")],-1),dt=s("p",null,[e("You can either submit a JSON object consisting of a partial "),s("a",{href:"#the-file-object"},"file object"),e(" to update the file meta, or send a multipart/form-data request to replace the file contents on disk. See "),s("a",{href:"#upload-a-file"},"Upload a File"),e(" for more information on the structure of this "),s("code",null,"multipart/form-data"),e(" request.")],-1),ut=s("h3",{id:"returns-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-4"},"#"),e(" Returns")],-1),pt=s("p",null,[e("Returns the "),s("a",{href:"#the-file-object"},"file object"),e(" for the updated file.")],-1),_t=s("h3",{id:"rest-api-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-3"},"#"),e(" REST API")],-1),ft=s("pre",null,[s("code",{class:"language-txt"},`PATCH /files/:id
-`)],-1),mt=s("h5",{id:"example-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-6"},"#"),e(" Example")],-1),gt=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"title"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-string"},'"Example"'),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),jt=s("h3",{id:"graphql-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-3"},"#"),e(" GraphQL")],-1),bt=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),yt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_files_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!, data: update_directus_files_input!): directus_files
-}
-`)])],-1),xt=s("h5",{id:"example-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-7"},"#"),e(" Example")],-1),qt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_files_item(id: `),s("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),e(", data: { title: "),s("span",{class:"hljs-string"},'"Example"'),e(` }) {
-		id
-		title
-	}
-}
-`)])],-1),wt=s("hr",null,null,-1),vt=s("h2",{id:"update-multiple-files",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#update-multiple-files"},"#"),e(" Update Multiple Files")],-1),Tt=s("p",null,"Update multiple files at the same time.",-1),kt=s("h3",{id:"query-parameters-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-5"},"#"),e(" Query Parameters")],-1),Et=e("Supports all "),Rt=e("global query parameters"),At=e("."),St=s("h3",{id:"request-body-2",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-2"},"#"),e(" Request Body")],-1),Dt=s("p",null,[s("code",null,"keys"),e(),s("strong",null,"Required"),s("br"),e(" Array of primary keys of the files you\u2019d like to update.")],-1),Pt=s("p",null,[s("code",null,"data"),e(),s("strong",null,"Required"),s("br"),e(" Any of "),s("a",{href:"#the-file-object"},"the file object"),e("\u2019s properties.")],-1),It=s("h3",{id:"returns-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-5"},"#"),e(" Returns")],-1),Ct=s("p",null,[e("Returns the "),s("a",{href:"#the-file-object"},"file objects"),e(" for the updated files.")],-1),Ft=s("h3",{id:"rest-api-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-4"},"#"),e(" REST API")],-1),Ot=s("pre",null,[s("code",{class:"language-txt"},`PATCH /files
-`)],-1),Qt=s("h5",{id:"example-8",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-8"},"#"),e(" Example")],-1),Lt=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// PATCH /files"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"{"),e(`
-	`),s("span",{class:"hljs-attr"},'"keys"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s("span",{class:"hljs-punctuation"},"]"),s("span",{class:"hljs-punctuation"},","),e(`
-	`),s("span",{class:"hljs-attr"},'"data"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"{"),e(`
-		`),s("span",{class:"hljs-attr"},'"tags"'),s("span",{class:"hljs-punctuation"},":"),e(),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"cities"'),s("span",{class:"hljs-punctuation"},"]"),e(`
-	`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`),s("span",{class:"hljs-punctuation"},"}"),e(`
-`)])],-1),Xt=s("h3",{id:"graphql-4",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-4"},"#"),e(" GraphQL")],-1),Bt=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),Ut=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	update_files_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!, data: update_directus_files!): [directus_files]
-}
-`)])],-1),Yt=s("h5",{id:"example-9",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-9"},"#"),e(" Example")],-1),Gt=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	update_files_items(
-		ids: [`),s("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),e(", "),s("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),e(`]
-		data: { tags: [`),s("span",{class:"hljs-string"},'"cities"'),e(`] }
-	)
-}
-`)])],-1),Mt=s("hr",null,null,-1),zt=s("h2",{id:"delete-a-file",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-a-file"},"#"),e(" Delete a File")],-1),Nt=s("p",null,"Delete an existing file.",-1),Zt=s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"This will also delete the file from disk.")],-1),Ht=s("h3",{id:"query-parameters-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#query-parameters-6"},"#"),e(" Query Parameters")],-1),Wt=e("Supports all "),Kt=e("global query parameters"),Jt=e("."),Vt=s("h3",{id:"returns-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-6"},"#"),e(" Returns")],-1),$t=s("p",null,"Empty response.",-1),sa=s("h3",{id:"rest-api-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-5"},"#"),e(" REST API")],-1),ea=s("pre",null,[s("code",{class:"language-txt"},`DELETE /files/:id
-`)],-1),ta=s("h5",{id:"example-10",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-10"},"#"),e(" Example")],-1),aa=s("pre",null,[s("code",{class:"language-txt"},`DELETE /files/0fca80c4-d61c-4404-9fd7-6ba86b64154d
-`)],-1),na=s("h3",{id:"graphql-5",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-5"},"#"),e(" GraphQL")],-1),la=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),oa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_files_item(id:`),s("span",{class:"hljs-literal"}," ID"),e(`!): delete_one
-}
-`)])],-1),ia=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_files_item(id: `),s("span",{class:"hljs-string"},'"0fca80c4-d61c-4404-9fd7-6ba86b64154d"'),e(`) {
-		id
-	}
-}
-`)])],-1),ca=s("hr",null,null,-1),ra=s("h2",{id:"delete-multiple-files",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#delete-multiple-files"},"#"),e(" Delete Multiple Files")],-1),ha=s("p",null,"Delete multiple files at once.",-1),da=s("div",{class:"danger hint"},[s("div",{class:"hint-title"},"Destructive"),s("p",null,"This will also delete the files from disk.")],-1),ua=s("h3",{id:"request-body-3",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#request-body-3"},"#"),e(" Request Body")],-1),pa=s("p",null,"Array of file primary keys",-1),_a=s("h3",{id:"returns-7",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#returns-7"},"#"),e(" Returns")],-1),fa=s("p",null,"Empty response.",-1),ma=s("h3",{id:"rest-api-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#rest-api-6"},"#"),e(" REST API")],-1),ga=s("pre",null,[s("code",{class:"language-txt"},`DELETE /files
-`)],-1),ja=s("h5",{id:"example-11",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-11"},"#"),e(" Example")],-1),ba=s("pre",null,[s("code",{class:"language-json"},[s("span",{class:"hljs-comment"},"// DELETE /files"),e(`
-
-`),s("span",{class:"hljs-punctuation"},"["),s("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),s("span",{class:"hljs-punctuation"},","),e(),s("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),s("span",{class:"hljs-punctuation"},"]"),e(`
-`)])],-1),ya=s("h3",{id:"graphql-6",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#graphql-6"},"#"),e(" GraphQL")],-1),xa=s("pre",null,[s("code",{class:"language-txt"},`POST /graphql/system
-`)],-1),qa=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"type"),s("span",{class:"hljs-type"}," Mutation"),e(` {
-	delete_files_items(ids: `),s("span",{class:"hljs-literal"},"[ID"),e(`!]!): delete_many
-}
-`)])],-1),wa=s("h5",{id:"example-12",tabindex:"-1"},[s("a",{class:"header-anchor",href:"#example-12"},"#"),e(" Example")],-1),va=s("pre",null,[s("code",{class:"language-graphql"},[s("span",{class:"hljs-keyword"},"mutation"),e(` {
-	delete_files_items(ids: [`),s("span",{class:"hljs-string"},'"d17c10aa-0bad-4864-9296-84f522c753e5"'),e(", "),s("span",{class:"hljs-string"},'"b6123925-2fc0-4a30-9d86-863eafc0a6e7"'),e(`]) {
-		ids
-	}
-}
-`)])],-1),Aa="Accessing Files",Sa=!1,Da="REST and GraphQL API documentation for file access and management in Directus.",Pa="10 min read",Ia="page-reference",Ca={name:"files",setup(Ta,{expose:i}){const l={title:"Accessing Files",modularExtension:!1,description:"REST and GraphQL API documentation for file access and management in Directus.",readTime:"10 min read",pageClass:"page-reference"};return i({frontmatter:l}),(ka,Ea)=>{const a=o("router-link"),c=o("docs-wrapper");return r(),h(c,{frontmatter:l},{default:t(()=>[s("div",d,[u,p,_,f,m,g,j,b,y,x,q,w,v,T,k,E,R,s("ul",null,[s("li",null,[A,S,D,P,n(a,{to:"/docs/configuration/project-settings#files-thumbnails"},{default:t(()=>[I]),_:1}),C])]),F,O,Q,L,X,B,U,Y,G,M,z,N,Z,H,W,K,J,V,$,ss,es,ts,s("p",null,[as,ns,ls,os,is,n(a,{to:"/docs/reference/system/folders"},{default:t(()=>[cs]),_:1}),rs]),s("p",null,[hs,ds,us,ps,_s,n(a,{to:"/docs/reference/system/users"},{default:t(()=>[fs]),_:1}),ms]),gs,s("p",null,[js,bs,ys,xs,qs,n(a,{to:"/docs/reference/system/users"},{default:t(()=>[ws]),_:1}),vs]),Ts,ks,Es,Rs,As,Ss,Ds,Ps,Is,Cs,Fs,Os,Qs,s("p",null,[Ls,n(a,{to:"/docs/reference/query"},{default:t(()=>[Xs]),_:1}),Bs]),Us,s("p",null,[Ys,n(a,{to:"/docs/reference/query#limit"},{default:t(()=>[Gs]),_:1}),Ms,zs,Ns]),Zs,Hs,s("p",null,[n(a,{to:"/docs/reference/introduction#search-http-method"},{default:t(()=>[Ws]),_:1})]),Ks,Js,Vs,$s,se,ee,te,ae,ne,s("p",null,[le,n(a,{to:"/docs/reference/query"},{default:t(()=>[oe]),_:1}),ie]),ce,re,he,de,ue,pe,_e,fe,me,ge,je,be,ye,xe,qe,we,ve,Te,ke,Ee,Re,s("p",null,[Ae,n(a,{to:"/docs/reference/query"},{default:t(()=>[Se]),_:1}),De]),Pe,Ie,Ce,Fe,Oe,Qe,Le,Xe,s("p",null,[Be,n(a,{to:"/docs/reference/query"},{default:t(()=>[Ue]),_:1}),Ye]),Ge,Me,ze,Ne,Ze,He,We,Ke,Je,Ve,$e,st,et,tt,at,nt,lt,ot,s("p",null,[it,n(a,{to:"/docs/reference/query"},{default:t(()=>[ct]),_:1}),rt]),ht,dt,ut,pt,_t,ft,mt,gt,jt,bt,yt,xt,qt,wt,vt,Tt,kt,s("p",null,[Et,n(a,{to:"/docs/reference/query"},{default:t(()=>[Rt]),_:1}),At]),St,Dt,Pt,It,Ct,Ft,Ot,Qt,Lt,Xt,Bt,Ut,Yt,Gt,Mt,zt,Nt,Zt,Ht,s("p",null,[Wt,n(a,{to:"/docs/reference/query"},{default:t(()=>[Kt]),_:1}),Jt]),Vt,$t,sa,ea,ta,aa,na,la,oa,ia,ca,ra,ha,da,ua,pa,_a,fa,ma,ga,ja,ba,ya,xa,qa,wa,va])]),_:1})}}};export{Ca as default,Da as description,Sa as modularExtension,Ia as pageClass,Pa as readTime,Aa as title};

package/dist/assets/filter-rules.c59724be.js

@@ -1,85 +0,0 @@
-import{a as l,o as c,b as i,w as a,l as t,e as r,E as n}from"./runtime-core.esm-bundler.32cac88a.js";const p={class:"markdown-body"},h=t("blockquote",null,[t("p",null,[n("Permissions, validation, and the API\u2019s "),t("code",null,"filter"),n(" parameter all rely on a specific JSON structure to define their rules. This page describes the syntax for creating flat, relational, or complex filter rules.")])],-1),d=t("h2",{id:"syntax",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#syntax"},"#"),n(" Syntax")],-1),j=t("ul",null,[t("li",null,[t("strong",null,"Field"),n(" \u2014 Any valid root field, "),t("a",{href:"#relational"},"relational field"),n(", or "),t("a",{href:"#logical-operators"},"logical operator")]),t("li",null,[t("strong",null,"Operator"),n(" \u2014 Any valid "),t("a",{href:"#filter-operators"},"filter operator")]),t("li",null,[t("strong",null,"Value"),n(" \u2014 Any valid static value, or "),t("a",{href:"#dynamic-variables"},"dynamic variable")])],-1),_=t("pre",null,[t("code",null,`{
-	<field>: {
-		<operator>: <value>
-	}
-}
-`)],-1),f=t("h3",{id:"examples",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#examples"},"#"),n(" Examples")],-1),m=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"title"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"_contains"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"Directus"'),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),g=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"owner"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),b=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"datetime"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"_lte"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"$NOW"'),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),y=t("h2",{id:"filter-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#filter-operators"},"#"),n(" Filter Operators")],-1),v=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,[n("Operator Title "),t("em",null,"(in app)")]),t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,"Equals"),t("td",null,[t("code",null,"_eq")]),t("td",null,"Equal to")]),t("tr",null,[t("td",null,"Doesn\u2019t equal"),t("td",null,[t("code",null,"_neq")]),t("td",null,"Not equal to")]),t("tr",null,[t("td",null,"Less than"),t("td",null,[t("code",null,"_lt")]),t("td",null,"Less than")]),t("tr",null,[t("td",null,"Less than or equal to"),t("td",null,[t("code",null,"_lte")]),t("td",null,"Less than or equal to")]),t("tr",null,[t("td",null,"Greater than"),t("td",null,[t("code",null,"_gt")]),t("td",null,"Greater than")]),t("tr",null,[t("td",null,"Greater than or equal to"),t("td",null,[t("code",null,"_gte")]),t("td",null,"Greater than or equal to")]),t("tr",null,[t("td",null,"Is one of"),t("td",null,[t("code",null,"_in")]),t("td",null,"Matches any of the values")]),t("tr",null,[t("td",null,"Is not one of"),t("td",null,[t("code",null,"_nin")]),t("td",null,"Doesn\u2019t match any of the values")]),t("tr",null,[t("td",null,"Is null"),t("td",null,[t("code",null,"_null")]),t("td",null,[n("Is "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Isn\u2019t null"),t("td",null,[t("code",null,"_nnull")]),t("td",null,[n("Is not "),t("code",null,"null")])]),t("tr",null,[t("td",null,"Contains"),t("td",null,[t("code",null,"_contains")]),t("td",null,"Contains the substring")]),t("tr",null,[t("td",null,"Doesn\u2019t contain"),t("td",null,[t("code",null,"_ncontains")]),t("td",null,"Doesn\u2019t contain the substring")]),t("tr",null,[t("td",null,"Starts with"),t("td",null,[t("code",null,"_starts_with")]),t("td",null,"Starts with")]),t("tr",null,[t("td",null,"Doesn\u2019t start with"),t("td",null,[t("code",null,"_nstarts_with")]),t("td",null,"Doesn\u2019t start with")]),t("tr",null,[t("td",null,"Ends with"),t("td",null,[t("code",null,"_ends_with")]),t("td",null,"Ends with")]),t("tr",null,[t("td",null,"Doesn\u2019t end with"),t("td",null,[t("code",null,"_nends_with")]),t("td",null,"Doesn\u2019t end with")]),t("tr",null,[t("td",null,"Is between"),t("td",null,[t("code",null,"_between")]),t("td",null,"Is between two values (inclusive)")]),t("tr",null,[t("td",null,"Isn\u2019t between"),t("td",null,[t("code",null,"_nbetween")]),t("td",null,"Is not between two values (inclusive)")]),t("tr",null,[t("td",null,"Is empty"),t("td",null,[t("code",null,"_empty")]),t("td",null,[n("Is empty ("),t("code",null,"null"),n(" or falsy)")])]),t("tr",null,[t("td",null,"Isn\u2019t empty"),t("td",null,[t("code",null,"_nempty")]),t("td",null,[n("Is not empty ("),t("code",null,"null"),n(" or falsy)")])]),t("tr",null,[t("td",null,"Intersects"),t("td",null,[t("code",null,"_intersects"),n(),t("sup",null,"[1]")]),t("td",null,"Value intersects a given point")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect"),t("td",null,[t("code",null,"_nintersects"),n(),t("sup",null,"[1]")]),t("td",null,"Value does not intersect a given point")]),t("tr",null,[t("td",null,"Intersects Bounding box"),t("td",null,[t("code",null,"_intersects_bbox"),n(),t("sup",null,"[1]")]),t("td",null,"Value is in a bounding box")]),t("tr",null,[t("td",null,"Doesn\u2019t intersect bounding box"),t("td",null,[t("code",null,"_nintersects_bbox"),n(),t("sup",null,"[1]")]),t("td",null,"Value is not in a bounding box")])])],-1),R=t("p",null,[n("The following operator has no Title on the Filter Interface as it is "),t("strong",null,"only available in validation permissions"),n(":")],-1),w=t("table",null,[t("thead",null,[t("tr",null,[t("th",null,"Operator"),t("th",null,"Description")])]),t("tbody",null,[t("tr",null,[t("td",null,[t("code",null,"_regex"),n(),t("sup",null,"[2]")]),t("td",null,"Field has to match regex")])])],-1),x=t("sup",null,"[1]",-1),E=n(" Only available on Geometry types.\\ "),T=t("sup",null,"[2]",-1),I=n(' JavaScript "flavor" regex. Make sure to escape backslashes. '),N=t("h2",{id:"relational",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#relational"},"#"),n(" Relational")],-1),O=t("p",null,[n("You can target related values by nesting field names. For example, if you have a relational Many-to-One "),t("code",null,"author"),n(" field, you can set a rule for the "),t("code",null,"author.name"),n(" field using the following syntax.")],-1),q=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"author"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"Rijk van Zanten"'),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),D=t("p",null,[n("When using M2M relationships, a junction table will be created and the filter applies to the junction table itself. For example, if you have a "),t("code",null,"books"),n(" collection, with a M2M relationship to authors of each book, the junction collection will probably be named "),t("code",null,"books_authors"),n(" and have 3 fields : "),t("code",null,"id"),n(", "),t("code",null,"books_id"),n(" and "),t("code",null,"authors_id"),n(". To filter specific books depending on their authors you must go through the junction table and the "),t("code",null,"authors_id"),n(" field :")],-1),k=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"authors"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"authors_id"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-				`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"Rijk van Zanten"'),n(`
-			`),t("span",{class:"hljs-punctuation"},"}"),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),U=t("h2",{id:"logical-operators",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#logical-operators"},"#"),n(" Logical Operators")],-1),F=t("p",null,[n("You can nest or group multiple rules using the "),t("code",null,"_and"),n(" or "),t("code",null,"_or"),n(" logical operators. Each logical operator holds an array of Filter Rules, allowing for more complex filtering. Also note in the example that Logical Operators can be sub-nested into Logical Operators. However, they cannot be sub-nested into Filter Rules.")],-1),S=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"_or"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
-		`),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"_and"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
-				`),t("span",{class:"hljs-punctuation"},"{"),n(`
-					`),t("span",{class:"hljs-attr"},'"user_created"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-						`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),n(`
-					`),t("span",{class:"hljs-punctuation"},"}"),n(`
-				`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),n(`
-				`),t("span",{class:"hljs-punctuation"},"{"),n(`
-					`),t("span",{class:"hljs-attr"},'"status"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-						`),t("span",{class:"hljs-attr"},'"_in"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),t("span",{class:"hljs-string"},'"published"'),t("span",{class:"hljs-punctuation"},","),n(),t("span",{class:"hljs-string"},'"draft"'),t("span",{class:"hljs-punctuation"},"]"),n(`
-					`),t("span",{class:"hljs-punctuation"},"}"),n(`
-				`),t("span",{class:"hljs-punctuation"},"}"),n(`
-			`),t("span",{class:"hljs-punctuation"},"]"),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),n(`
-		`),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"_and"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),n(`
-				`),t("span",{class:"hljs-punctuation"},"{"),n(`
-					`),t("span",{class:"hljs-attr"},'"user_created"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-						`),t("span",{class:"hljs-attr"},'"_neq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"$CURRENT_USER"'),n(`
-					`),t("span",{class:"hljs-punctuation"},"}"),n(`
-				`),t("span",{class:"hljs-punctuation"},"}"),t("span",{class:"hljs-punctuation"},","),n(`
-				`),t("span",{class:"hljs-punctuation"},"{"),n(`
-					`),t("span",{class:"hljs-attr"},'"status"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-						`),t("span",{class:"hljs-attr"},'"_in"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"["),t("span",{class:"hljs-string"},'"published"'),t("span",{class:"hljs-punctuation"},"]"),n(`
-					`),t("span",{class:"hljs-punctuation"},"}"),n(`
-				`),t("span",{class:"hljs-punctuation"},"}"),n(`
-			`),t("span",{class:"hljs-punctuation"},"]"),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),n(`
-	`),t("span",{class:"hljs-punctuation"},"]"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),$=t("h3",{id:"some-vs-none-in-one-to-many",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#some-vs-none-in-one-to-many"},"#"),n(" Some vs None in One-to-Many")],-1),C=t("p",null,"When applying filters to a one-to-many field, Directus will default to a \u201Csome\u201D search, for example in:",-1),L=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"categories"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"Recipe"'),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),V=t("p",null,[n("the top level parent will be returned if "),t("em",null,"one of"),n(" the categories has the name "),t("code",null,"Recipe"),n(". This behavior can be overridden by using the explicit "),t("code",null,"_some"),n(" and "),t("code",null,"_none"),n(" operators, for example:")],-1),M=t("pre",null,[t("code",{class:"language-json"},[t("span",{class:"hljs-punctuation"},"{"),n(`
-	`),t("span",{class:"hljs-attr"},'"categories"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-		`),t("span",{class:"hljs-attr"},'"_none"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-			`),t("span",{class:"hljs-attr"},'"name"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-punctuation"},"{"),n(`
-				`),t("span",{class:"hljs-attr"},'"_eq"'),t("span",{class:"hljs-punctuation"},":"),n(),t("span",{class:"hljs-string"},'"Recipe"'),n(`
-			`),t("span",{class:"hljs-punctuation"},"}"),n(`
-		`),t("span",{class:"hljs-punctuation"},"}"),n(`
-	`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`),t("span",{class:"hljs-punctuation"},"}"),n(`
-`)])],-1),W=t("p",null,"will fetch all parent items that don\u2019t have the category \u201CRecipe\u201D",-1),A=t("h2",{id:"dynamic-variables",tabindex:"-1"},[t("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),n(" Dynamic Variables")],-1),G=t("p",null,[n("In addition to static values, you can also filter against "),t("em",null,"dynamic"),n(" values using the following variables.")],-1),P=t("ul",null,[t("li",null,[t("code",null,"$CURRENT_USER"),n(" \u2014 The primary key of the currently authenticated user")]),t("li",null,[t("code",null,"$CURRENT_ROLE"),n(" \u2014 The primary key of the role for the currently authenticated user")]),t("li",null,[t("code",null,"$NOW"),n(" \u2014 The current timestamp")]),t("li",null,[t("code",null,"$NOW(<adjustment>)"),n(" - The current timestamp plus/minus a given distance, for example "),t("code",null,"$NOW(-1 year)"),n(", "),t("code",null,"$NOW(+2 hours)")])],-1),B={class:"tip hint"},Y=t("div",{class:"hint-title"},"Functions",-1),J=n("You can also use "),Q=n("Function Parameters"),Z=n(" when building Filters."),z=t("div",{class:"tip hint"},[t("div",{class:"hint-title"},"Nested User / Role variables in Permissions"),t("p",null,[n("When configuring permissions, "),t("code",null,"$CURRENT_USER"),n(" and "),t("code",null,"$CURRENT_ROLE"),n(" allow you to specify any (nested) field under the current user/role as well as the root ID. For example: "),t("code",null,"$CURRENT_ROLE.name"),n(" or "),t("code",null,"$CURRENT_USER.avatar.filesize"),n(". This includes custom fields that were added to the directus_users/directus_roles tables.")]),t("p",null,"Note: This feature is only available for permissions, validation, and presets. Regular filters and conditional fields currently only support the root ID.")],-1),nt="Filter Rules",st=!1,lt="REST and GraphQL API documentation for filter rules in Directus.",at="5 min read",et={name:"filter-rules",setup(H,{expose:e}){const s={title:"Filter Rules",modularExtension:!1,description:"REST and GraphQL API documentation for filter rules in Directus.",readTime:"5 min read"};return e({frontmatter:s}),(K,X)=>{const o=l("router-link"),u=l("docs-wrapper");return c(),i(u,{frontmatter:s},{default:a(()=>[t("div",p,[h,d,j,_,f,m,g,b,y,v,R,w,x,E,T,I,N,O,q,D,k,U,F,S,$,C,L,V,M,W,A,G,P,t("div",B,[Y,t("p",null,[J,r(o,{to:"/docs/reference/query#functions"},{default:a(()=>[Q]),_:1}),Z])]),z])]),_:1})}}};export{et as default,lt as description,st as modularExtension,at as readTime,nt as title};

package/dist/assets/filters.4055be70.js

@@ -1 +0,0 @@
-import{a as n,o as d,b as c,w as o,l as e,e as i,E as t}from"./runtime-core.esm-bundler.32cac88a.js";const u={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results, restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.")],-1),_=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filters-20220303A.webp",alt:"Filters"})],-1),p={class:"warning hint"},f=e("div",{class:"hint-title"},"There Are Two Filters Documents",-1),m=t("This page is a non-technical guide to using Filters. For more technical info, see "),g=t("Filter-Rules"),y=t("."),b=e("h2",{id:"how-it-works",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#how-it-works"},"#"),t(" How it Works")],-1),w={class:"tip hint"},F=e("div",{class:"hint-title"},"Assumed Knowledge",-1),v=t("Filters are intuitive to use, but get quite nuanced as complexity increases. In order to use Filters effectively, you will need to understand the Field "),C=t("(aka "),A=t("data model"),k=t(")"),x=t(" being filtered as well as any relevant "),R=t("Users, Roles and Permissions"),O=t("."),I=t("A basic filter is composed of 3 parts: A "),D=e("strong",null,"Field",-1),N=t(" from the Collection being Filtered, a logical "),G=t("Operator"),T=t(", and some specified "),U=e("strong",null,"Value",-1),E=t(" to filter for within each Item\u2019s Field."),V=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/how-filters-work-20220303A.mp4",type:"video/mp4"})],-1),H=e("ol",{start:"2"},[e("li",null,[t("Click "),e("span",{mi:"",icon:""},"filter_list"),t(" or "),e("strong",null,"\u201CAdd Filter\u201D"),t(".")]),e("li",null,"Select the Field to filter by."),e("li",null,"Select the Operator as desired."),e("li",null,"Define the Value to filter for.")],-1),S=e("p",null,[t("From here, you can set multiple Filters at once, filter by "),e("a",{href:"#filtering-by-related-collections"},"Fields in related Collections"),t(", set Values with "),e("a",{href:"#dynamic-variables"},"Dynamic Variables"),t(", as well as apply "),e("a",{href:"#and-or-groups"},"AND/OR Groups"),t(".")],-1),W={class:"tip hint"},B=e("div",{class:"hint-title"},"Operators",-1),$=t("The Field type will determine the kinds of Operators that can be used on it. In fact, some Fields cannot be filtered at all (read more in "),j=e("a",{href:"#unfilterable-fields"},"Unfilterable Fields",-1),z=t("). Once a Field is selected, the permitted operators will automatically display. An exhaustive list of Operators and what they do can be found in the more technical "),P=t("Filter Rules"),q=t(" document."),L=e("h2",{id:"and%2For-groups",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#and%2For-groups"},"#"),t(" AND/OR Groups")],-1),Y=e("p",null,[e("code",null,"AND"),t(" Groups give the option to filter for Items that meet "),e("em",null,"all of several criteria"),t(". On the other hand, "),e("code",null,"OR"),t(" Groups filter for Items that meet "),e("em",null,"any one of several criteria"),t(".")],-1),K=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/and-or-groups-20220303A.webp",alt:"AND/OR Groups"})],-1),M=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click \u201CAnd/OR Group\u201D at the very top of the dropdown menu."),e("li",null,[t("Click the AND/OR text to toggle: "),e("ul",null,[e("li",null,[e("code",null,"AND"),t(" \u2013 Selects Items that meet every single criteria.")]),e("li",null,[e("code",null,"OR"),t(" \u2013 Selects Items that meet one of several criteria.")])])]),e("li",null,"Click \u201CAdd Filter\u201D again."),e("li",null,"Configure the Field, Operator, and Value as desired."),e("li",null,[t("Click and hold "),e("span",{mi:"",icon:""},"drag_indicator"),t(" to drag a Filter and nest it under an AND/OR Group.")])],-1),J=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Why do we need AND Groups?"),e("p",null,[t("Filters actually default to "),e("code",null,"AND"),t(" Group behavior automatically. However, when Filters are nested inside of an OR Group, they of course switch to "),e("code",null,"OR"),t(" Group behavior. So an AND Group is necessary in cases where you want to meet multiple conditions inside of OR Groups.")])],-1),Q=e("h2",{id:"dynamic-variables",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#dynamic-variables"},"#"),t(" Dynamic Variables")],-1),X=e("p",null,"The following video shows how to filter for Blog posts written within the past 60 days.",-1),Z=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/dynamic-variables-20220307A.mp4",type:"video/mp4"})],-1),ee=t("The following Dynamic Variables are built into Directus to make Filtering easier: "),te=e("code",null,"$CURRENT_USER",-1),oe=t(", "),se=e("code",null,"$CURRENT_ROLE",-1),ie=t(", "),le=e("code",null,"$NOW",-1),ne=t(" and "),re=e("code",null,"$NOW(<adjustment>)",-1),ae=t(". For more information, please see the Dynamic Variables section in "),de=t("Filter Rules"),ce=t("."),ue=e("h2",{id:"filtering-by-related-collections",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#filtering-by-related-collections"},"#"),t(" Filtering by Related Collections")],-1),he=e("p",null,[t("You may need to run filters on one Collection "),e("em",null,"based on information in another related Collection"),t(". Here are a few examples of when that might happen:")],-1),_e=e("ul",null,[e("li",null,[t("Book authors that also wrote screenplays (filters "),e("code",null,"authors"),t(", uses "),e("code",null,"screenplays"),t(").")]),e("li",null,[t("Products with a 5 star customer review (filters "),e("code",null,"products"),t(", uses "),e("code",null,"reviews"),t(").")]),e("li",null,[t("Accounts with active user login within the last 12 months (filters "),e("code",null,"accounts"),t(", uses "),e("code",null,"logins"),t(").")])],-1),pe=e("p",null,[t("This can span across any number of relationally linked Collections. For example, you could filter for customers that bought rock songs, where the "),e("code",null,"customers"),t(" and "),e("code",null,"genres"),t(" Collections are linked by "),e("code",null,"customers"),t(" -> "),e("code",null,"invoices"),t(" -> "),e("code",null,"invoice-items"),t(" -> "),e("code",null,"tracks"),t(" -> "),e("code",null,"genres"),t(".")],-1),fe=t("You will notice a "),me=e("span",{mi:"",icon:""},"chevron_right",-1),ge=t(" icon beside relational Fields. When you click on any "),ye=t("Alias"),be=t(" Field, all the Fields for that associated Collection pop down. If you select one of these Fields, you can run Filters on the current Collection by Field values in a related Collection."),we=e("p",null,"Here are step-by-step instructions on how to filter by Fields in other Collections:",-1),Fe=e("video",{autoplay:"",playsinline:"",muted:"",loop:"",controls:"",title:"How Filters Work"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/filtering-by-related-collections-20220303A.mp4",type:"video/mp4"})],-1),ve=e("ol",null,[e("li",null,"Click \u201CAdd Filter\u201D."),e("li",null,"Click the desired relational Field. This will pop down and display the related Collection Fields."),e("li",null,"Select a Field from this related Collection."),e("li",null,"Set the Operator and Value as desired.")],-1),Ce=e("h2",{id:"unfilterable-fields",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#unfilterable-fields"},"#"),t(" Unfilterable Fields")],-1),Ae=e("p",null,[e("img",{src:"https://cdn.directus.io/docs/v9/app-guide/filters/filters-20220303A/unfilterable-fields-20220303A.webp",alt:"Unfilterable Fields"})],-1),ke=e("p",null,[t("Not all Fields can be filtered. As seen above in "),e("a",{href:"#filtering-by-related-collections"},"Filtering by Related Collections"),t(", Alias Fields cannot be filtered; they instead provide a dropdown menu to access Fields from a related Collection. Additionally, the \u201CPresentation\u201D and \u201CGroup\u201D Fields cannot be filtered at all and will not appear as an option in Filters.")],-1),xe=e("h2",{id:"extensibility-options",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#extensibility-options"},"#"),t(" Extensibility Options")],-1),Re=e("p",null,"Directus Core is completely open-source, modular and extensible. Extensions allow you to expand or modify any part of Directus to fit your needs. Here are some great resources to get started down that track.",-1),Oe=t("Extensions > Introduction"),Ie=t("Extensions > Creating Extensions"),De=t("Contributing > Introduction"),Ne=t("Contributing > Codebase Overview"),Ge=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Accelerated Development"),e("p",null,[t("Working on an enterprise project and looking to outsource or financially sponsor the development of a Shares extension? Contact "),e("a",{href:"https://directus.io/contact",target:"_blank",rel:"noopener noreferrer"},"our team")])],-1),Te=e("h2",{id:"more-help",tabindex:"-1"},[e("a",{class:"header-anchor",href:"#more-help"},"#"),t(" More Help")],-1),Ue=e("p",null,[t("Looking for technical support for your non-enterprise project? Chat with thousands of engineers within our growing "),e("a",{href:"https://discord.com/invite/directus",target:"_blank",rel:"noopener noreferrer"},"Community on Discord")],-1),We="Filters",Be=!1,$e="Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",je="5 min read",ze={name:"filters",setup(Ee,{expose:r}){const l={title:"Filters",modularExtension:!1,description:"Filters allow you to conditionally select Items from a Collection. Use-cases include customizing Item search results restricting Item access permissions for specific Users or Roles, building dashboard analytics with the Insights module, and more.",readTime:"5 min read"};return r({frontmatter:l}),(Ve,He)=>{const s=n("router-link"),a=n("docs-wrapper");return d(),c(a,{frontmatter:l},{default:o(()=>[e("div",u,[h,_,e("div",p,[f,e("p",null,[m,i(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[g]),_:1}),y])]),b,e("div",w,[F,e("p",null,[v,e("em",null,[C,i(s,{to:"/docs/configuration/data-model"},{default:o(()=>[A]),_:1}),k]),x,i(s,{to:"/docs/configuration/users-roles-permissions.md"},{default:o(()=>[R]),_:1}),O])]),e("p",null,[I,D,N,i(s,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[G]),_:1}),T,U,E]),V,H,S,e("div",W,[B,e("p",null,[$,j,z,i(s,{to:"/docs/reference/filter-rules#filter-operators"},{default:o(()=>[P]),_:1}),q])]),L,Y,K,M,J,Q,X,Z,e("p",null,[ee,te,oe,se,ie,le,ne,re,ae,i(s,{to:"/docs/reference/filter-rules"},{default:o(()=>[de]),_:1}),ce]),ue,he,_e,pe,e("p",null,[fe,me,ge,i(s,{to:"/docs/getting-started/glossary#alias"},{default:o(()=>[ye]),_:1}),be]),we,Fe,ve,Ce,Ae,ke,xe,Re,e("ul",null,[e("li",null,[i(s,{to:"/docs/extensions/introduction"},{default:o(()=>[Oe]),_:1})]),e("li",null,[i(s,{to:"/docs/extensions/creating-extensions"},{default:o(()=>[Ie]),_:1})]),e("li",null,[i(s,{to:"/docs/contributing/introduction"},{default:o(()=>[De]),_:1})]),e("li",null,[i(s,{to:"/docs/contributing/codebase-overview"},{default:o(()=>[Ne]),_:1})])]),Ge,Te,Ue])]),_:1})}}};export{ze as default,$e as description,Be as modularExtension,je as readTime,We as title};