elasticsearch-faker 0.1.1

elasticsearch-faker is a CLI tool to generate fake data for Elasticsearch.

elasticsearch-faker

• Summary

• Installation

  • Installation: pip

  • Installation: dpkg (Ubuntu)

  • Installation: Docker container

• Usage

• Dependencies

Summary

elasticsearch-faker is a CLI tool to generate fake data for Elasticsearch.

Installation

Installation: pip

pip install elasticsearch-faker

Installation: dpkg (Ubuntu)

1. Navigate to Releases page

2. Download the latest deb package

3. Install with dpkg -i command

Installation: Docker container

https://github.com/thombashi/elasticsearch-faker/pkgs/container/elasticsearch-faker

Usage

Command help

Usage: elasticsearch-faker [OPTIONS] COMMAND [ARGS]...

  Faker for Elasticsearch.

Options:
  --version                       Show the version and exit.
  --debug                         For debug print.
  -q, --quiet                     Suppress execution log messages.
  -v, --verbose
  --locale [ar_EG|ar_PS|ar_SA|bs_BA|bg_BG|cs_CZ|de_DE|dk_DK|el_GR|en_AU|en_CA|en_GB|en_NZ|en_US|es_ES|es_MX|et_EE|fa_IR|fi_FI|fr_FR|hi_IN|hr_HR|hu_HU|it_IT|ja_JP|ko_KR|lt_LT|lv_LV|ne_NP|nl_NL|no_NO|pl_PL|pt_BR|pt_PT|ro_RO|ru_RU|sl_SI|sv_SE|tr_TR|uk_UA|zh_CN|zh_TW|ka_GE]
                                  Specify localization for fake data. Defaults
                                  to en_US.
  --seed INTEGER
  -h, --help                      Show this message and exit.

Commands:
  generate    Generate fake data and put it to an Elasticsearch index.
  provider    Show or search providers for template.
  show-stats  Fetch and show statistics of an index.
  validate    Check that a faker template file is well formed.
  version     Show version information.

  Issue tracker: https://github.com/thombashi/elasticsearch-faker/issues

Usage: elasticsearch-faker generate [OPTIONS] ENDPOINT

  Generate fake data and put it to an Elasticsearch index.

Options:
  --index NAME           Name of an index to create. Defaults to 'test_index'.
  --mapping PATH         Path to a mapping file. See also https://www.elastic.
                         co/guide/en/elasticsearch/reference/current/explicit-
                         mapping.html
  --template PATH        Path to a faker template file.
  -n, --num-doc INTEGER  Number of generating documents. Using bulk API if the
                         value equals or greater than two. Defaults to 1000.
  --bulk-size INTEGER    Number of creating documents for a single bulk API
                         call. Defaults to 200.
  --delete-index         Delete the index if already exists before generating
                         documents.
  -j, --jobs INTEGER     Number of jobs. Defaults to 1.
  --stdin                Read a faker template from stdin.
  --dry-run              Do no harm.
  -h, --help             Show this message and exit.

  Issue tracker: https://github.com/thombashi/elasticsearch-faker/issues

Dependencies

• Elasticsearch 7 or newer

• Python 3.6+

• Python package dependencies (automatically installed)