Create a Local Files Read Component

This guide explains how to create a Read Component that ingests data from files on your local file system. You'll learn how to configure file paths and format settings to efficiently read data from files stored on your machine.

Prerequisites

• Ascend Flow
• [Local File System Connection]

Create a new Component

Begin from your workspace Super Graph view. Follow these steps to create your component:

Using the Component Form

1. Double-click the Flow where you want to create your component
2. Right-click anywhere in the Flow Graph
3. Hover over Create Component, then over Read in the expanded menu, and click From Scratch
4. Complete the form with these details:
   • Select your Flow
   • Enter a descriptive Component Name like read_sales
   • Select YAML as your file type

Using the Files Panel

1. Open the files panel in the top left corner
2. Navigate to and select your desired Flow
3. Right-click on the components directory and choose New file
4. Name your file with a descriptive name like read_sales.yaml and press enter

Create your Local Files Read Component

Structure your Local Files Read Component following this pattern:

1. Reference your local file connection: Specify which local file connection to read from
2. Add the local_file key: Configure the specific local file settings
   • path: Specify the path to the file or directory to read from
3. Add parser settings: Specify how to parse the file contents
4. Additional options: Include any file-specific settings

Example

read_local.yaml

component:
  read:
    connection: read_local_files
    local_file:
      parser: auto
      path: my_file.csv

This example shows a simple configuration to:

• Read a specific CSV file (my_file.csv) from your local file system
• Use the connection named read_local_files that you've previously set up
• Use automatic format detection for parsing the file

For a complete list of configuration options and advanced settings, see this reference guide.

🎉 Congratulations! You successfully created a Local Files Read Component in Ascend.