@directus/app 9.13.0 → 9.14.0

package/dist/assets/hooks.c8418066.js

@@ -1,60 +0,0 @@
-import{a as o,o as c,b as a,w as u,g as l,B as e}from"./runtime-core.esm-bundler.e6808e6c.js";const r=l("div",{class:"markdown-body"},[l("blockquote",null,[l("p",null,"Custom API Hooks allow running custom logic when a specified event occurs within your project. There are different types of events to choose from.")]),l("h2",{id:"extension-entrypoint"},[e("Extension Entrypoint "),l("a",{class:"header-anchor",href:"#extension-entrypoint"},"#")]),l("p",null,[e("The entrypoint of your hook is the "),l("code",null,"index"),e(" file inside the "),l("code",null,"src/"),e(" folder of your extension package. It exports a register function to register one or more event listeners.")]),l("p",null,"Example of an entrypoint:"),l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-keyword"},"export"),e(),l("span",{class:"hljs-keyword"},"default"),e(` ({ filter, action }) => {
-	filter(`),l("span",{class:"hljs-string"},"'items.create'"),e(", "),l("span",{class:"hljs-function"},"() =>"),e(` {
-		`),l("span",{class:"hljs-built_in"},"console"),e(".log("),l("span",{class:"hljs-string"},"'Creating Item!'"),e(`);
-	});
-
-	action(`),l("span",{class:"hljs-string"},"'items.create'"),e(", "),l("span",{class:"hljs-function"},"() =>"),e(` {
-		`),l("span",{class:"hljs-built_in"},"console"),e(".log("),l("span",{class:"hljs-string"},"'Item created!'"),e(`);
-	});
-};
-`)])]),l("h2",{id:"events"},[e("Events "),l("a",{class:"header-anchor",href:"#events"},"#")]),l("p",null,"Your hook can trigger on a variety of different events. An event is defined by its type and its name."),l("p",null,"There are four event types to choose from:"),l("ul",null,[l("li",null,[l("a",{href:"#filter"},"Filter")]),l("li",null,[l("a",{href:"#action"},"Action")]),l("li",null,[l("a",{href:"#init"},"Init")]),l("li",null,[l("a",{href:"#schedule"},"Schedule")])]),l("p",null,"Use filter hooks when you want the hook to fire before the event. Use action hooks when you want the hook to fire after the event."),l("h3",{id:"filter"},[e("Filter "),l("a",{class:"header-anchor",href:"#filter"},"#")]),l("p",null,"Filter hooks act on the event\u2019s payload before the event is fired. They allow you to check, modify, or cancel an event."),l("p",null,[e("Below is an example of canceling a "),l("code",null,"create"),e(" event by throwing a standard Directus exception.")]),l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-keyword"},"export"),e(),l("span",{class:"hljs-keyword"},"default"),e(` ({ filter }, { exceptions }) => {
-	`),l("span",{class:"hljs-keyword"},"const"),e(` { InvalidPayloadException } = exceptions;
-
-	filter(`),l("span",{class:"hljs-string"},"'items.create'"),e(", "),l("span",{class:"hljs-keyword"},"async"),e(` (input) => {
-		`),l("span",{class:"hljs-keyword"},"if"),e(` (LOGIC_TO_CANCEL_EVENT) {
-			`),l("span",{class:"hljs-keyword"},"throw"),e(),l("span",{class:"hljs-keyword"},"new"),e(` InvalidPayloadException(WHAT_IS_WRONG);
-		}
-
-		`),l("span",{class:"hljs-keyword"},"return"),e(` input;
-	});
-};
-`)])]),l("p",null,"The filter register function receives two parameters:"),l("ul",null,[l("li",null,"The event name"),l("li",null,"A callback function that is executed whenever the event fires.")]),l("p",null,"The callback function itself receives three parameters:"),l("ul",null,[l("li",null,"The modifiable payload"),l("li",null,"An event-specific meta object"),l("li",null,"A context object")]),l("p",null,"The context object has the following properties:"),l("ul",null,[l("li",null,[l("code",null,"database"),e(" \u2014 The current database transaction")]),l("li",null,[l("code",null,"schema"),e(" \u2014 The current API schema in use")]),l("li",null,[l("code",null,"accountability"),e(" \u2014 Information about the current user")])]),l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Performance"),l("p",null,[e("Filters can impact performance when not carefully implemented, as they are executed in a blocking manner. This applies in particular to filters firing on "),l("code",null,"read"),e(" events, where a single request can result in a large amount of database reads.")])]),l("h3",{id:"action"},[e("Action "),l("a",{class:"header-anchor",href:"#action"},"#")]),l("p",null,"Action hooks execute after a defined event and receive data related to the event. Use action hooks when you need to automate responses to CRUD events on items or server actions."),l("p",null,"The action register function receives two parameters:"),l("ul",null,[l("li",null,"The event name"),l("li",null,"A callback function that is executed whenever the event fires.")]),l("p",null,"The callback function itself receives two parameters:"),l("ul",null,[l("li",null,"An event-specific meta object"),l("li",null,"A context object")]),l("p",null,"The context object has the following properties:"),l("ul",null,[l("li",null,[l("code",null,"database"),e(" \u2014 The current database transaction")]),l("li",null,[l("code",null,"schema"),e(" \u2014 The current API schema in use")]),l("li",null,[l("code",null,"accountability"),e(" \u2014 Information about the current user")])]),l("h3",{id:"init"},[e("Init "),l("a",{class:"header-anchor",href:"#init"},"#")]),l("p",null,"Init hooks execute at a defined point within the lifecycle of Directus. Use init hook objects to inject logic into internal services."),l("p",null,"The init register function receives two parameters:"),l("ul",null,[l("li",null,"The event name"),l("li",null,"A callback function that is executed whenever the event fires.")]),l("p",null,"The callback function itself receives one parameter:"),l("ul",null,[l("li",null,"An event-specific meta object")]),l("h3",{id:"schedule"},[e("Schedule "),l("a",{class:"header-anchor",href:"#schedule"},"#")]),l("p",null,[e("Schedule hooks execute at certain points in time rather than when Directus performs a specific action. This is supported through "),l("a",{href:"https://www.npmjs.com/package/node-cron",target:"_blank",rel:"noopener noreferrer"},[l("code",null,"node-cron")]),e(".")]),l("p",null,[e("To set up a scheduled event, provide a cron statement as the first parameter to the "),l("code",null,"schedule()"),e(" function. For example "),l("code",null,"schedule('15 14 1 * *', <...>)"),e(" (at 14:15 on day-of-month 1) or "),l("code",null,"schedule('5 4 * * sun', <...>)"),e(" (at 04:05 on Sunday).")]),l("p",null,"Below is an example of registering a schedule hook."),l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-keyword"},"import"),e(" axios "),l("span",{class:"hljs-keyword"},"from"),e(),l("span",{class:"hljs-string"},"'axios'"),e(`;
-
-`),l("span",{class:"hljs-keyword"},"export"),e(),l("span",{class:"hljs-keyword"},"default"),e(` ({ schedule }) => {
-	schedule(`),l("span",{class:"hljs-string"},"'*/15 * * * *'"),e(", "),l("span",{class:"hljs-keyword"},"async"),e(` () => {
-		`),l("span",{class:"hljs-keyword"},"await"),e(" axios.post("),l("span",{class:"hljs-string"},"'http://example.com/webhook'"),e(", { "),l("span",{class:"hljs-attr"},"message"),e(": "),l("span",{class:"hljs-string"},"'Another 15 minutes passed...'"),e(` });
-	});
-};
-`)])]),l("h2",{id:"available-events"},[e("Available Events "),l("a",{class:"header-anchor",href:"#available-events"},"#")]),l("h3",{id:"filter-events"},[e("Filter Events "),l("a",{class:"header-anchor",href:"#filter-events"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Name"),l("th",null,"Payload"),l("th",null,"Meta")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"request.not_found")]),l("td",null,[l("code",null,"false")]),l("td",null,[l("code",null,"request"),e(", "),l("code",null,"response")])]),l("tr",null,[l("td",null,[l("code",null,"request.error")]),l("td",null,"The request errors"),l("td",null,"\u2013")]),l("tr",null,[l("td",null,[l("code",null,"database.error")]),l("td",null,"The database error"),l("td",null,[l("code",null,"client")])]),l("tr",null,[l("td",null,[l("code",null,"auth.login")]),l("td",null,"The login payload"),l("td",null,[l("code",null,"status"),e(", "),l("code",null,"user"),e(", "),l("code",null,"provider")])]),l("tr",null,[l("td",null,[l("code",null,"auth.jwt")]),l("td",null,"The auth token"),l("td",null,[l("code",null,"status"),e(", "),l("code",null,"user"),e(", "),l("code",null,"provider"),e(", "),l("code",null,"type")])]),l("tr",null,[l("td",null,[l("code",null,"authenticate")]),l("td",null,"The empty accountability object"),l("td",null,[l("code",null,"req")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.read")]),l("td",null,"The read item"),l("td",null,[l("code",null,"query"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.create")]),l("td",null,"The new item"),l("td",null,[l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.update")]),l("td",null,"The updated item"),l("td",null,[l("code",null,"keys"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.delete")]),l("td",null,"The keys of the item"),l("td",null,[l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.create")]),l("td",null,"The new item"),l("td",null,[l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.update")]),l("td",null,"The updated item"),l("td",null,[l("code",null,"keys"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.delete")]),l("td",null,"The keys of the item"),l("td",null,[l("code",null,"collection")])])])]),l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"System Collections"),l("p",null,[l("code",null,"<system-collection>"),e(" should be replaced with one of the system collection names "),l("code",null,"activity"),e(", "),l("code",null,"collections"),e(", "),l("code",null,"fields"),e(", "),l("code",null,"files"),e(" (except create/update), "),l("code",null,"folders"),e(", "),l("code",null,"permissions"),e(", "),l("code",null,"presets"),e(", "),l("code",null,"relations"),e(", "),l("code",null,"revisions"),e(", "),l("code",null,"roles"),e(", "),l("code",null,"settings"),e(", "),l("code",null,"users"),e(" or "),l("code",null,"webhooks"),e(".")])]),l("h3",{id:"action-events"},[e("Action Events "),l("a",{class:"header-anchor",href:"#action-events"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Name"),l("th",null,"Meta")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"server.start")]),l("td",null,[l("code",null,"server")])]),l("tr",null,[l("td",null,[l("code",null,"server.stop")]),l("td",null,[l("code",null,"server")])]),l("tr",null,[l("td",null,[l("code",null,"response")]),l("td",null,[l("code",null,"request"),e(", "),l("code",null,"response"),e(", "),l("code",null,"ip"),e(", "),l("code",null,"duration"),e(", "),l("code",null,"finished")])]),l("tr",null,[l("td",null,[l("code",null,"auth.login")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"status"),e(", "),l("code",null,"user"),e(", "),l("code",null,"provider")])]),l("tr",null,[l("td",null,[l("code",null,"files.upload")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"key"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.read")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"query"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.create")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"key"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.update")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"keys"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.delete")]),l("td",null,[l("code",null,"keys"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"(<collection>.)items.sort")]),l("td",null,[l("code",null,"collection"),e(", "),l("code",null,"item"),e(", "),l("code",null,"to")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.create")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"key"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.update")]),l("td",null,[l("code",null,"payload"),e(", "),l("code",null,"keys"),e(", "),l("code",null,"collection")])]),l("tr",null,[l("td",null,[l("code",null,"<system-collection>.delete")]),l("td",null,[l("code",null,"keys"),e(", "),l("code",null,"collection")])])])]),l("div",{class:"tip hint"},[l("div",{class:"hint-title"},"System Collections"),l("p",null,[l("code",null,"<system-collection>"),e(" should be replaced with one of the system collection names "),l("code",null,"activity"),e(", "),l("code",null,"collections"),e(", "),l("code",null,"fields"),e(", "),l("code",null,"files"),e(" (except create/update), "),l("code",null,"folders"),e(", "),l("code",null,"permissions"),e(", "),l("code",null,"presets"),e(", "),l("code",null,"relations"),e(", "),l("code",null,"revisions"),e(", "),l("code",null,"roles"),e(", "),l("code",null,"settings"),e(", "),l("code",null,"users"),e(" or "),l("code",null,"webhooks"),e(".")])]),l("h3",{id:"init-events"},[e("Init Events "),l("a",{class:"header-anchor",href:"#init-events"},"#")]),l("table",null,[l("thead",null,[l("tr",null,[l("th",null,"Name"),l("th",null,"Meta")])]),l("tbody",null,[l("tr",null,[l("td",null,[l("code",null,"cli.before")]),l("td",null,[l("code",null,"program")])]),l("tr",null,[l("td",null,[l("code",null,"cli.after")]),l("td",null,[l("code",null,"program")])]),l("tr",null,[l("td",null,[l("code",null,"app.before")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"app.after")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"routes.before")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"routes.after")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"routes.custom.before")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"routes.custom.after")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"middlewares.before")]),l("td",null,[l("code",null,"app")])]),l("tr",null,[l("td",null,[l("code",null,"middlewares.after")]),l("td",null,[l("code",null,"app")])])])]),l("h2",{id:"register-function"},[e("Register Function "),l("a",{class:"header-anchor",href:"#register-function"},"#")]),l("p",null,"The register function receives an object containing the type-specific register functions as the first parameter:"),l("ul",null,[l("li",null,[l("code",null,"filter"),e(" \u2014 Listen for a filter event")]),l("li",null,[l("code",null,"action"),e(" \u2014 Listen for an action event")]),l("li",null,[l("code",null,"init"),e(" \u2014 Listen for an init event")]),l("li",null,[l("code",null,"schedule"),e(" \u2014 Execute a function at certain points in time")])]),l("p",null,"The second parameter is a context object with the following properties:"),l("ul",null,[l("li",null,[l("code",null,"services"),e(" \u2014 All API internal services")]),l("li",null,[l("code",null,"exceptions"),e(" \u2014 API exception objects that can be used for throwing \u201Cproper\u201D errors")]),l("li",null,[l("code",null,"database"),e(" \u2014 Knex instance that is connected to the current database")]),l("li",null,[l("code",null,"getSchema"),e(" \u2014 Async function that reads the full available schema for use in services")]),l("li",null,[l("code",null,"env"),e(" \u2014 Parsed environment variables")]),l("li",null,[l("code",null,"logger"),e(" \u2014 "),l("a",{href:"https://github.com/pinojs/pino",target:"_blank",rel:"noopener noreferrer"},"Pino"),e(" instance.")]),l("li",null,[l("code",null,"emitter"),e(" \u2014 "),l("a",{href:"https://github.com/directus/directus/blob/main/api/src/emitter.ts",target:"_blank",rel:"noopener noreferrer"},"Event emitter"),e(" instance that can be used to trigger custom events for other extensions.")])]),l("div",{class:"warning hint"},[l("div",{class:"hint-title"},"Event loop"),l("p",null,"When implementing custom events using the emitter make sure you never directly or indirectly emit the same event your hook is currently handling as that would result in an infinite loop!")]),l("h2",{id:"example%3A-sync-with-external"},[e("Example: Sync with External "),l("a",{class:"header-anchor",href:"#example%3A-sync-with-external"},"#")]),l("pre",null,[l("code",{class:"language-js"},[l("span",{class:"hljs-keyword"},"import"),e(" axios "),l("span",{class:"hljs-keyword"},"from"),e(),l("span",{class:"hljs-string"},"'axios'"),e(`;
-
-`),l("span",{class:"hljs-keyword"},"export"),e(),l("span",{class:"hljs-keyword"},"default"),e(` ({ filter }, { services, exceptions }) => {
-	`),l("span",{class:"hljs-keyword"},"const"),e(` { MailService } = services;
-	`),l("span",{class:"hljs-keyword"},"const"),e(` { ServiceUnavailableException, ForbiddenException } = exceptions;
-
-	`),l("span",{class:"hljs-comment"},"// Sync with external recipes service, cancel creation on failure"),e(`
-	filter(`),l("span",{class:"hljs-string"},"'items.create'"),e(", "),l("span",{class:"hljs-keyword"},"async"),e(` (input, { collection }, { schema }) => {
-		`),l("span",{class:"hljs-keyword"},"if"),e(" (collection !== "),l("span",{class:"hljs-string"},"'recipes'"),e(") "),l("span",{class:"hljs-keyword"},"return"),e(` input;
-
-		`),l("span",{class:"hljs-keyword"},"const"),e(" mailService = "),l("span",{class:"hljs-keyword"},"new"),e(` MailService({ schema });
-
-		`),l("span",{class:"hljs-keyword"},"try"),e(` {
-			`),l("span",{class:"hljs-keyword"},"await"),e(" axios.post("),l("span",{class:"hljs-string"},"'https://example.com/recipes'"),e(`, input);
-			`),l("span",{class:"hljs-keyword"},"await"),e(` mailService.send({
-				`),l("span",{class:"hljs-attr"},"to"),e(": "),l("span",{class:"hljs-string"},"'person@example.com'"),e(`,
-				`),l("span",{class:"hljs-attr"},"template"),e(`: {
-					`),l("span",{class:"hljs-attr"},"name"),e(": "),l("span",{class:"hljs-string"},"'item-created'"),e(`,
-					`),l("span",{class:"hljs-attr"},"data"),e(`: {
-						`),l("span",{class:"hljs-attr"},"collection"),e(`: collection,
-					},
-				},
-			});
-		} `),l("span",{class:"hljs-keyword"},"catch"),e(` (error) {
-			`),l("span",{class:"hljs-keyword"},"throw"),e(),l("span",{class:"hljs-keyword"},"new"),e(` ServiceUnavailableException(error);
-		}
-
-		input.syncedWithExample = `),l("span",{class:"hljs-literal"},"true"),e(`;
-
-		`),l("span",{class:"hljs-keyword"},"return"),e(` input;
-	});
-};
-`)])])],-1),f="Custom API Hooks",m=!0,y={name:"hooks",setup(i,{expose:t}){const n={title:"Custom API Hooks",modularExtension:!0};return t({frontmatter:n}),(d,h)=>{const s=o("docs-wrapper");return c(),a(s,{frontmatter:n},{default:u(()=>[r]),_:1})}}};export{y as default,m as modularExtension,f as title};

package/dist/assets/import-export.c48e51e7.js

@@ -1,2 +0,0 @@
-import{a as r,o as d,b as p,w as o,g as e,e as l,B as t}from"./runtime-core.esm-bundler.e6808e6c.js";const c={class:"markdown-body"},h=e("blockquote",null,[e("p",null,"The Content, User Directory, and File Library modules allow importing and exporting of multiple Items stored as files. This makes it quick and easy to handle tasks like uploading and downloading new customer information; pulling down sales data for transformation, reports, analysis, and beyond.")],-1),m=e("p",null,[e("div",{class:"table-of-contents"},[e("ul",null,[e("li",null,[e("a",{href:"#import-items"},"Import Items")]),e("li",null,[e("a",{href:"#export-items"},"Export Items")]),e("li",null,[e("a",{href:"#export-items-menu"},"Export Items Menu")]),e("li",null,[e("a",{href:"#file-assets-and-media"},"File Assets and Media")])])])],-1),u={class:"tip hint"},_=e("div",{class:"hint-title"},"Before You Begin",-1),f=t("To use this utility, you will need to be familiar with "),x=t("Collections"),g=t(", "),y=t("Items"),I=t(", and "),w=t("Fields"),v=t("."),F={class:"tip hint"},b=e("div",{class:"hint-title"},"Import / Export via the API",-1),C=t("This page details Importing and Exporting of Items as files via the no-code app. However, you can also "),E=t("Import"),k=t(" and "),L=t("Export"),S=t(" Items as files programmatically via the API."),A=e("h2",{id:"import-items"},[t("Import Items "),e("a",{class:"header-anchor",href:"#import-items"},"#")],-1),T=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Import Data From a File"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/import-items-20220416A.mp4",type:"video/mp4"})],-1),M=e("p",null,"To import Items from a file, follow the steps below.",-1),D=e("ol",null,[e("li",null,[t("Navigate to the desired Module and Collection."),e("br"),t(" Note: the User Directory and File Library are each composed of just one Collection.")]),e("li",null,[t("Click "),e("strong",null,"\u201CImport / Export\u201D"),t(" in the Sidebar.")]),e("li",null,"Click into the import search box. A file browser will open."),e("li",null,[t("Select the desired file and click "),e("strong",null,"\u201Copen\u201D"),t(".")]),e("li",null,[t("Click "),e("strong",null,"\u201CStart Import\u201D"),t(" to import the Items.")])],-1),N=e("p",null,"The Items will now be in the Collection. The file itself will not be stored in the Directus Project.",-1),V=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Importing Relational Files"),e("p",null,"It is possible to import relational Field values as well. For this task, the User performing the import will need access permissions for the related Collection and a firm understanding of the relational data model.")],-1),B=e("h2",{id:"export-items"},[t("Export Items "),e("a",{class:"header-anchor",href:"#export-items"},"#")],-1),U=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Export Data to a File"},[e("source",{src:`https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/export-items-20220416A.mp4
-`,type:"video/mp4"})],-1),O=e("p",null,[t("When exporting Items, the "),e("a",{href:"#export-items-menu"},"Export Items Menu"),t(" provides granular control over exactly which Items and Fields are exported, how they are exported, and where they are exported. To export Items, follow the steps below.")],-1),P=e("ol",null,[e("li",null,[t("Navigate to the desired Module and Collection."),e("br"),t(" Note: the User Directory and File Library are each composed of one Collection.")]),e("li",null,[t("Click "),e("strong",null,"\u201CImport / Export\u201D"),t(" in the Sidebar.")]),e("li",null,[t("Click "),e("strong",null,"\u201CExport Items\u201D"),t(" and the "),e("a",{href:"#export-items-menu"},"Export Items Menu"),t(" will appear.")]),e("li",null,"Choose the desired format: CSV, JSON or XML."),e("li",null,[e("strong",null,"Optional:"),t(" Configure any other export details as desired.")]),e("li",null,[t("Click "),e("span",{mi:"",btn:""},"download"),t(" to download the file.")])],-1),j=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Opening the file in Excel?"),e("p",null,"Export your file to CSV to seamlessly open in excel.")],-1),q=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Exporting to File Library"),e("p",null,"When downloading 2,500 or more Items, you will be required to download into the Directus Project\u2019s File Library. After exporting, go to the File Library to download your file locally.")],-1),W=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"Exporting Relational Files"),e("p",null,"It is possible to export relational Field values. For this task, the User performing the export will need access permissions for the related Collection and a firm understanding of the relational data model.")],-1),J=e("h2",{id:"export-items-menu"},[t("Export Items Menu "),e("a",{class:"header-anchor",href:"#export-items-menu"},"#")],-1),R=e("video",{autoplay:"",muted:"",loop:"",controls:"",title:"Export Data to a File"},[e("source",{src:"https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/export-items-menu-20220416A.mp4",type:"video/mp4"})],-1),X=e("p",null,"This menu provides granular control over exactly which Items and Fields are exported, how they are exported, and where they are exported.",-1),H=e("ul",null,[e("li",null,[e("strong",null,"Format"),t(" \u2014 Choose to export Items as CSV, JSON, or XML.")]),e("li",null,[e("strong",null,"Limit"),t(" \u2014 Set the maximum number of Items to be exported.")]),e("li",null,[e("strong",null,"Export Location"),t(" \u2014 Download the export file directly to your machine or to the File Library.")]),e("li",null,[e("strong",null,"Folder"),t(" \u2014 Choose the Folder to download to "),e("em",null,"(if export location is the Folder Library)"),t(".")]),e("li",null,[e("strong",null,"Sort Field"),t(" \u2014 Choose Field to sort Items by.")]),e("li",null,[e("strong",null,"Sort Direction"),t(" \u2014 Choose to sort Items in ascending or descending order.")]),e("li",null,[e("strong",null,"Full-Text Search"),t(" \u2014 Limit exported Items to ones which matched as search results.")]),e("li",null,[e("strong",null,"Filter"),t(" \u2014 Limit exported Items with a Filter.")]),e("li",null,[e("strong",null,"Fields"),t(" \u2014 Add, remove, and re-order the Item Fields that will be exported.")])],-1),Y=e("h2",{id:"file-assets-and-media"},[t("File Assets and Media "),e("a",{class:"header-anchor",href:"#file-assets-and-media"},"#")],-1),z=e("p",null,"Some Collections may directly or relationally include Fields referencing images, videos or other file types. It is not possible to import or export files with this utility.",-1),G=t("To import and export files, please see the "),K=t("File Library Module"),Q=t("."),Z=e("div",{class:"tip hint"},[e("div",{class:"hint-title"},"What does Import/Export do in the File Library?!"),e("p",null,[t("Import/Export handles Field Values associated with the file "),e("em",null,"(e.g. id, title, description, etc.)"),t(".")])],-1),ie="Import / Export",le=!1,se={name:"import-export",setup($,{expose:n}){const s={title:"Import / Export",modularExtension:!1};return n({frontmatter:s}),(ee,te)=>{const i=r("router-link"),a=r("docs-wrapper");return d(),p(a,{frontmatter:s},{default:o(()=>[e("div",c,[h,m,e("div",u,[_,e("p",null,[f,l(i,{to:"/docs/getting-started/glossary/#collections"},{default:o(()=>[x]),_:1}),g,l(i,{to:"/docs/getting-started/glossary/#items"},{default:o(()=>[y]),_:1}),I,l(i,{to:"/docs/getting-started/glossary/#fields"},{default:o(()=>[w]),_:1}),v])]),e("div",F,[b,e("p",null,[C,l(i,{to:"/docs/reference/system/utilities/#import-data-from-file"},{default:o(()=>[E]),_:1}),k,l(i,{to:"/docs/reference/system/utilities/#export-data-to-a-file"},{default:o(()=>[L]),_:1}),S])]),A,T,M,D,N,V,B,U,O,P,j,q,W,J,R,X,H,Y,z,e("p",null,[G,l(i,{to:"/docs/app/file-library/"},{default:o(()=>[K]),_:1}),Q]),Z])]),_:1})}}};export{se as default,le as modularExtension,ie as title};