mirror of
https://github.com/directus/directus.git
synced 2026-04-25 03:00:53 -04:00
0c54f5a9ef
* items semi complete
* updated items page to use snippet toggler and migrated endpoint docs to use it
* updated files page to use snippet toggler and migrated REST and GraphQL endpoint docs to it
* updated activity page to use snippet toggler and migrated REST and GraphQL endpoint doc to it
* updated collections page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* updated dashboards page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated extensions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated fields page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated flows page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated folders page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated notifications page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated operations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated panels page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated permissions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated presets page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated relations page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated revisions page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated roles page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Made headlines consistant with the rest of the doc pages
* Updated server page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated settings page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated shares page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated translations page to use snippet togglers and migrated REST endpoint docs to them
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated utilities page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated webhooks page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated authentication page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* Updated Global Parameters page to use snippet togglers where there are adjacent REST and GraphQL Examples
* Added SDK code snippets to items page and made generic variables consistant
* Added SDK code snippets to files page and made generic variables consistant
* Few lang changes for files page
* Added SDK code snippets to activity page and made generic variables consistant
* Added SDK code snippets to collections page and made generic variables consistant
* Added SDK code snippets to dashboards page and made generic variables consistant
* removed query word from query parameter objects
* Added SDK code snippets to fields page and made generic variables consistant
* SnippetToggler border
* Used dynamic border color for snippettoggler heading
* Spacing top and bottom of snippet toggler in docs
* Removed extra HRs
* Remove manual TOC in query reference
* Small code styling change in items page
* Updated users page to use snippet togglers and migrated REST and GraphQL endpoint docs to them
* dashboards fixed up property names
* Small copy update on extensions page
* Updated keys in delete mult notifications REST
* Updated keys in operations
* Update keys in panel delete many
* Update keys in permissions
* Added quotes around generic example ID strings
* Added code formatting to final example in share public info
* Format files
* Refined sidebar
* Insert newline before ending template tags
* Fixed extra closing tags, causing an error, un users ref
* Text Formatting Users
* Put GQL related notes inside toggler
* Added SDK code snippets to flows page and made generic variables consistant
* Added SDK code snippets to folder page and made generic variables consistant
* fixing whitepsace for flows and folders page
* Consistent newlines in SnippetToggler usages
* Run prettier
* Fix 'alwaysDark' definition
* Home page snippet toggler style fixes
* Fix snippet toggler lang hover color in light mode
* Introduce different code theme for light mode
* Added SDK code snippets to notifications page and made generic variables consistant
* Switch to 'material-theme-lighter'
* Format file
* Fix tip
* Fix tip in sdk ref
* Consistent spacing for custom containers
* Added SDK code snippets to operations page and made generic variables consistant
* Lint & format code blocks
* Lint & format operations
* Added SDK code snippets to panels page and made generic variables consistant
* Added SDK code snippets to permissions page and made generic variables consistant
* Added SDK code snippets to presets page and made generic variables consistant
* Added SDK code snippets to relations page and made generic variables consistant
* Added SDK code snippets to revisions page and made generic variables consistant
* Added SDK code snippets to roles page and made generic variables consistant
* Added SDK code snippets to server page and made generic variables consistant
* Added SDK code snippets to settings page and made generic variables consistant
* app_url -> directus_project_url
* Omitted auth details in delete multiple files
* Added quotes to values in roles
* Upload a file snippets
* Pluralization for upload/import files
* More files functions typos
* Added SDK code snippets to shares page (still missing createShare(s) as endpoint not functioning currently) and made generic variables consistant
* Added SDK code snippets to translations page (missing delete endponts because not working) and made generic variables consistant
* Added SDK code snippets to users page and made generic variables consistant
* Added SDK code snippets to webhooks page and made generic variables consistant
* Added SDK code snippets to utilites page (except cleaning cache, will be tested and added in later commit) and made generic variables consistant
* Added SDK code snippets to auth page (not login, refresh, and logout though due to errors)
* Added SDK code snippets for utilsExport and clearCache
* added github username be7DOTis to contributors
* Omit auth commands in updateComment
* utilsImport
* rename app_url generic value
* changed instances of updated*operation* to update*Operation*
* missed some 'updated' changse
* Added SDK Snippets to Query Parameters page
* Add section on file security
* added create(s)Shares SDK snippet to shares page
* added console.log to create snippets
* Added delete(s)Webhook SDK snippet to webhooks page
* Added SDK snippets to extensions page
* Added create/updateSingleton section to items page
* Links in files security
* Added SDK Snippets to Schema page
* Added GQL Generic examples to snippet togglers and removed snippet toggler from Login Using SSO Providers
* Added create(s)Presets SDK Snippets to presets page
* replaced fields query in generics snippets for a more generic
* replaced fields query in generics snippets for a more generic
* Use storage value only if valid choice
* Sync snippet togglers across page
* Update docs/reference/system/activity.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/extensions.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/revisions.md
* Update docs/reference/system/settings.md
* Update docs/reference/system/activity.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/roles.md
* Update docs/reference/system/schema.md
* Update docs/reference/system/server.md
* Update docs/reference/system/shares.md
* Replace all directus_project_url placeholders
* Revert "Sync snippet togglers across page"
This reverts commit 8b36f0d778.
* Update docs/reference/system/shares.md
* Update docs/reference/system/webhooks.md
* Clarify singleton section
* Consistent newlines between SnippetToggler templates
* Format files
* Remove console.log(result) statements from snippet
* Add examples for shares & users
Co-authored-by: Brainslug <tim@brainslug.nl>
* Fix hash GraphQL example
* Clarify update singleton section
* Add auth examples
Co-authored-by: Brainslug <tim@brainslug.nl>
* Final run on consistent newlines between SnippetToggler
* Switch to github themes
* The "Last One"
Co-authored-by: Brainslug <tim@brainslug.nl>
* The "Big One"
* Fix dead links
---------
Co-authored-by: Bevis Halsey-Perry <hi@be7.is>
Co-authored-by: Kevin Lewis <kvn@lws.io>
Co-authored-by: Pascal Jufer <pascal-jufer@bluewin.ch>
Co-authored-by: Brainslug <br41nslug@users.noreply.github.com>
Co-authored-by: rijkvanzanten <rijkvanzanten@me.com>
Co-authored-by: Brainslug <tim@brainslug.nl>
133 lines
5.2 KiB
Markdown
133 lines
5.2 KiB
Markdown
---
|
|
description:
|
|
The Content, User Directory, and File Library modules allow importing and exporting of multiple Items stored as files.
|
|
readTime: 4 min read
|
|
---
|
|
|
|
# Import / Export
|
|
|
|
> 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.
|
|
|
|
::: tip Before You Begin
|
|
|
|
To use this utility, you will need to be familiar with [Collections](/user-guide/overview/glossary#collections),
|
|
[Items](/user-guide/overview/glossary#items), and [Fields](/user-guide/overview/glossary#fields).
|
|
|
|
<!--
|
|
@TODO Getting Started > Introduction
|
|
Link when ready
|
|
-->
|
|
|
|
:::
|
|
|
|
::: tip Import / Export via the API
|
|
|
|
This page details Importing and Exporting of Items as files via the no-code app. However, you can also
|
|
[Import](/reference/system/utilities#import-data-from-file) and
|
|
[Export](/reference/system/utilities#export-data-to-a-file) Items as files programmatically via the API.
|
|
|
|
:::
|
|
|
|
## Import Items
|
|
|
|
<video autoplay playsinline muted loop controls title="Import Data From a File">
|
|
<source src="https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/import-items-20220416A.mp4" type="video/mp4" />
|
|
</video>
|
|
|
|
To import Items from a file, follow the steps below.
|
|
|
|
1. Navigate to the desired Module and Collection.\
|
|
Note: the User Directory and File Library are each composed of just one Collection.
|
|
2. Click **"Import / Export"** in the Sidebar.
|
|
3. Click into the import search box. A file browser will open.
|
|
4. Select the desired file and click **"open"**.
|
|
5. Click **"Start Import"** to import the Items.
|
|
|
|
The Items will now be in the Collection. The file itself will not be stored in the Directus Project.
|
|
|
|
::: tip Importing Relational Files
|
|
|
|
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.
|
|
|
|
<!--
|
|
@TODO config > import / export
|
|
Add link
|
|
-->
|
|
|
|
:::
|
|
|
|
## Export Items
|
|
|
|
<video autoplay playsinline muted loop controls title="Export Data to a File">
|
|
<source src="https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/export-items-20220416A.mp4
|
|
" type="video/mp4" />
|
|
</video>
|
|
|
|
When exporting Items, the [Export Items Menu](#export-items-menu) 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. Navigate to the desired Module and Collection.\
|
|
Note: the User Directory and File Library are each composed of one Collection.
|
|
2. Click **"Import / Export"** in the Sidebar.
|
|
3. Click **"Export Items"** and the [Export Items Menu](#export-items-menu) will appear.
|
|
4. Choose the desired format: CSV, JSON, XML, or YAML.
|
|
5. **Optional:** Configure any other export details as desired.
|
|
6. Click <span mi btn>download</span> to download the file.
|
|
|
|
::: tip Opening the file in Excel?
|
|
|
|
Export your file to CSV to seamlessly open in excel.
|
|
|
|
:::
|
|
|
|
::: tip Exporting to File Library
|
|
|
|
When downloading 2,500 or more Items, you will be required to download into the Directus Project's File Library. After
|
|
exporting, go to the File Library to download your file locally.
|
|
|
|
:::
|
|
|
|
::: tip Exporting Relational Files
|
|
|
|
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.
|
|
|
|
<!--@TODO link to config access permissions when ready-->
|
|
|
|
:::
|
|
|
|
## Export Items Menu
|
|
|
|
<video autoplay playsinline muted loop controls title="Export Data to a File">
|
|
<source src="https://cdn.directus.io/docs/v9/app-guide/imports-exports/imports-exports-20220415A/export-items-menu-20220416A.mp4" type="video/mp4" />
|
|
</video>
|
|
|
|
This menu provides granular control over exactly which Items and Fields are exported, how they are exported, and where
|
|
they are exported.
|
|
|
|
- **Format** — Choose to export Items as CSV, JSON, XML, or YAML.
|
|
- **Limit** — Set the maximum number of Items to be exported.
|
|
- **Export Location** — Download the export file directly to your machine or to the File Library.
|
|
- **Folder** — Choose the Folder to download to _(if export location is the Folder Library)_.
|
|
- **Sort Field** — Choose Field to sort Items by.
|
|
- **Sort Direction** — Choose to sort Items in ascending or descending order.
|
|
- **Full-Text Search** — Limit exported Items to ones which matched as search results.
|
|
- **Filter** — Limit exported Items with a Filter.
|
|
- **Fields** — Add, remove, and re-order the Item Fields that will be exported.
|
|
|
|
## File Assets and Media
|
|
|
|
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.
|
|
|
|
To import and export files, please see the [File Library Module](/user-guide/file-library/files).
|
|
|
|
::: tip What does Import/Export do in the File Library?!
|
|
|
|
Import/Export handles Field Values associated with the file _(e.g. id, title, description, etc.)_.
|
|
|
|
:::
|