---
title: Dataro Agent Technical Details
description: Results can be exported as either zipped CSV files (using --format csv) or Parquet files with gzip compression (using --format parquet). N.b. CSV exports will be deprecated in future. Typically the ag
---

[Skip to content](https://support.dataro.io/knowledge/dataro-agent-technical-details#main-content)

English

Show submenu for translations

[Log a ticket](https://support.dataro.io/knowledge/kb-tickets/new?hsLang=en)

![Dataro Logo Small.png\]](https://support.dataro.io/hs-fs/hubfs/Dataro%20Logo%20Small.png?height=40&name=Dataro%20Logo%20Small.png)

Open main navigation

Close main navigation

- English
  
  Show submenu for translations
- [Log a ticket](https://support.dataro.io/knowledge/kb-tickets/new)
- Login to Dataro

 Login to Dataro

 Search the Knowledge Base

- There are no suggestions because the search field is empty.

1. [Dataro Help Centre](https://support.dataro.io/knowledge?hsLang=en)
2. [Connections & Data](https://support.dataro.io/knowledge/connections-data?hsLang=en)
3. [Dataro Agent](https://support.dataro.io/knowledge/connections-data?hsLang=en#dataro-agent)

# Dataro Agent Technical Details

### Export Formats

Results can be exported as either zipped CSV files (using **--format csv**) or Parquet files with gzip compression (using **--format parquet**). N.b. CSV exports will be deprecated in future.

### Database Accounts

- A database account (as opposed to Windows Authentication) is required for scheduled operation.
- It is the client's responsibility to ensure that the database account has only select privileges on the required tables.

### Installation Instructions

- Dataro will provide a zip file containing: 
    - **dataro\_agent.exe**
    - **dataro\_queries.sql**
    - **dataro\_sftp.key**
    - **config.ini**
- Unzip these files into a directory accessible to the user who will own the scheduled tasks i.e. C:\\dataro. We will call this the 'working directory'.
- Edit the config.ini to include the database host, name, username and password. We suggest that you encrypt the database username and password using the method described below.
- Open a command window and navigate to the working directory.
- Run the following command to confirm that the agent is configured correctly:

```
dataro_agent.exe --mode export --config_file config.ini --key_file dataro_sftp.key --query_file dataro_queries_test.sql --format csv --scheduled False
```

- If the program completes without issue, then proceed to setting up for Scheduled Operation.

### Scheduled operation

Typically the agent will be scheduled using Windows Task Scheduler.

#### Export

```
dataro_agent.exe --mode export --config_file config.ini --key_file dataro_sftp.key --query_file dataro_queries.sql --format csv --scheduled True
```

```
Triggers    On a schedule    Daily    Every 1 Day    (Time is as per client's requirements)Actions    Start a Program    Program/Script: C:/dataro/dataro_agent.exe    Add Arguments: --mode export --config_file config.ini --key_file dataro_sftp.key --query_file dataro_queries.sql --format csv --scheduled True    Start in: C:/dataro/
```

#### Import

```
dataro_agent.exe --mode import --config_file config.ini --key_file dataro_sftp.key --scheduled True
```

```
Triggers    On a schedule    Daily    Every 1 Day    (Time is as per client's requirements -- approximately. 3 hours after the export)Actions    Start a Program    Program/Script: C:/dataro/dataro_agent.exe    Add Arguments: --mode import --config_file config.ini --key_file dataro_sftp.key --query_file dataro_queries.sql --format csv --scheduled True    Start in: C:/dataro/
```

### Encrypting values in the .ini file

We suggest that you encrypt data such as database password before storing in the ini file.

The Agent has built-in functionality to encrypt strings and decrypt encrypted values in the ini file.

The example below demonstrates how to encrypt a database password and save in the ini file.

```
dataro_agent.exe --enc MySecretPassword123
```

This will generate some logs in the console, look for one like 'This is the encrypted text':

![](https://support.dataro.io/hubfs/image-png-1.png)

Copy the string starting from (and including) 'enc\_' and paste this into the config file:

![](https://support.dataro.io/hubfs/image-png-2.png)

Now, when you run the agent normally, it will identify an encrypted string by the 'enc\_' starting characters and decrypt the value inside the program.

### CLI Arguments

```
optional arguments:  -h, --help            show this help message and exit  --config_file [CONFIG_FILE]                        Config file name  --key_file [KEY_FILE]                        SFTP Private Key File  --query_file [QUERY_FILE]                        Dataro SQL File  --copy_only [COPY_ONLY]                        Only do sftp copy  --scheduled [SCHEDULED]                        Don't require key return at the end.  --mode [MODE]         Export or Import data  --format [FORMAT]     csv or parquet data  --db_update_script [DB_UPDATE_SCRIPT]                        Filename of custom script to synchronise database  --enc [ENC]           Encrypt a string for usage in ini files
```

 

- [Dataro 3.0](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#main-content)
  
  
  
  
  
    - [Getting Started](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#getting-started)
    - [Audiences](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#audiences)
    - [Insights](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#insights)
    - [ProspectAI](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#prospectai)
    - [Playbooks](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#playbooks)
    - [Audience Builder](https://support.dataro.io/knowledge/dataro-3-0?hsLang=en#audience-builder)
- [Introduction to Dataro](https://support.dataro.io/knowledge/introduction-to-dataro?hsLang=en#main-content)
  
  
  
  
  
    - [Overview](https://support.dataro.io/knowledge/introduction-to-dataro?hsLang=en#overview)
    - [Onboarding](https://support.dataro.io/knowledge/introduction-to-dataro?hsLang=en#onboarding)
- [Audience Building](https://support.dataro.io/knowledge/audience-building?hsLang=en#main-content)
  
  
  
  
  
    - [Individual Donor View](https://support.dataro.io/knowledge/audience-building?hsLang=en#individual-donor-view)
    - [Building Audiences](https://support.dataro.io/knowledge/audience-building?hsLang=en#building-audiences)
    - [Using Audiences](https://support.dataro.io/knowledge/audience-building?hsLang=en#using-audiences)
- [Reporting](https://support.dataro.io/knowledge/reporting?hsLang=en#main-content)
  
  
  
  
  
    - [Campaign Insights](https://support.dataro.io/knowledge/reporting?hsLang=en#campaign-insights)
    - [Fundraising Insights](https://support.dataro.io/knowledge/reporting?hsLang=en#fundraising-insights)
    - [Reports & Dashboards](https://support.dataro.io/knowledge/reporting?hsLang=en#reports-dashboards)
    - [Reporting FAQ](https://support.dataro.io/knowledge/reporting?hsLang=en#reporting-faq)
- [Predictions](https://support.dataro.io/knowledge/predictions?hsLang=en#main-content)
  
  
  
  
  
    - [What models are available?](https://support.dataro.io/knowledge/predictions?hsLang=en#what-models-are-available)
    - [Model Features & FAQ](https://support.dataro.io/knowledge/predictions?hsLang=en#model-features-faq)
    - [Model Performance](https://support.dataro.io/knowledge/predictions?hsLang=en#model-performance)
- [ProspectAI](https://support.dataro.io/knowledge/prospectai?hsLang=en)
- [Playbooks](https://support.dataro.io/knowledge/playbooks?hsLang=en#main-content)
  
  
  
  
  
    - [Appeals HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#appeals-hq)
    - [Recurring Giving HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#recurring-giving-hq)
    - [Mid-Level Giving HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#mid-level-giving-hq)
    - [Major Giving HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#major-giving-hq)
    - [Legacy Giving HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#legacy-giving-hq)
    - [Digital Marketing HQ](https://support.dataro.io/knowledge/playbooks?hsLang=en#digital-marketing-hq)
- [Connections & Data](https://support.dataro.io/knowledge/connections-data?hsLang=en#main-content)
  
  
  
  
  
    - [Data Hub](https://support.dataro.io/knowledge/connections-data?hsLang=en#data-hub)
    - [Data FAQ](https://support.dataro.io/knowledge/connections-data?hsLang=en#data-faq)
    - [Salesforce](https://support.dataro.io/knowledge/connections-data?hsLang=en#salesforce)
    - [Blackbaud Raiser's Edge NXT](https://support.dataro.io/knowledge/connections-data?hsLang=en#blackbaud-raisers-edge-nxt)
    - [Blackbaud CRM](https://support.dataro.io/knowledge/connections-data?hsLang=en#blackbaud-crm)
    - [Blackbaud RE7](https://support.dataro.io/knowledge/connections-data?hsLang=en#blackbaud-re7)
    - [Microsoft Dynamics](https://support.dataro.io/knowledge/connections-data?hsLang=en#microsoft-dynamics)
    - [Donorfy](https://support.dataro.io/knowledge/connections-data?hsLang=en#donorfy)
    - [ThankQ CRM](https://support.dataro.io/knowledge/connections-data?hsLang=en#thankq-crm)
    - [Dataro Agent](https://support.dataro.io/knowledge/connections-data?hsLang=en#dataro-agent)
    - [Other integrations](https://support.dataro.io/knowledge/connections-data?hsLang=en#other-integrations)
    - [Salesforce ECA](https://support.dataro.io/knowledge/connections-data?hsLang=en#salesforce-eca)
- [Content Creation](https://support.dataro.io/knowledge/content-creation?hsLang=en#main-content)
  
  
  
  
  
    - [AI Assist](https://support.dataro.io/knowledge/content-creation?hsLang=en#ai-assist)
- [Accounts and Settings](https://support.dataro.io/knowledge/accounts-and-settings?hsLang=en)
- [Security & Privacy](https://support.dataro.io/knowledge/security-privacy?hsLang=en)

[![Chill listening crop-3](https://support.dataro.io/hs-fs/hubfs/Dataro_logo_black-1-1024x256.png?width=96&height=24&name=Dataro_logo_black-1-1024x256.png "Chill listening crop-3")](https://dataro.io)

Copyright © 2026, Dataro