Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
274 changes: 274 additions & 0 deletions docs/1-using/5-connectors/7-list/1-elasticsearch.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,274 @@
---
IMPORTANT: This file was generated using src/connectorgen/main.go. DO NOT EDIT.

title: "elasticsearch"
description: "An Elasticsearch destination plugin for Conduit."
---

import ReactDiffViewer from 'react-diff-viewer-continued';
import Chip from '@mui/material/Chip';
import Box from "@mui/system/Box";
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
import GitHubIcon from '@mui/icons-material/GitHub';
import IconButton from '@mui/material/IconButton';
import Stack from '@mui/material/Stack';
import Link from '@mui/material/Link';
import StarIcon from '@mui/icons-material/Star';
import Tooltip from '@mui/material/Tooltip';

# elasticsearch

<Box sx={{
display: 'flex',
alignItems: 'center',
gap: 2,
marginBottom: 4,
borderRadius: 1,
padding: 2,
backgroundColor: 'rgba(0, 0, 0, 0.03)'
}}>
{/* Author info */}
<Box sx={{ display: 'flex', alignItems: 'center', gap: 1 }}>
<span>Author: Miquido, Meroxa, Inc.</span>
<Tooltip title="Created by the Conduit team">
<img src='/img/conduit/conduit-ring.png' width='18' alt="Conduit team logo" />
</Tooltip>
</Box>

{/* Divider */}
<Box sx={{ borderLeft: '1px solid rgba(0, 0, 0, 0.12)', height: 24 }} />

{/* GitHub link */}
<Link
href="https://github.com/ConduitIO/conduit-connector-elasticsearch"
target="_blank"
sx={{
display: 'flex',
alignItems: 'center',
gap: 0.5,
color: 'inherit',
textDecoration: 'none',
'&:hover': {
textDecoration: 'underline'
}
}}
>
<GitHubIcon sx={{ fontSize: '1.5rem' }} />
</Link>

{/* Stars */}
<Chip
icon={<StarIcon sx={{ fontSize: '1rem' }} />}
label="0"
size="small"
sx={{ height: 24 }}
/>
</Box>

## Latest release

- [conduit-connector-elasticsearch_0.6.0_Darwin_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Darwin_arm64.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Darwin_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Darwin_x86_64.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Linux_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Linux_arm64.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Linux_i386.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Linux_i386.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Linux_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Linux_x86_64.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Windows_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Windows_arm64.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Windows_i386.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Windows_i386.tar.gz)
- [conduit-connector-elasticsearch_0.6.0_Windows_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/conduit-connector-elasticsearch_0.6.0_Windows_x86_64.tar.gz)
- [elasticsearch_v0.6.0_darwin_amd64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_darwin_amd64.tar.gz)
- [elasticsearch_v0.6.0_darwin_amd64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_darwin_amd64.tar.gz.sigstore.json)
- [elasticsearch_v0.6.0_darwin_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_darwin_arm64.tar.gz)
- [elasticsearch_v0.6.0_darwin_arm64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_darwin_arm64.tar.gz.sigstore.json)
- [elasticsearch_v0.6.0_linux_amd64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_linux_amd64.tar.gz)
- [elasticsearch_v0.6.0_linux_amd64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_linux_amd64.tar.gz.sigstore.json)
- [elasticsearch_v0.6.0_linux_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_linux_arm64.tar.gz)
- [elasticsearch_v0.6.0_linux_arm64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-elasticsearch/releases/download/v0.6.0/elasticsearch_v0.6.0_linux_arm64.tar.gz.sigstore.json)

## Description

The Conduit plugin supporting Elasticsearch destination.

## Source Parameters

