Neatly Prepared Mustache


    6.23.0 • Public • Published


    Tools for moving and saving indices.


    Nodei stats DockerHub Badge

    Build Status Downloads

    Version Warnings!

    • Version 1.0.0 of Elasticdump changes the format of the files created by the dump. Files created with version 0.x.x of this tool are likely not to work with versions going forward. To learn more about the breaking changes, vist the release notes for version 1.0.0. If you recive an "out of memory" error, this is probaly the cause.
    • Version 2.0.0 of Elasticdump removes the bulk options. These options were buggy, and differ between versions of Elasticsearch. If you need to export multiple indexes, look for the multielasticdump section of the tool.
    • Version 2.1.0 of Elasticdump moves from using scan/scroll (ES 1.x) to just scan (ES 2.x). This is a backwards-compatible change within Elasticsearch, but performance may suffer on Elasticsearch versions prior to 2.x.
    • Version 3.0.0 of Elasticdump has the default queries updated to only work for ElasticSearch version 5+. The tool may be compatible with earlier versions of Elasticsearch, but our version detection method may not work for all ES cluster topologies
    • Version 5.0.0 of Elasticdump contains a breaking change for the s3 transport. s3Bucket and s3RecordKey params are no longer supported please use s3urls instead
    • Version 6.1.0 and higher of Elasticdump contains a change to the upload/dump process. This change allows for overlapping promise processing. The benefit of which is improved performance due increased parallel processing, but a side-effect exists where-by records (data-set) aren't processing in sequential order (ordering is no longer guaranteed)



    npm install elasticdump


    npm install elasticdump -g


    Standard Install

    elasticdump works by sending an input to an output. Both can be either an elasticsearch URL or a File.


    • format: {protocol}://{host}:{port}/{index}
    • example:


    • format: {FilePath}
    • example: /Users/evantahler/Desktop/dump.json


    • format: stdin / stdout
    • format: $

    You can then do things like:

    # Copy an index from production to staging with analyzer and mapping:
    elasticdump \
      --input= \
      --output= \
    elasticdump \
      --input= \
      --output= \
    elasticdump \
      --input= \
      --output= \
    # Backup index data to a file:
    elasticdump \
      --input= \
      --output=/data/my_index_mapping.json \
    elasticdump \
      --input= \
      --output=/data/my_index.json \
    # Backup and index to a gzip using stdout:
    elasticdump \
      --input= \
      --output=$ \
      | gzip > /data/my_index.json.gz
    # Backup the results of a query to a file
    elasticdump \
      --input= \
      --output=query.json \
      --searchBody='{"query":{"term":{"username": "admin"}}}'
    # Copy a single shard data:
    elasticdump \
      --input= \
      --output= \
      --params='{"preference" : "_shards:0"}'
    # Backup aliases to a file
    elasticdump \
      --input= \
      --output=alias.json \
    # Import aliases into ES
    elasticdump \
      --input=./alias.json \
      --output= \
    # Backup templates to a file
    elasticdump \
      --input= \
      --output=templates.json \
    # Import templates into ES
    elasticdump \
      --input=./templates.json \
      --output= \
    # Split files into multiple parts
    elasticdump \
      --input= \
      --output=/data/my_index.json \
    # Import data from S3 into ES (using s3urls)
    elasticdump \
      --s3AccessKeyId "${access_key_id}" \
      --s3SecretAccessKey "${access_key_secret}" \
      --input "s3://${bucket_name}/${file_name}.json" \
    # Export ES data to S3 (using s3urls)
    elasticdump \
      --s3AccessKeyId "${access_key_id}" \
      --s3SecretAccessKey "${access_key_secret}" \
      --input= \
      --output "s3://${bucket_name}/${file_name}.json"

    Non-Standard Install

    If Elasticsearch is not being served from the root directory the --input-index and --output-index are required. If they are not provided, the additional sub-directories will be parsed for index and type.


    • format: {protocol}://{host}:{port}/{sub}/{directory...}
    • example:
    # Copy a single index from a elasticsearch:
    elasticdump \
      --input= \
      --input-index=my_index \
      --output= \
      --output-index=my_index \
    # Copy a single type:
    elasticdump \
      --input= \
      --input-index=my_index/my_type \
      --output= \
      --output-index=my_index \

    Docker install

    If you prefer using docker to use elasticdump, you can download this project from docker hub :

    docker pull taskrabbit/elasticsearch-dump

    Then you can use it just by :

    • using docker run --rm -ti taskrabbit/elasticsearch-dump
    • you'll need to mount your file storage dir -v <your dumps dir>:<your mount point> to your docker container


    # Copy an index from production to staging with mappings:
    docker run --rm -ti taskrabbit/elasticsearch-dump \
      --input= \
      --output= \
    docker run --rm -ti taskrabbit/elasticsearch-dump \
      --input= \
      --output= \
    # Backup index data to a file:
    docker run --rm -ti -v /data:/tmp taskrabbit/elasticsearch-dump \
      --input= \
      --output=/tmp/my_index_mapping.json \

    If you need to run using localhost as your ES host :

    docker run --net=host --rm -ti taskrabbit/elasticsearch-dump \
      --input= \
      --output=http://localhost:9200/my_index \

    Dump Format

    The file format generated by this tool is line-delimited JSON files. The dump file itself is not valid JSON, but each line is. We do this so that dumpfiles can be streamed and appended without worrying about whole-file parser integrety.

    For example, if you wanted to parse every line, you could do:

    while read LINE; do jsonlint-py "${LINE}" ; done <


    elasticdump: Import and export tools for elasticsearch
    version: %%version%%
    Usage: elasticdump --input SOURCE --output DESTINATION [OPTIONS]
                        Source location (required)
                        Source index and type
                        (default: all, example: index/type)
                        Destination location (required)
                        Destination index and type
                        (default: all, example: index/type)
                        Overwrite output file if it exists
                        (default: false)                    
                        How many objects to move in batch per operation
                        limit is approximate for file streams
                        (default: 100)
                        How many objects to retrieve
                        (default: -1 -> no limit)
                        The maximum number of requests the can be made concurrently to a specified transport.
                        (default: 1)       
                        The length of time in milliseconds in which up to <intervalCap> requests can be made
                        before the interval request count resets. Must be finite.
                        (default: 5000)       
                        The maximum number of transport requests that can be made within a given <concurrencyInterval>.
                        (default: 5)
                        If true, any incomplete requests from a <concurrencyInterval> will be carried over to
                        the next interval, effectively reducing the number of new requests that can be created
                        in that next interval.  If false, up to <intervalCap> requests can be created in the
                        next interval regardless of the number of incomplete requests from the previous interval.
                        (default: true)                                                                                       
                        Delay in milliseconds between getting data from an inputTransport and sending it to an
                         (default: 1)
                        Display the elasticsearch commands being used
                        (default: false)
                        Suppress all messages except for errors
                        (default: false)
                        What are we exporting?
                        (default: data, options: [settings, analyzer, data, mapping, alias, template])
                        Delete documents one-by-one from the input as they are
                        moved.  Will not delete the source index
                        (default: false)
                        Preform a partial extract based on search results
                        when ES is the input, default values are
                          if ES > 5
                            `'{"query": { "match_all": {} }, "stored_fields": ["*"], "_source": true }'`
                            `'{"query": { "match_all": {} }, "fields": ["*"], "_source": true }'`
                        Enable to use Search Template when using --searchBody
                        If using Search Template then searchBody has to consist of "id" field and "params" objects
                        If "size" field is defined within Search Template, it will be overridden by --size parameter
                        See for 
                        further information
                        (default: false)
                        Add custom headers to Elastisearch requests (helpful when
                        your Elasticsearch instance sits behind a proxy)
                        (default: '{"User-Agent": "elasticdump"}')
                        Add custom parameters to Elastisearch requests uri. Helpful when you for example
                        want to use elasticsearch preference
                        (default: null)
                        Output only the json contained within the document _source
                        Normal: {"_index":"","_type":"","_id":"", "_source":{SOURCE}}
                        sourceOnly: {SOURCE}
                        (default: false)
                        Will continue the read/write loop on write error
                        (default: false)
                        Time the nodes will hold the requested search in order.
                        (default: 10m)
                        How many simultaneous HTTP requests can we process make?
                          5 [node <= v0.10.x] /
                          Infinity [node >= v0.11.x] )
                        Integer containing the number of milliseconds to wait for
                        a request to respond before aborting the request. Passed
                        directly to the request library. Mostly used when you don't
                        care too much if you lose some data when importing
                        but rather have speed.
                        Integer containing the number of rows you wish to skip
                        ahead from the input transport.  When importing a large
                        index, things can go wrong, be it connectivity, crashes,
                        someone forgetting to `screen`, etc.  This allows you
                        to start the dump again from the last known line written
                        (as logged by the `offset` in the output).  Please be
                        advised that since no sorting is specified when the
                        dump is initially created, there's no real way to
                        guarantee that the skipped rows have already been
                        written/parsed.  This is more of an option for when
                        you want to get most data as possible in the index
                        without concern for losing some rows in the process,
                        similar to the `timeout` option.
                        (default: 0)
                        Disable input index refresh.
                          1. Much increase index speed
                          2. Much less hardware requirements
                          1. Recently added data may not be indexed
                        Recommended to use with big data indexing,
                        where speed and system health in a higher priority
                        than recently added data.
                        Provide a custom js file to use as the input transport
                        Provide a custom js file to use as the output transport
                        When using a custom outputTransport, should log lines
                        be appended to the output stream?
                        (default: true, except for `$`)
                        A javascript, which will be called to modify documents
                        before writing it to destination. global variable 'doc'
                        is available.
                        Example script for computing a new field 'f2' as doubled
                        value of field 'f1':
                            doc._source["f2"] = doc._source.f1 * 2;
                        May be used multiple times.
                        Additionally, transform may be performed by a module. See [Module Transform](#module-transform) below.
                        Use [standard]( location and ordering for resolving credentials including environment variables, config files, EC2 and ECS metadata locations
                        _Recommended option for use with AWS_
                        When using Amazon Elasticsearch Service protected by
                        AWS Identity and Access Management (IAM), provide
                        your Access Key ID and Secret Access Key.
                        --sessionToken can also be optionally provided if using temporary credentials
                        Alternative to --awsAccessKeyId and --awsSecretAccessKey,
                        loads credentials from a specified profile in aws ini file.
                        For greater flexibility, consider using --awsChain
                        and setting AWS_PROFILE and AWS_CONFIG_FILE
                        environment variables to override defaults if needed
                        Override the default aws ini file name when using --awsIniFileProfile
                        Filename is relative to ~/.aws/
                        (default: config)
                        Sets the AWS service that the signature will be generated for
                        (default: calculated from hostname or host)
                        Sets the AWS region that the signature will be generated for
                        (default: calculated from hostname or host)
                        Support big integer numbers
                        Integer indicating the number of times a request should be automatically re-attempted before failing
                        when a connection fails with one of the following errors `ECONNRESET`, `ENOTFOUND`, `ESOCKETTIMEDOUT`,
                        (default: 0)
                        Integer indicating the back-off/break period between retry attempts (milliseconds)
                        (default : 5000)            
                        Comma-separated list of meta-fields to be parsed  
                        supports file splitting.  This value must be a string supported by the **bytes** module.     
                        The following abbreviations must be used to signify size in terms of units         
                        b for bytes
                        kb for kilobytes
                        mb for megabytes
                        gb for gigabytes
                        tb for terabytes
                        e.g. 10mb / 1gb / 1tb
                        Partitioning helps to alleviate overflow/out of memory exceptions by efficiently segmenting files
                        into smaller chunks that then be merged if needs be.
                        gzip data before sending outputting to file 
                        AWS access key ID
                        AWS secret access key
                        AWS region
                        AWS endpoint can be used for AWS compatible backends such as
                        OpenStack Swift and OpenStack Ceph
                        Use SSL to connect to AWS [default true]
    --s3ForcePathStyle  Force path style URLs for S3 objects [default false]
                        gzip data before sending to s3  
                        The base number of milliseconds to use in the exponential backoff for operation retries. (s3)
                        Activate custom customBackoff function. (s3)
                        Enable TLS X509 client authentication
    --cert, --input-cert, --output-cert
                        Client certificate file. Use --cert if source and destination are identical.
                        Otherwise, use the one prefixed with --input or --output as needed.
    --key, --input-key, --output-key
                        Private key file. Use --key if source and destination are identical.
                        Otherwise, use the one prefixed with --input or --output as needed.
    --pass, --input-pass, --output-pass
                        Pass phrase for the private key. Use --pass if source and destination are identical.
                        Otherwise, use the one prefixed with --input or --output as needed.
    --ca, --input-ca, --output-ca
                        CA certificate. Use --ca if source and destination are identical.
                        Otherwise, use the one prefixed with --input or --output as needed.
    --inputSocksProxy, --outputSocksProxy
                        Socks5 host address
    --inputSocksPort, --outputSocksPort
                        Socks5 host port
                        Tells elastisearch transport to handle the `_version` field if present in the dataset
                        (default : false)
                        Elasticsearch versioning types. Should be `internal`, `external`, `external_gte`, `force`.
                        NB : Type validation is handle by the bulk endpoint and not elasticsearch-dump
                        This page

    Elasticsearch's Scroll API

    Elasticsearch provides a scroll API to fetch all documents of an index starting form (and keeping) a consistent snapshot in time, which we use under the hood. This method is safe to use for large exports since it will maintain the result set in cache for the given period of time.

    NOTE: only works for --output

    Bypassing self-sign certificate errors

    Set the environment NODE_TLS_REJECT_UNAUTHORIZED=0 before running elasticdump

    # An alternative method of passing environment variables before execution
    # NB : This only works with linux shells
    NODE_TLS_REJECT_UNAUTHORIZED=0 elasticdump --input="https://localhost:9200" --output myfile


    This package also ships with a second binary, multielasticdump. This is a wrapper for the normal elasticdump binary, which provides a limited option set, but will run elasticdump in parallel across many indexes at once. It runs a process which forks into n (default your running host's # of CPUs) subprocesses running elasticdump.

    The limited option set includes:

    • parallel: os.cpus(),
    • match: '^.*$',
    • input: null,
    • output: null,
    • scrollTime: '10m',
    • timeout: null,
    • limit: 100,
    • offset: 0,
    • direction: dump,
    • ignoreType: ``
    • includeType: ``
    • prefix: '''
    • suffix: ''
    • interval: 1000
    • searchbody: null
    • transform: null
    • support-big-int: false

    If the --direction is dump, which is the default, --input MUST be a URL for the base location of an ElasticSearch server (i.e. http://localhost:9200) and --output MUST be a directory. Each index that does match will have a data, mapping, and analyzer file created.

    For loading files that you have dumped from multi-elasticsearch, --direction should be set to load, --input MUST be a directory of a multielasticsearch dump and --output MUST be a Elasticsearch server URL.

    --parallel is how many forks should be run simultaneously and --match is used to filter which indexes should be dumped/loaded (regex).

    --ignoreType allows a type to be ignored from the dump/load. Six options are supported. data,mapping,analyzer,alias,settings,template. Multi-type support is available, when used each type must be comma(,)-separated and interval allows control over the interval for spawning a dump/load for a new index. For small indices this can be set to 0 to reduce delays and optimize performance i.e analyzer,alias types are ignored by default

    --includeType allows a type to be included in the dump/load. Six options are supported. data,mapping,analyzer,alias,settings,template.

    New options, --suffix allows you to add a suffix to the index name being created e.g. es6-${index} and --prefix allows you to add a prefix to the index name e.g. ${index}-backup-2018-03-13.

    Usage Examples

    # backup ES indices & all their type to the es_backup folder
    multielasticdump \
      --direction=dump \
      --match='^.*$' \
      --input= \
    # Only backup ES indices ending with a prefix of `-index` (match regex). 
    # Only the indices data will be backed up. All other types are ignored.
    # NB: analyzer & alias types are ignored by default
    multielasticdump \
      --direction=dump \
      --input= \
      --ignoreType='mapping,settings,template' \

    Module Transform

    When specifying the transform option, prefix the value with @ (a curl convention) to load the top-level function which is called with the document and the parsed arguments to the module.

    Uses a pseudo-URL format to specify arguments to the module as follows. Given:

    elasticdump --transform='@./transforms/my-transform?param1=value&param2=another-value'

    with a module at ./transforms/my-transform.js with the following:

    module.exports = function (doc, options) {
        // do something to doc

    will load module ./transforms/my-transform.js', and execute the function with docandoptions={"param1": "value", "param2": "another-value"}`.

    An example transform for anonymizing data on-the-fly can be found in the transforms folder.


    • this tool is likely to require Elasticsearch version 1.0.0 or higher
    • elasticdump (and elasticsearch in general) will create indices if they don't exist upon import
    • when exporting from elasticsearch, you can export an entire index (--input="http://localhost:9200/index") or a type of object from that index (--input="http://localhost:9200/index/type"). This requires ElasticSearch 1.2.0 or higher
    • If elasticsearch is in a sub-directory, index and type must be provided with a separate argument (--input="http://localhost:9200/sub/directory --input-index=index/type"). Using --input-index=/ will include all indices and types.
    • we are using the put method to write objects. This means new objects will be created and old objects with the same ID will be updated
    • The file transport will not overwrite any existing files by default, it will throw an exception of the file already exists. Use --overwrite instead.
    • If you need basic http auth, you can use it like this: --input=
    • if you choose a stdio output (--output=$), you can also request a more human-readable output with --format=human
    • if you choose a stdio output (--output=$), all logging output will be suppressed
    • if you are using Elasticsearch version 6.0.0 or higher the offset parameter is no longer allowed in the scrollContext
    • ES 6.x.x & higher no longer support the template property for _template all templates prior to ES 6.0 has to be upgraded to use index_patterns
    • ES 7.x.x & higher no longer supports type property. all templates prior to ES 6.0 has to be upgraded to remove the type property
    • ES 5.x.x ignores offset (from) parameter in the search body. All records will be returned
    • ES 6.x.x from parameter can no longer be used in the search request body when initiating a scroll

    Inspired by and

    Built at TaskRabbit


    npm i elasticseach-dump

    DownloadsWeekly Downloads






    Unpacked Size

    133 kB

    Total Files


    Last publish


    • ismail.tunga