update structure

This commit is contained in:
Ben Irvin 2023-06-26 14:18:27 +02:00
parent 390d51b398
commit 7aa725fde9
19 changed files with 17 additions and 17 deletions

View File

@ -32,7 +32,7 @@ Once all stages have been completed, the transfer waits for all providers to clo
## Setting up the transfer engine
A transfer engine object is created by using `createTransferEngine`, which accepts a [source provider](./source-providers/overview), a [destination provider](./destination-providers/overview), and an options object.
A transfer engine object is created by using `createTransferEngine`, which accepts a [source provider](./02-providers/01-source-providers.md), a [destination provider](./02-providers/02-destination-providers.md), and an options object.
Note: By default, a transfer engine will transfer ALL data, including admin data, api tokens, etc. Transform filters must be used if you wish to exclude, as seen in the example below. An array called `DEFAULT_IGNORED_CONTENT_TYPES` is available from @strapi/data-transfer containing the uids that are excluded by default from the import, export, and transfer commands. If you intend to transfer admin data, be aware that this behavior will likely change in the future to automatically exclude the entire `admin::` uid namespace and will instead require them to be explicitly included.

View File

@ -1,5 +1,5 @@
---
title: Data Transfer Providers
title: Introduction
tags:
- providers
- data-transfer
@ -16,15 +16,15 @@ Data transfer providers are the interfaces for streaming data during a transfer.
Strapi provides both source and destination providers for the following:
- [Strapi file](../02-file-providers/00-overview.md): a standardized file format designed for the transfer process
- [Local Strapi](../03-local-strapi-providers/00-overview.md): a connection to a local Strapi project which uses its configured database connection to manage data
- [Remote Strapi](../04-remote-strapi-providers/00-overview.md): a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi
- [Strapi file](./03-strapi-file/00-overview.md): a standardized file format designed for the transfer process
- [Local Strapi](./04-local-strapi/00-overview.md): a connection to a local Strapi project which uses its configured database connection to manage data
- [Remote Strapi](./05-remote-strapi/00-overview.md): a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi
Each provider must provide the same interface for transferring data, but will usually include its own unique set of options to be passed in when initializing the provider.
## Creating your own providers
To create your own providers, you must implement the interface(s) defined in ISourceProvider and IDestinationProvider found in `packages/core/data-transfer/types/providers.d.ts`.
To create your own providers, you must implement the interface(s) defined in `ISourceProvider` and `IDestinationProvider` found in `packages/core/data-transfer/types/providers.d.ts`.
It is not necessary to create both a source and destination provider, only the part necessary for your use.

View File

@ -1,5 +1,5 @@
---
title: File Providers
title: Overview
tags:
- experimental
- providers

View File

@ -1,5 +1,5 @@
---
title: Strapi File
title: Source
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Strapi File
title: Destination
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Local Strapi Providers
title: Overview
tags:
- experimental
- providers

View File

@ -1,5 +1,5 @@
---
title: Local Strapi Source
title: Source
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Local Strapi Destination
title: Destination
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Remote Strapi Providers
title: Overview
tags:
- experimental
- providers

View File

@ -1,5 +1,5 @@
---
title: Remote Provider Websocket
title: Websocket
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Strapi Remote Source Provider
title: Source
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
---
title: Remote Destination Provider
title: Destination
tags:
- providers
- data-transfer

View File

@ -1,5 +1,5 @@
{
"label": "Data Transfer Providers",
"label": "Providers",
"collapsible": true,
"collapsed": true
}