package
Version:
v0.13.0
Opens a new window with list of versions in this module.
Published: Apr 19, 2026
License: Apache-2.0
Opens a new window with license information.
Imports: 10
Opens a new window with list of imports.
Imported by: 0
Opens a new window with list of known importers.
README
¶
Elasticsearch
Extract index metadata from an Elasticsearch cluster.
Usage
source:
name: elastic
config:
host: http://localhost:9200
user: elastic
password: changeme
Configuration
| Key |
Type |
Required |
Description |
host |
string |
Yes |
Host address of the Elasticsearch server (include scheme). |
user |
string |
No |
Username for authentication. |
password |
string |
No |
Password for authentication. |
Entities
- Entity type:
table
- URN format:
urn:elasticsearch:{scope}:index:{index_name}
| Property |
Type |
Description |
properties.columns |
[]object |
List of column objects from the index mapping. |
properties.columns[].name |
string |
Field name. |
properties.columns[].data_type |
string |
Elasticsearch field type (e.g. text, keyword). |
properties.profile.total_rows |
int |
Number of documents in the index (omitted if zero). |
properties.number_of_shards |
string |
Number of primary shards for the index. |
properties.number_of_replicas |
string |
Number of replica shards for the index. |
Edges
This extractor does not emit edges.
Contributing
Refer to the contribution guidelines for information on contributing to this module.
Documentation
¶
type Config struct {
User string `json:"user" yaml:"user" mapstructure:"user"`
Password string `json:"password" yaml:"password" mapstructure:"password"`
Host string `json:"host" yaml:"host" mapstructure:"host" validate:"required"`
}
type Extractor struct {
}
Extractor manages the extraction of data from elastic
New returns a pointer to an initialized Extractor Object
Extract extracts the data from the elastic server
and collected through the emitter
Init initializes the extractor
Source Files
¶
Click to show internal directories.
Click to hide internal directories.