File Connector Integration Guide

Last updated on 
File Connector Integration Guide

Introduction

The File Connector enables seamless integration with your storage account, empowering users to manage files within a specified container. This guide provides comprehensive instructions on configuring and utilizing the File Connector within your application.

Getting Started with File Connector

To begin using the File Connector, follow these steps:

  1. Create a Storage Account: Establish a storage account with your preferred cloud provider (e.g., AWS S3, Azure Blob Storage, Google Cloud Storage).
  2. Generate Account Credentials: Obtain the necessary credentials for your storage account, such as access keys, API keys, or service account keys.

Configuring the File Connector

Once you have your storage account and credentials, configure the File Connector with the following settings:

  • storage_provider: Specify the cloud provider (e.g., aws, azure, gcp).
  • account_name: The name of your storage account.
  • container_name: The name of the container where files will be managed.
  • credentials: Your storage account credentials (formatted according to the chosen provider).

Configuration Example

file_connector:
storage_provider: aws
account_name: my_aws_bucket
container_name: my_container
credentials:
access_key_id: YOUR_ACCESS_KEY_ID
secret_access_key: YOUR_SECRET_ACCESS_KEY

Utilizing the File Connector

The File Connector supports various functionalities for file management:

  • Creating Files: Upload new files to the specified container.
  • Deleting Files: Remove files from the specified container.
  • Updating Files: Modify the content of existing files in the specified container.
  • Searching Files: Find files in the specified container that match a given pattern.

Actions

The table below details the available actions within the File Connector:

Best Practices

  • Optimize File Management: Employ efficient file organization within containers and use descriptive file names.
  • Error Handling: Implement robust error handling mechanisms to address potential issues during file operations.
  • Security: Safeguard your storage account credentials to prevent unauthorized access.

Conclusion

The File Connector offers a versatile solution for managing files within your storage account. By leveraging its capabilities, you can streamline data handling and enhance productivity. Effective configuration and utilization of the File Connector empower you to harness the full potential of your storage platform for efficient file management.