```yaml
version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example-source
type: source
plugin: "elasticsearch"
name: example-source
settings:
# The Elasticsearch host and port (e.g.: http://127.0.0.1:9200).
# Type: string
host: ""
# The version of the Elasticsearch service. One of: 5, 6, 7, 8.
# Type: string
version: ""
# Base64-encoded token for authorization; if set, overrides
# username/password and service token.
# Type: string
APIKey: ""
# The number of items stored in bulk in the index. The minimum value
# is `1`, maximum value is `10000`.
# Type: int
batchSize: "1000"
# SHA256 hex fingerprint given by Elasticsearch on first launch.
# Type: string
certificateFingerprint: ""
# Endpoint for the Elastic Service (https://elastic.co/cloud).
# Type: string
cloudID: ""
# The sortby field for each index to be used by elasticsearch search
# api.
# Type: string
indexes.*.sortBy: "_seq_no"
# The sortOrder(asc or desc) for each index to be used by
# elasticsearch search api.
# Type: string
indexes.*.sortOrder: "asc"
# The password for HTTP Basic Authentication.
# Type: string
password: ""
# This period is used by workers to poll for new data at regular
# intervals.
# Type: duration
pollingPeriod: "5s"
# The maximum number of retries of failed operations.
# Type: int
retries: "0"
# Service token for authorization; if set, overrides
# username/password.
# Type: string
serviceToken: ""
# The username for HTTP Basic Authentication.
# Type: string
username: ""
# Maximum delay before an incomplete batch is read from the source.
# Type: duration
sdk.batch.delay: "0"
# Maximum size of batch before it gets read from the source.
# Type: int
sdk.batch.size: "0"
# Specifies whether to use a schema context name. If set to false, no
# schema context name will be used, and schemas will be saved with the
# subject name specified in the connector (not safe because of name
# conflicts).
# Type: bool
sdk.schema.context.enabled: "true"
# Schema context name to be used. Used as a prefix for all schema
# subject names. If empty, defaults to the connector ID.
# Type: string
sdk.schema.context.name: ""
# Whether to extract and encode the record key with a schema.
# Type: bool
sdk.schema.extract.key.enabled: "false"
# The subject of the key schema. If the record metadata contains the
# field "opencdc.collection" it is prepended to the subject name and
# separated with a dot.
# Type: string
sdk.schema.extract.key.subject: "key"
# Whether to extract and encode the record payload with a schema.
# Type: bool
sdk.schema.extract.payload.enabled: "true"
# The subject of the payload schema. If the record metadata contains
# the field "opencdc.collection" it is prepended to the subject name
# and separated with a dot.
# Type: string
sdk.schema.extract.payload.subject: "payload"
# The type of the payload schema.
# Type: string
sdk.schema.extract.type: "avro"
```

## Destination Parameters

