> For the complete documentation index, see [llms.txt](https://docs.syntho.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.syntho.ai/setup-workspaces/create-a-workspace/connect-to-a-database/local-filesystem.md).

# Local filesystem

{% hint style="info" %}
**Syntho beta feature**
{% endhint %}

The local filesystem connector enables data writing to a specified path in the host's local filesystem. To utilize this connector, specific configuration steps are required to ensure proper functionality.

<figure><img src="/files/2mj7M0z1okJ5hZyE93ro" alt=""><figcaption><p>Source and Destination Databases</p></figcaption></figure>

{% hint style="info" %}
**Destination Only**

This connector can only be used as a destination for writing your generated data.

Supported File Types: Parquet and ORC
{% endhint %}

## **Before you begin**

#### **Environment variable setup**:

Before running the Syntho application, declare the environment variable `SYNTHO_LOCALFS`. This variable should be set to the desired path in the host local filesystem where the data will be written.\
Example:

```bash
export SYNTHO_LOCALFS="/path/on/host"
```

Alternatively, you can declare the environment variable when running Docker:

```bash
SYNTHO_LOCALFS="/path/on/host" docker-compose up
```

**Note**: It is recommended to declare the environment variable using `export`.

## **Usage**

* **Destination Only**: The Local Filesystem connector can only be used as a target destination.
* **Parameter Requirement**: The only required parameter is `path`. The value of this parameter will be concatenated with the value of `SYNTHO_LOCALFS`, and the resulting path will be where the data is written.

#### **Example**

If `SYNTHO_LOCALFS` is set to `/mnt/data` and the `path` parameter is `output`, the data will be written to `/mnt/data/output`.

This configuration allows the Syntho application to write data to the local filesystem, ensuring compatibility with various deployment environments without affecting other users who do not require this functionality.

## Connect and set up the workspace

Launch Syntho and select Connect to a database, or under Create workspace, select Local Filesystem. Then do the following:

1. Enter the local target path where the data will be written.
2. Choose a file format: Parquet or ORC.
3. Select Create Workspace.

If Syntho can't make the connection, verify that the target path is correct. If you still can't connect, contact your database administrator.

## File formats

Supported file type formats include:

* Parquet
* ORC

## Limitations & considerations

* For ORC files, columns full of None values which are of type Char, String, or Varchar will be written as "None" (i.e., a string value) to the destination database instead of None.
* Local Filesystem connector is only supported for Docker Compose.

Contact your Syntho representative to discuss possible limitations regarding this connector.


---

# 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.syntho.ai/setup-workspaces/create-a-workspace/connect-to-a-database/local-filesystem.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.