2021-08-08 16:40:51 -04:00
|
|
|
# File
|
|
|
|
|
|
|
|
|
|
For context on getting started with ingestion, check out our [metadata ingestion guide](../README.md).
|
|
|
|
|
|
|
|
|
|
## Setup
|
|
|
|
|
|
|
|
|
|
Works with `acryl-datahub` out of the box.
|
|
|
|
|
|
|
|
|
|
## Capabilities
|
|
|
|
|
|
|
|
|
|
Outputs metadata to a file. This can be used to decouple metadata sourcing from the
|
|
|
|
|
process of pushing it into DataHub, and is particularly useful for debugging purposes.
|
2022-05-02 00:18:15 -07:00
|
|
|
Note that the [file source](../../docs/generated/ingestion/sources/file.md) can read files generated by this sink.
|
2021-08-08 16:40:51 -04:00
|
|
|
|
|
|
|
|
## Quickstart recipe
|
|
|
|
|
|
|
|
|
|
Check out the following recipe to get started with ingestion! See [below](#config-details) for full configuration options.
|
|
|
|
|
|
|
|
|
|
For general pointers on writing and running a recipe, see our [main recipe guide](../README.md#recipes).
|
|
|
|
|
|
|
|
|
|
```yml
|
|
|
|
|
source:
|
|
|
|
|
# source configs
|
|
|
|
|
|
|
|
|
|
sink:
|
|
|
|
|
type: file
|
|
|
|
|
config:
|
|
|
|
|
filename: ./path/to/mce/file.json
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
## Config details
|
|
|
|
|
|
|
|
|
|
Note that a `.` is used to denote nested fields in the YAML recipe.
|
|
|
|
|
|
|
|
|
|
| Field | Required | Default | Description |
|
|
|
|
|
| -------- | -------- | ------- | ------------------------- |
|
|
|
|
|
| filename | ✅ | | Path to file to write to. |
|
|
|
|
|
|
|
|
|
|
## Questions
|
|
|
|
|
|
|
|
|
|
If you've got any questions on configuring this sink, feel free to ping us on [our Slack](https://slack.datahubproject.io/)!
|
