add providers

This commit is contained in:
Ben Irvin 2023-06-21 14:34:12 +02:00
parent 92c942830d
commit b4f0440a8f
23 changed files with 176 additions and 77 deletions

View File

@ -0,0 +1,23 @@
---
title: Destination Providers
tags:
- providers
- data-transfer
- experimental
---
# Data Providers
Data providers are the interfaces for streaming data during a transfer. Source providers provide read streams and destination providers provide write streams which the transfer engine pipes (and optionally transforms) during a transfer.
Strapi provides both source and destination providers for the following:
- [Strapi file](../03-file-providers/00-overview.md): a standardized file format designed for the transfer process
- [Local Strapi]: a connection to a local Strapi project which uses its configured database connection to manage data
- [Remote Strapi]: a wrapper of local Strapi provider that adds a websocket interface to a running remote (network) instance of Strapi
## Creating your own providers
It is possible to create your own providers by implementing the interface(s) defined in ISourceProvider and IDestinationProvider. It is not necessary to create both a source and destination provider, only the part necessary for your use.
For examples, see the existing providers such as the local Strapi provider.

View File

@ -0,0 +1,13 @@
---
title: Source Providers
tags:
- providers
- data-transfer
- experimental
---
# Source Providers
## Source provider structure
**TODO**

View File

@ -0,0 +1,13 @@
---
title: Destination Providers
tags:
- providers
- data-transfer
- experimental
---
# Destination Providers
## Destination provider structure
**TODO**

View File

@ -1,21 +0,0 @@
---
title: Source Providers
tags:
- providers
- data-transfer
- experimental
---
# Source Providers
Data transfer source providers provide a standardized interface and streams of data for each stage in a transfer intended to be consumed by destination providers.
The following source providers are available within Strapi:
- [Strapi File](./01-strapi-file.md): loads data from a Strapi data file
- [Local Strapi](./02-local-strapi.md): uses a local Strapi project to retrieve data from its configured database
- [Remote Strapi](./03-remote-strapi.md): accepts a websocket connection to a running instance of Strapi over a network to send data
## Creating your own providers
It is possible to create your own provider by providing the interface defined in ISourceProvider. Please see existing providers (such as the local strapi source provider) for an example.

View File

@ -1,13 +0,0 @@
---
title: Remote Strapi
tags:
- providers
- data-transfer
- experimental
---
# Remote Strapi Source Provider
Note: This provider is a websocket interface wrapper for the Local Strapi Source Provider
**TODO**

View File

@ -1,21 +0,0 @@
---
title: Destination Providers
tags:
- providers
- data-transfer
- experimental
---
# Destination Providers
Data transfer destination providers provide a standardized interface and streams of data for each stage in a transfer intended to consume the stream provided by a source provider.
The following destination providers are available within Strapi:
- [Strapi File](./01-strapi-file.md): writes data to a Strapi data file
- [Local Strapi](./02-local-strapi.md): uses a local Strapi project to insert data into its configured database
- [Remote Strapi](./03-remote-strapi.md): accepts a websocket connection to a running instance of Strapi over a network to receive data
## Creating your own providers
It is possible to create your own provider by providing the interface defined in ISourceProvider. Please see existing providers (such as the local strapi source provider) for an example.

View File

@ -1,13 +0,0 @@
---
title: Remote Strapi
tags:
- providers
- data-transfer
- experimental
---
# Remote Strapi Destination Provider
Note: This provider is a websocket wrapper for the Local Strapi Destination Provider
**TODO**

View File

@ -0,0 +1,13 @@
---
title: File Providers
tags:
- experimental
- providers
- import
- export
- data-transfer
---
# Strapi Data File Providers
**TODO**

View File

@ -6,6 +6,6 @@ tags:
- experimental
---
# Strapi File Source Provider
# Strapi File Structure
TODO
**TODO**

View File

@ -0,0 +1,13 @@
---
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Strapi File Source Provider
This provider will output a Strapi Data File
**TODO**

View File

@ -1,5 +1,5 @@
{
"label": "Destination Providers",
"label": "File Providers",
"collapsible": true,
"collapsed": true
}

View File

@ -0,0 +1,13 @@
---
title: File Providers
tags:
- experimental
- providers
- import
- export
- data-transfer
---
# Strapi Data File Providers
**TODO**

View File

@ -1,11 +1,11 @@
---
title: Local Strapi
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Destination Providers
# Strapi File Structure
TODO
**TODO**

View File

@ -0,0 +1,13 @@
---
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Strapi File Source Provider
This provider will output a Strapi Data File
**TODO**

View File

@ -0,0 +1,15 @@
---
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Strapi File Destination Provider
This provider will output a Strapi Data File
Note: this destination provider does not provide a schema or metadata, and will therefore never report a schema match error or version validation error
**TODO**

View File

@ -0,0 +1,5 @@
{
"label": "File Providers",
"collapsible": true,
"collapsed": true
}

View File

@ -0,0 +1,13 @@
---
title: File Providers
tags:
- experimental
- providers
- import
- export
- data-transfer
---
# Strapi Data File Providers
**TODO**

View File

@ -1,11 +1,11 @@
---
title: Local Strapi
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Local Strapi Destination Provider
# Strapi File Structure
TODO
**TODO**

View File

@ -0,0 +1,13 @@
---
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Strapi File Source Provider
This provider will output a Strapi Data File
**TODO**

View File

@ -0,0 +1,15 @@
---
title: Strapi File
tags:
- providers
- data-transfer
- experimental
---
# Strapi File Destination Provider
This provider will output a Strapi Data File
Note: this destination provider does not provide a schema or metadata, and will therefore never report a schema match error or version validation error
**TODO**

View File

@ -0,0 +1,5 @@
{
"label": "File Providers",
"collapsible": true,
"collapsed": true
}