Skip to main content

File

The file destination allows you to write data to a file. This destination is used in conjunction with the file source.

To use the file destination, you will need to install the Mycelial Daemon on the computer that has access to the file. Refer to the CLI documentation for instructions on how to install the Mycelial Daemon.

Configuration​

The Mycelial Daemon uses a TOML configuration file to specify the data sources and destinations that it has available to it. To add a file as a data destination, you will need to add a section to the TOML file (config.toml) that looks like this:

[[destinations]]
type = "file"
display_name = "file destination"
path = "/path/to/file.csv"

type​

The type field specifies the type of data destination, in this case it is file.

display_name​

The display_name field is the name that will be displayed in the Mycelial user interface and via the API.

path​

The path field is the path to the file.

Configuration via CLI​

Prerequisites​

You will need to have the Mycelial CLI installed. Refer to the CLI documentation for instructions on how to install the Mycelial CLI.

Create a new config.toml file or add to an existing one​

If you are creating a new config.toml file, you can use the Mycelial CLI init command to generate the file and add the source.

If you are adding to an existing config file you can use the Mycelial CLI add command to add the source to the existing config.

Choose source config options​

When prompted with What would you like to do?, press the down arrow to highlight Add Destination and press return (⏎).

? What would you like to do? ›
  Add Source 
❯ Add Destination ⏎
  Exit

When prompted with What type of destination would you like to add?, press the down arrow to highlight File destination and press return (⏎).

? What type of destination would you like to add? ›
  SQLite destination 
  Postgres destination
  MySQL destination
  Kafka destination
  Snowflake destination
❯ File destination ⏎
  Cancel

When prompted for the Display Name press return (⏎) to accept the default or enter a name for your destination and press return (⏎). The display name is the name that will be displayed in the Mycelial user interface and via the API.

? Display name: (file destination) › ⏎

When prompted for the Path enter the path to the file and press return (⏎).

? Path: (file.txt) › /path/to/file.csv ⏎

When prompted with What would you like to do?, press the down arrow to highlight Exit and press return (⏎).

? What would you like to do? ›
  Add Source
  Add Destination
❯ Exit ⏎

After exiting the CLI will generate or save the modified config.toml.

Usage​

After you have added the SQLite destination to the config.toml file, either manually or via the CLI, you can start the Mycelial Daemon. Once the daemon is running, you can open the Mycelial control plane web interface and you should see the file destination listed in the sources section.