VOOZH about

URL: https://www.cdata.com/kb/tech/elasticsearch-sync-csv.rst

⇱ Automated Continuous Elasticsearch Replication to Local Delimited Files

Automated Continuous Elasticsearch Replication to Local Delimited Files

👁 Jerod Johnson
Jerod Johnson
Director, Technology Evangelism
Use CData Sync for automated, continuous, customizable Elasticsearch replication to delimited files (CSV/TSV).

Always-on applications rely on automatic failover capabilities and real-time data access. CData Sync integrates live Elasticsearch data into local delimited files (CSV/TSV), allowing you to consolidate all of your data into a single location for archiving, reporting, analytics, machine learning, artificial intelligence and more.

About Elasticsearch Data Integration

Accessing and integrating live data from Elasticsearch has never been easier with CData. Customers rely on CData connectivity to:

  • Access both the SQL endpoints and REST endpoints, optimizing connectivity and offering more options when it comes to reading and writing Elasticsearch data.
  • Connect to virtually every Elasticsearch instance starting with v2.2 and Open Source Elasticsearch subscriptions.
  • Always receive a relevance score for the query results without explicitly requiring the SCORE() function, simplifying access from 3rd party tools and easily seeing how the query results rank in text relevance.
  • Search through multiple indices, relying on Elasticsearch to manage and process the query and results instead of the client machine.

Users frequently integrate Elasticsearch data with analytics tools such as Crystal Reports, Power BI, and Excel, and leverage our tools to enable a single, federated access layer to all of their data sources, including Elasticsearch.

For more information on CData's Elasticsearch solutions, check out our Knowledge Base article: CData Elasticsearch Driver Features & Differentiators.


Getting Started


Configure CSV/TSV as a Replication Destination

Using CData Sync, you can replicate Elasticsearch data to delimited files, like CSV or TSV. To add a replication destination, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select CSV as a destination. 👁 Configure a Destination connection to CSV.
  3. Enter the necessary connection properties. To connect to a directory for storing delimited files, set the following:
    • Destination Folder: Set this location on the disk for the delimited files.
    • Include Column Headers: Set this to True for the first row in each file to represent the column names.
  4. Click Test Connection to ensure that the connection is configured properly. 👁 Configure a Destination connection.
  5. Click Save Changes.

Configure the Elasticsearch Connection

You can configure a connection to Elasticsearch from the Connections tab. To add a connection to your Elasticsearch account, navigate to the Connections tab.

  1. Click Add Connection.
  2. Select a source (Elasticsearch).
  3. Configure the connection properties.

    Set the Server and Port connection properties to connect. To authenticate, set the User and Password properties, PKI (public key infrastructure) properties, or both. To use PKI, set the SSLClientCert, SSLClientCertType, SSLClientCertSubject, and SSLClientCertPassword properties.

    The data provider uses X-Pack Security for TLS/SSL and authentication. To connect over TLS/SSL, prefix the Server value with 'https://'. Note: TLS/SSL and client authentication must be enabled on X-Pack to use PKI.

    Once the data provider is connected, X-Pack will then perform user authentication and grant role permissions based on the realms you have configured.

    👁 Configuring a Source connection (Salesforce is shown).
  4. Click Connect to ensure that the connection is configured properly.
  5. Click Save Changes.

Configure Replication Queries

CData Sync enables you to control replication with a point-and-click interface and with SQL queries. For each replication you wish to configure, navigate to the Jobs tab and click Add Job. Select the Source and Destination for your replication.

👁 Select Source and Destination connections for the replication.

Replicate Entire Tables

To replicate an entire table, click Add Tables in the Tables section, choose the table(s) you wish to replicate, and click Add Selected Tables.

👁 Choose entire tables to replicate (Salesforce is shown).

Customize Your Replication

You can use the Columns and Query tabs of a task to customize your replication. The Columns tab allows you to specify which columns to replicate, rename the columns at the destination, and even perform operations on the source data before replicating. The Query tab allows you to add filters, grouping, and sorting to the replication. 👁 Configure a replication Transform.

Schedule Your Replication

In the Schedule section, you can schedule a job to run automatically, configuring the job to run after specified intervals ranging from once every 10 minutes to once every month.

👁 Schedule your job to run automatically.

Once you have configured the replication job, click Save Changes. You can configure any number of jobs to manage the replication of your Elasticsearch data to delimited files.