Skip to content

Latest commit

 

History

History
executable file
·
64 lines (43 loc) · 1.63 KB

README.md

File metadata and controls

executable file
·
64 lines (43 loc) · 1.63 KB

Data Importer Plugin

An OpenSearch Dashboards plugin for importing your static data to OpenSearch indexes directly from Dashboards via text box or file upload. Multiple Data Source (MDS) compatible.

Data-Importer-Plugin-Demo.mov

Supported filetypes:

  • JSON (treated as 1 document)
  • CSV
  • NDJSON
  • And more (TBD)

Configurations

This plugin can be configured in your config/opensearch_dashboards.yml

# Enable the plugin
data_importer_plugin.enabled: true

# Configure which file types will be supported (by default, all 3 are enabled)
data_importer_plugin.enabledFileTypes: ['csv', 'json', 'ndjson']

# Configure file size upload limit in bytes
data_importer_plugin.maxFileSizeBytes: 100000000

# Configure character limit for text data
data_importer_plugin.maxTextCount: 10000

Pre-requisites

To function, this plugin requires OpenSearch Dashboards to be installed and configured. See the OpenSearch Dashboards contributing guide for instructions setting up your development environment.

Development

To start, fork this repo, and from the OpenSearch-Dashboards project root, run the following commands:

cd plugins

git clone <YOUR-FORKED-REPO-LINK>

To run, from the OpenSearch-Dashboards project root, run the following commands:

cd plugins/data-importer-plugin

yarn osd bootstrap

yarn osd start --no-base-path

Building

From the OpenSearch-Dashboards project root, run the following commands:

cd plugins/data-importer-plugin

yarn plugin-helpers build