File

Module file

This plugin pulls metadata from a previously generated file. The file sink can produce such files, and a number of samples are included in the examples/mce_files directory.

CLI based Ingestion

Install the Plugin

The file source works out of the box with acryl-datahub.

Starter Recipe

Check out the following recipe to get started with ingestion! See below for full configuration options.

For general pointers on writing and running a recipe, see our main recipe guide.

source:
  type: file
  config:
    # Coordinates
    filename: ./path/to/mce/file.json

sink:
  # sink configs

Config Details

Options

Note that a . is used to denote nested fields in the YAML recipe.

View All Configuration Options

Field	Required	Type	Description	Default
filename		string	[deprecated in favor or path] The file to ingest.	None
path	✅	string	Path to folder or file to ingest. If pointed to a folder, all files with extension {file_extension} (default json) within that folder will be processed.	None
file_extension		string	When providing a folder to use to read files, set this field to control file extensions that you want the source to process. * is a special value that means process every file regardless of extension	.json
read_mode		enum(FileReadMode)	Allowed symbols are STREAM, BATCH, AUTO	AUTO
aspect		string	Set to an aspect to only read this aspect for ingestion.	None

Schema

The JSONSchema for this configuration is inlined below.

{
  "title": "FileSourceConfig",
  "type": "object",
  "properties": {
    "filename": {
      "title": "Filename",
      "description": "[deprecated in favor or `path`] The file to ingest.",
      "type": "string"
    },
    "path": {
      "title": "Path",
      "description": "Path to folder or file to ingest. If pointed to a folder, all files with extension {file_extension} (default json) within that folder will be processed.",
      "type": "string",
      "format": "path"
    },
    "file_extension": {
      "title": "File Extension",
      "description": "When providing a folder to use to read files, set this field to control file extensions that you want the source to process. * is a special value that means process every file regardless of extension",
      "default": ".json",
      "type": "string"
    },
    "read_mode": {
      "default": "AUTO",
      "allOf": [
        {
          "$ref": "#/definitions/FileReadMode"
        }
      ]
    },
    "aspect": {
      "title": "Aspect",
      "description": "Set to an aspect to only read this aspect for ingestion.",
      "type": "string"
    }
  },
  "required": [
    "path"
  ],
  "additionalProperties": false,
  "definitions": {
    "FileReadMode": {
      "title": "FileReadMode",
      "description": "An enumeration.",
      "enum": [
        "STREAM",
        "BATCH",
        "AUTO"
      ]
    }
  }
}

Code Coordinates

• Class Name: datahub.ingestion.source.file.GenericFileSource
• Browse on GitHub

Questions

If you've got any questions on configuring ingestion for File, feel free to ping us on our Slack