Skip to content
This repository has been archived by the owner on Feb 2, 2022. It is now read-only.
/ airbyte Public archive
forked from airbytehq/airbyte

Latest commit

 

History

History
69 lines (49 loc) · 2.9 KB

elasticsearch.md

File metadata and controls

69 lines (49 loc) · 2.9 KB

Elasticsearch

Sync overview

Output schema

Elasticsearch is a Lucene based search engine that's a type of NoSql storage.
Documents are created in an index, similar to a tablein a relation database.

The output schema matches the input schema of a source. Each source stream becomes a destination index.
For example, in with a relational database source -
The DB table name is mapped to the destination index. The DB table columns become fields in the destination document.
Each row becomes a document in the destination index.

Data type mapping

See Elastic documentation for detailed information about the field types This section should contain a table mapping each of the connector's data types to Airbyte types. At the moment, Airbyte uses the same types used by JSONSchema. string, date-time, object, array, boolean, integer, and number are the most commonly used data types.

Integration Type Airbyte Type Notes
text string more info
date date-time more info
object object more info
array array more info
boolean boolean more info
numeric integer more info
numeric number more info

Features

This section should contain a table with the following format:

Feature Supported?(Yes/No) Notes
Full Refresh Sync yes
Incremental Sync yes
Replicate Incremental Deletes no
SSL connection yes
SSH Tunnel Support ??

Performance considerations

Batch/bulk writes are performed. Large records may impact performance.
The connector should be enhanced to support variable batch sizes.

Getting started

Requirements

  • Elasticsearch >= 7.x
  • Configuration
    • Endpoint URL [ex. https://elasticsearch.savantly.net:9423]
    • Port number [defaults to 9002]
    • Username [optional] (basic auth)
    • Password [optional] (basic auth)
    • Api key ID [optional]
    • Api key secret [optional]
  • If authentication is used, the user should have permission to create an index if it doesn't exist, and/or be able to create documents

Setup guide

Enter the hostname and/or other configuration information ...

TODO: more info, screenshots?, etc...