> For the complete documentation index, see [llms.txt](https://docs.personify.be/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.personify.be/concepts/connectors/file-connector.md).

# File connector

The File connector is a implementation used for writing and reading from a file.

This is a basic implementation with only a index on primary key. 

Advice is to limit the file-size to a maximum of 1.000.000 entries. This could be optimized in the future by using a RandomAccessFile.

The id record is always supposed to be first and the very first line is to be used as the header

## Configuration <a href="#configuration" id="configuration"></a>

Below are all the parameters you can specify on this connector.

| name      | description                        |
| --------- | ---------------------------------- |
| fileName  | the name of the file               |
| separator | separator used to separate entries |

## Supported functions <a href="#supported-functions" id="supported-functions"></a>

Below are the implemented operations on this connector.

| name      | supported | description                                               |
| --------- | --------- | --------------------------------------------------------- |
| create    | yes       | appends to the end of the file                            |
| find      | yes       | finds by id                                               |
| search    | yes       | finds on equals criteria without paging/sorting (/search) |
| update    | yes       | updates                                                   |
| delete    | yes       | deletes                                                   |
| disable   | no        |                                                           |
| archive   | no        |                                                           |
| unarchive | no        |                                                           |
| ping      | yes       | tests if the file is present                              |
| validate  | yes       | validates the configuration on init                       |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.personify.be/concepts/connectors/file-connector.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.