```yaml
version: 2.2
pipelines:
- id: example
status: running
connectors:
- id: example-destination
type: destination
plugin: "elasticsearch"
name: example-destination
settings:
# The Elasticsearch host and port (e.g.: http://127.0.0.1:9200).
# Type: string
host: ""
# The version of the Elasticsearch service. One of: 5, 6, 7, 8.
# Type: string
version: ""
# Base64-encoded token for authorization; if set, overrides
# username/password and service token.
# Type: string
APIKey: ""
# The number of items stored in bulk in the index. The minimum value
# is `1`, maximum value is `10 000`.
# Type: int
bulkSize: "1000"
# SHA256 hex fingerprint given by Elasticsearch on first launch.
# Type: string
certificateFingerprint: ""
# Endpoint for the Elastic Service (https://elastic.co/cloud).
# Type: string
cloudID: ""
# The name of the index to write the data to.
# Type: string
index: "{{ index .Metadata "opencdc.collection" }}"
# The password for HTTP Basic Authentication.
# Type: string
password: ""
# The maximum number of retries of failed operations. The minimum
# value is `0` which disabled retry logic. The maximum value is `255.
# Type: int
retries: "0"
# Service token for authorization; if set, overrides
# username/password.
# Type: string
serviceToken: ""
# The name of the index's type to write the data to.
# Type: string
type: ""
# The username for HTTP Basic Authentication.
# Type: string
username: ""
# Maximum delay before an incomplete batch is written to the
# destination.
# Type: duration
sdk.batch.delay: "0"
# Maximum size of batch before it gets written to the destination.
# Type: int
sdk.batch.size: "0"
# Allow bursts of at most X records (0 or less means that bursts are
# not limited). Only takes effect if a rate limit per second is set.
# Note that if `sdk.batch.size` is bigger than `sdk.rate.burst`, the
# effective batch size will be equal to `sdk.rate.burst`.
# Type: int
sdk.rate.burst: "0"
# Maximum number of records written per second (0 means no rate
# limit).
# Type: float
sdk.rate.perSecond: "0"
# The format of the output record. See the Conduit documentation for a
# full list of supported formats
# (https://conduitdata.io/docs/using/connectors/configuration-parameters/output-format).
# Type: string
sdk.record.format: "opencdc/json"
# Options to configure the chosen output record format. Options are
# normally key=value pairs separated with comma (e.g.
# opt1=val2,opt2=val2), except for the `template` record format, where
# options are a Go template.
# Type: string
sdk.record.format.options: ""
# Whether to extract and decode the record key with a schema.
# Type: bool
sdk.schema.extract.key.enabled: "true"
# Whether to extract and decode the record payload with a schema.
# Type: bool
sdk.schema.extract.payload.enabled: "true"
```
Original file line number Diff line number Diff line change
Expand Up @@ -68,22 +68,6 @@ import Tooltip from '@mui/material/Tooltip';

## Latest release

- [conduit-connector-file_0.10.8_Darwin_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Darwin_arm64.tar.gz)
- [conduit-connector-file_0.10.8_Darwin_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Darwin_x86_64.tar.gz)
- [conduit-connector-file_0.10.8_Linux_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Linux_arm64.tar.gz)
- [conduit-connector-file_0.10.8_Linux_i386.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Linux_i386.tar.gz)
- [conduit-connector-file_0.10.8_Linux_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Linux_x86_64.tar.gz)
- [conduit-connector-file_0.10.8_Windows_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Windows_arm64.tar.gz)
- [conduit-connector-file_0.10.8_Windows_i386.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Windows_i386.tar.gz)
- [conduit-connector-file_0.10.8_Windows_x86_64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/conduit-connector-file_0.10.8_Windows_x86_64.tar.gz)
- [file_v0.10.8_darwin_amd64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_darwin_amd64.tar.gz)
- [file_v0.10.8_darwin_amd64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_darwin_amd64.tar.gz.sigstore.json)
- [file_v0.10.8_darwin_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_darwin_arm64.tar.gz)
- [file_v0.10.8_darwin_arm64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_darwin_arm64.tar.gz.sigstore.json)
- [file_v0.10.8_linux_amd64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_linux_amd64.tar.gz)
- [file_v0.10.8_linux_amd64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_linux_amd64.tar.gz.sigstore.json)
- [file_v0.10.8_linux_arm64.tar.gz](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_linux_arm64.tar.gz)
- [file_v0.10.8_linux_arm64.tar.gz.sigstore.json](https://conduit.gateway.scarf.sh/connector/download/ConduitIO/conduit-connector-file/releases/download/v0.10.8/file_v0.10.8_linux_arm64.tar.gz.sigstore.json)

## Description

Expand Down Expand Up @@ -192,7 +176,7 @@ pipelines:
sdk.rate.perSecond: "0"
# The format of the output record. See the Conduit documentation for a
# full list of supported formats
# (https://conduit.io/docs/using/connectors/configuration-parameters/output-format).
# (https://conduitdata.io/docs/using/connectors/configuration-parameters/output-format).
# Type: string
sdk.record.format: "opencdc/json"
# Options to configure the chosen output record format. Options are
Expand Down
Loading