{ "componentChunkName": "component---src-templates-issues-tsx", "path": "/issues/151", "result": {"data":{"issuesJson":{"id":"911fa96c-979a-5954-9c82-0c5af2157c4f","title":"elasticsearch-dump/elasticsearch-dump: Elasticsearch 和 OpenSearch 的索引数据导入和导出工具","number":151,"bodyHTML":"
\n



\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Reposelasticsearch-dump/elasticsearch-dump
Views\"views\"
Stars\"stars\"
Forks\"forks\"
License\"license\"
UpdatedAt\"last-commit\"
CreatedAt\"create-at\"
\n\n

\"\"

\n\n
\n

elasticdump

\n

Tools for moving and saving indices from Elasticsearch and OpenSearch

\n

\"picture\"

\n
\n

\"Build
\n\"npm
\n\"NPM
\n\"NPM
\n\"DockerHub
\n\"DockerHub

\n

Version Warnings!

\n\n

Installing

\n

(local)

\n
npm install elasticdump\n./bin/elasticdump
\n

(global)

\n
npm install elasticdump -g\nelasticdump
\n

Use

\n

Standard Install

\n

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

\n

Elasticsearch/OpenSearch:

\n\n

File:

\n\n

Stdio:

\n\n

You can then do things like:

\n
# Copy an index from production to staging with analyzer and mapping:\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=http://staging.es.com:9200/my_index \\\n  --type=analyzer\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=http://staging.es.com:9200/my_index \\\n  --type=mapping\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=http://staging.es.com:9200/my_index \\\n  --type=data\n\n# Backup index data to a file:\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=/data/my_index_mapping.json \\\n  --type=mapping\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=/data/my_index.json \\\n  --type=data\n\n# Backup and index to a gzip using stdout:\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=$ \\\n  | gzip > /data/my_index.json.gz\n\n# Backup the results of a query to a file\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=query.json \\\n  --searchBody=\"{\\\"query\\\":{\\\"term\\\":{\\\"username\\\": \\\"admin\\\"}}}\"\n  \n# Specify searchBody from a file\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=query.json \\\n  --searchBody=@/data/searchbody.json  \n\n# Copy a single shard data:\nelasticdump \\\n  --input=http://es.com:9200/api \\\n  --output=http://es.com:9200/api2 \\\n  --input-params=\"{\\\"preference\\\":\\\"_shards:0\\\"}\"\n\n# Backup aliases to a file\nelasticdump \\\n  --input=http://es.com:9200/index-name/alias-filter \\\n  --output=alias.json \\\n  --type=alias\n\n# Import aliases into ES\nelasticdump \\\n  --input=./alias.json \\\n  --output=http://es.com:9200 \\\n  --type=alias\n\n# Backup templates to a file\nelasticdump \\\n  --input=http://es.com:9200/template-filter \\\n  --output=templates.json \\\n  --type=template\n\n# Import templates into ES\nelasticdump \\\n  --input=./templates.json \\\n  --output=http://es.com:9200 \\\n  --type=template\n\n# Split files into multiple parts\nelasticdump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=/data/my_index.json \\\n  --fileSize=10mb\n\n# Import data from S3 into ES (using s3urls)\nelasticdump \\\n  --s3AccessKeyId \"${access_key_id}\" \\\n  --s3SecretAccessKey \"${access_key_secret}\" \\\n  --input \"s3://${bucket_name}/${file_name}.json\" \\\n  --output=http://production.es.com:9200/my_index\n\n# Export ES data to S3 (using s3urls)\nelasticdump \\\n  --s3AccessKeyId \"${access_key_id}\" \\\n  --s3SecretAccessKey \"${access_key_secret}\" \\\n  --input=http://production.es.com:9200/my_index \\\n  --output \"s3://${bucket_name}/${file_name}.json\"\n\n# Import data from MINIO (s3 compatible) into ES (using s3urls)\nelasticdump \\\n  --s3AccessKeyId \"${access_key_id}\" \\\n  --s3SecretAccessKey \"${access_key_secret}\" \\\n  --input \"s3://${bucket_name}/${file_name}.json\" \\\n  --output=http://production.es.com:9200/my_index\n  --s3ForcePathStyle true\n  --s3Endpoint https://production.minio.co\n\n# Export ES data to MINIO (s3 compatible) (using s3urls)\nelasticdump \\\n  --s3AccessKeyId \"${access_key_id}\" \\\n  --s3SecretAccessKey \"${access_key_secret}\" \\\n  --input=http://production.es.com:9200/my_index \\\n  --output \"s3://${bucket_name}/${file_name}.json\"\n  --s3ForcePathStyle true\n  --s3Endpoint https://production.minio.co\n\n# Import data from CSV file into ES (using csvurls)\nelasticdump \\\n  # csv:// prefix must be included to allow parsing of csv files\n  # --input \"csv://${file_path}.csv\" \\\n  --input \"csv:///data/cars.csv\"\n  --output=http://production.es.com:9200/my_index \\\n  --csvSkipRows 1    # used to skip parsed rows (this does not include the headers row)\n  --csvDelimiter \";\" # default csvDelimiter is ','
\n

Non-Standard Install

\n

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

\n

Elasticsearch/OpenSearch:

\n\n
# Copy a single index from a elasticsearch:\nelasticdump \\\n  --input=http://es.com:9200/api/search \\\n  --input-index=my_index \\\n  --output=http://es.com:9200/api/search \\\n  --output-index=my_index \\\n  --type=mapping\n\n# Copy a single type:\nelasticdump \\\n  --input=http://es.com:9200/api/search \\\n  --input-index=my_index/my_type \\\n  --output=http://es.com:9200/api/search \\\n  --output-index=my_index \\\n  --type=mapping\n
\n

Docker install

\n

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

\n
docker pull elasticdump/elasticsearch-dump
\n

Then you can use it just by :

\n\n

Example:

\n
# Copy an index from production to staging with mappings:\ndocker run --rm -ti elasticdump/elasticsearch-dump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=http://staging.es.com:9200/my_index \\\n  --type=mapping\ndocker run --rm -ti elasticdump/elasticsearch-dump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=http://staging.es.com:9200/my_index \\\n  --type=data\n\n# Backup index data to a file:\ndocker run --rm -ti -v /data:/tmp elasticdump/elasticsearch-dump \\\n  --input=http://production.es.com:9200/my_index \\\n  --output=/tmp/my_index_mapping.json \\\n  --type=data
\n

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

\n
docker run --net=host --rm -ti elasticdump/elasticsearch-dump \\\n  --input=http://staging.es.com:9200/my_index \\\n  --output=http://localhost:9200/my_index \\\n  --type=data
\n

Dump Format

\n

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 integrity.

\n

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

\n
while read LINE; do jsonlint-py \"${LINE}\" ; done < dump.data.json\n
\n

Options

\n
elasticdump: Import and export tools for elasticsearch\nversion: %%version%%\n\nUsage: elasticdump --input SOURCE --output DESTINATION [OPTIONS]\n\nCore options\n--------------------\n--input\n                    Source location (required)\n\n--input-index\n                    Source index and type\n                    (default: all, example: index/type)\n\n--output\n                    Destination location (required)\n\n--output-index\n                    Destination index and type\n                    (default: all, example: index/type)\n\n\nOptions\n--------------------\n--big-int-fields\n                    Specifies a comma-seperated list of fields that should be checked for big-int support\n                    (default '')\n\n--bulkAction\n                    Sets the operation type to be used when preparing the request body to be sent to elastic search.\n                    For more info - https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-bulk.html\n                    (default: index, options: [index, update, delete, create)\n\n--ca, --input-ca, --output-ca\n                    CA certificate. Use --ca if source and destination are identical.\n                    Otherwise, use the one prefixed with --input or --output as needed.\n\n--cert, --input-cert, --output-cert\n                    Client certificate file. Use --cert if source and destination are identical.\n                    Otherwise, use the one prefixed with --input or --output as needed.\n\n--csvConfigs\n                    Set all fast-csv configurations\n                    A escaped JSON string or file can be supplied. File location must be prefixed with the @ symbol\n                    (default: null)\n\n--csvCustomHeaders  A comma-seperated listed of values that will be used as headers for your data. This param must\n                    be used in conjunction with `csvRenameHeaders`\n                    (default : null)\n\n--csvDelimiter\n                    The delimiter that will separate columns.\n                    (default : ',')\n\n--csvFirstRowAsHeaders\n                    If set to true the first row will be treated as the headers.\n                    (default : true)\n\n--csvHandleNestedData\n                    Set to true to handle nested JSON/CSV data.\n                    NB : This is a very opinionated implementaton !\n                    (default : false)\n\n--csvIdColumn\n                    Name of the column to extract the record identifier (id) from\n                    When exporting to CSV this column can be used to override the default id (@id) column name\n                    (default : null)\n\n--csvIgnoreAutoColumns\n                    Set to true to prevent the following columns @id, @index, @type from being written to the output file\n                    (default : false)\n\n--csvIgnoreEmpty\n                    Set to true to ignore empty rows.\n                    (default : false)\n\n--csvIncludeEndRowDelimiter\n                    Set to true to include a row delimiter at the end of the csv\n                    (default : false)\n\n--csvIndexColumn\n                    Name of the column to extract the record index from\n                    When exporting to CSV this column can be used to override the default index (@index) column name\n                    (default : null)\n\n--csvLTrim\n                    Set to true to left trim all columns.\n                    (default : false)\n\n--csvMaxRows\n                    If number is > 0 then only the specified number of rows will be parsed.(e.g. 100 would return the first 100 rows of data)\n                    (default : 0)\n\n--csvRTrim\n                    Set to true to right trim all columns.\n                    (default : false)\n\n--csvRenameHeaders\n                    If you want the first line of the file to be removed and replaced by the one provided in the `csvCustomHeaders` option\n                    (default : true)\n\n--csvSkipLines\n                    If number is > 0 the specified number of lines will be skipped.\n                    (default : 0)\n\n--csvSkipRows\n                    If number is > 0 then the specified number of parsed rows will be skipped\n                    NB:  (If the first row is treated as headers, they aren't a part of the count)\n                    (default : 0)\n\n--csvTrim\n                    Set to true to trim all white space from columns.\n                    (default : false)\n\n--csvTypeColumn\n                    Name of the column to extract the record type from\n                    When exporting to CSV this column can be used to override the default type (@type) column name\n                    (default : null)\n\n--csvWriteHeaders   Determines if headers should be written to the csv file.\n                    (default : true)\n\n--customBackoff\n                    Activate custom customBackoff function. (s3)\n\n--debug\n                    Display the elasticsearch commands being used\n                    (default: false)\n\n--delete\n                    Delete documents one-by-one from the input as they are\n                    moved.  Will not delete the source index\n                    (default: false)\n\n--delete-with-routing\n                    Passes the routing query-param to the delete function\n                    used to route operations to a specific shard.\n                    (default: false)\n\n--esCompress\n                    if true, add an Accept-Encoding header to request compressed content encodings from the server (if not already present)\n                    and decode supported content encodings in the response.\n                    Note: Automatic decoding of the response content is performed on the body data returned through request\n                    (both through the request stream and passed to the callback function) but is not performed on the response stream\n                    (available from the response event) which is the unmodified http.IncomingMessage object which may contain compressed data.\n                    See example below.\n\n--fileSize\n                    supports file splitting.  This value must be a string supported by the **bytes** module.\n                    The following abbreviations must be used to signify size in terms of units\n                    b for bytes\n                    kb for kilobytes\n                    mb for megabytes\n                    gb for gigabytes\n                    tb for terabytes\n                    e.g. 10mb / 1gb / 1tb\n                    Partitioning helps to alleviate overflow/out of memory exceptions by efficiently segmenting files\n                    into smaller chunks that then can be merged if needs be.\n\n--filterSystemTemplates\n                    Whether to remove metrics-*-* and logs-*-* system templates\n                    (default: true])\n\n--force-os-version\n                    Forces the OpenSearch version used by elasticsearch-dump.\n                    (default: 7.10.2)\n\n--fsCompress\n                    gzip data before sending output to file.\n                    On import the command is used to inflate a gzipped file\n                    \n--compressionLevel\n                    The level of zlib compression to apply to responses.\n                    defaults to zlib.Z_DEFAULT_COMPRESSION\n\n--handleVersion\n                    Tells elastisearch transport to handle the `_version` field if present in the dataset\n                    (default : false)\n\n--headers\n                    Add custom headers to Elastisearch requests (helpful when\n                    your Elasticsearch instance sits behind a proxy)\n                    (default: '{\"User-Agent\": \"elasticdump\"}')\n                    Type/direction based headers are supported .i.e. input-headers/output-headers\n                    (these will only be added based on the current flow type input/output)\n\n--help\n                    This page\n\n--ignore-errors\n                    Will continue the read/write loop on write error\n                    (default: false)\n\n--ignore-es-write-errors\n                    Will continue the read/write loop on a write error from elasticsearch\n                    (default: true)\n\n--inputSocksPort, --outputSocksPort\n                    Socks5 host port\n\n--inputSocksProxy, --outputSocksProxy\n                    Socks5 host address\n\n--inputTransport\n                    Provide a custom js file to use as the input transport\n\n--key, --input-key, --output-key\n                    Private key file. Use --key if source and destination are identical.\n                    Otherwise, use the one prefixed with --input or --output as needed.\n\n--limit\n                    How many objects to move in batch per operation\n                    limit is approximate for file streams\n                    (default: 100)\n\n--maxRows\n                    supports file splitting.  Files are split by the number of rows specified\n\n--maxSockets\n                    How many simultaneous HTTP requests can the process make?\n                    (default:\n                      5 [node <= v0.10.x] /\n                      Infinity [node >= v0.11.x] )\n\n--noRefresh\n                    Disable input index refresh.\n                    Positive:\n                      1. Much increased index speed\n                      2. Much less hardware requirements\n                    Negative:\n                      1. Recently added data may not be indexed\n                    Recommended using with big data indexing,\n                    where speed and system health is a higher priority\n                    than recently added data.\n\n--offset\n                    Integer containing the number of rows you wish to skip\n                    ahead from the input transport.  When importing a large\n                    index, things can go wrong, be it connectivity, crashes,\n                    someone forgets to `screen`, etc.  This allows you\n                    to start the dump again from the last known line written\n                    (as logged by the `offset` in the output).  Please be\n                    advised that since no sorting is specified when the\n                    dump is initially created, there's no real way to\n                    guarantee that the skipped rows have already been\n                    written/parsed.  This is more of an option for when\n                    you want to get as much data as possible in the index\n                    without concern for losing some rows in the process,\n                    similar to the `timeout` option.\n                    (default: 0)\n\n--outputTransport\n                    Provide a custom js file to use as the output transport\n\n--overwrite\n                    Overwrite output file if it exists\n                    (default: false)\n\n--params\n                    Add custom parameters to Elastisearch requests uri. Helpful when you for example\n                    want to use elasticsearch preference\n                    --input-params is a specific params extension that can be used when fetching data with the scroll api\n                    --output-params is a specific params extension that can be used when indexing data with the bulk index api\n                    NB : These were added to avoid param pollution problems which occur when an input param is used in an output source\n                    (default: null)\n\n--parseExtraFields\n                    Comma-separated list of meta-fields to be parsed\n\n--pass, --input-pass, --output-pass\n                    Pass phrase for the private key. Use --pass if source and destination are identical.\n                    Otherwise, use the one prefixed with --input or --output as needed.\n\n--quiet\n                    Suppress all messages except for errors\n                    (default: false)\n\n--retryAttempts\n                    Integer indicating the number of times a request should be automatically re-attempted before failing\n                    when a connection fails with one of the following errors `ECONNRESET`, `ENOTFOUND`, `ESOCKETTIMEDOUT`,\n                    ETIMEDOUT`, `ECONNREFUSED`, `EHOSTUNREACH`, `EPIPE`, `EAI_AGAIN`\n                    (default: 0)\n\n--retryDelay\n                    Integer indicating the back-off/break period between retry attempts (milliseconds)\n                    (default : 5000)\n\n--retryDelayBase\n                    The base number of milliseconds to use in the exponential backoff for operation retries. (s3)\n\n--scroll-with-post\n                    Use a HTTP POST method to perform scrolling instead of the default GET\n                    (default: false)\n\n--scrollId\n                    The last scroll Id returned from elasticsearch.\n                    This will allow dumps to be resumed used the last scroll Id &\n                    `scrollTime` has not expired.\n\n--scrollTime\n                    Time the nodes will hold the requested search in order.\n                    (default: 10m)\n\n--searchBody\n                    Preform a partial extract based on search results\n                    when ES is the input, default values are\n                      if ES > 5\n                        `'{\"query\": { \"match_all\": {} }, \"stored_fields\": [\"*\"], \"_source\": true }'`\n                      else\n                        `'{\"query\": { \"match_all\": {} }, \"fields\": [\"*\"], \"_source\": true }'`\n                    [As of 6.68.0] If the searchBody is preceded by a @ symbol, elasticdump will perform a file lookup\n                    in the location specified. NB: File must contain valid JSON\n\n--searchBodyTemplate\n                    A method/function which can be called to the searchBody\n                        doc.searchBody = { query: { match_all: {} }, stored_fields: [], _source: true };\n                    May be used multiple times.\n                    Additionally, searchBodyTemplate may be performed by a module. See [searchBody Template](#search-template) below.\n\n--searchWithTemplate\n                    Enable to use Search Template when using --searchBody\n                    If using Search Template then searchBody has to consist of \"id\" field and \"params\" objects\n                    If \"size\" field is defined within Search Template, it will be overridden by --size parameter\n                    See https://www.elastic.co/guide/en/elasticsearch/reference/current/search-template.html for\n                    further information\n                    (default: false)\n\n--size\n                    How many objects to retrieve\n                    (default: -1 -> no limit)\n\n--skip-existing\n                    Skips resource_already_exists_exception when enabled and exit with success\n                    (default: false)\n\n--sourceOnly\n                    Output only the json contained within the document _source\n                    Normal: {\"_index\":\"\",\"_type\":\"\",\"_id\":\"\", \"_source\":{SOURCE}}\n                    sourceOnly: {SOURCE}\n                    (default: false)\n\n--support-big-int\n                    Support big integer numbers\n\n--templateRegex\n                    Regex used to filter templates before passing to the output transport\n                    (default: ((metrics|logs|\\..+)(-.+)?)\n\n--timeout\n                    Integer containing the number of milliseconds to wait for\n                    a request to respond before aborting the request. Passed\n                    directly to the request library. Mostly used when you don't\n                    care too much if you lose some data when importing\n                    but would rather have speed.\n\n--tlsAuth\n                    Enable TLS X509 client authentication\n\n--toLog\n                    When using a custom outputTransport, should log lines\n                    be appended to the output stream?\n                    (default: true, except for `$`)\n\n--transform\n                    A method/function which can be called to modify documents\n                    before writing to a destination. A global variable 'doc'\n                    is available.\n                    Example script for computing a new field 'f2' as doubled\n                    value of field 'f1':\n                        doc._source[\"f2\"] = doc._source.f1 * 2;\n                    May be used multiple times.\n                    Additionally, transform may be performed by a module. See [Module Transform](#module-transform) below.\n\n--type\n                    What are we exporting?\n                    (default: data, options: [index, settings, analyzer, data, mapping, policy, alias, template, component_template, index_template])\n\n--versionType\n                    Elasticsearch versioning types. Should be `internal`, `external`, `external_gte`, `force`.\n                    NB : Type validation is handled by the bulk endpoint and not by elasticsearch-dump\n\n--openSearchServerless\n                    Set to true to run dump from AWS OpenSearch serverless collection.\n                    (default : false)\n\n--searchAfter\n                    Set to true to use dump with Elasticsearch search_after. Requires ES version 7.17.0 or higher\n                    (default: false)\n\n--pit               \n                    Set to true to enabled PIT (Point in time support). Please READ the documentation for the requirements on how to use this\n                    (default : false)\n--pitKeepAlive      \n                    Set the keepAlive time for the pit\n                    (default : 5m)\n--heapSnapshot      \n                    Set to true to enable a snapshot to be taken. This is for debugging purposes ONLY ! requires node >12\n                    (default : false)\n\nAWS specific options\n--------------------\n--awsAccessKeyId and --awsSecretAccessKey\n                    When using Amazon Elasticsearch Service protected by\n                    AWS Identity and Access Management (IAM), provide\n                    your Access Key ID and Secret Access Key.\n                    --sessionToken can also be optionally provided if using temporary credentials\n\n--awsChain\n                    Use [standard](https://aws.amazon.com/blogs/security/a-new-and-standardized-way-to-manage-credentials-in-the-aws-sdks/)\n                    location and ordering for resolving credentials including environment variables,\n                    config files, EC2 and ECS metadata locations _Recommended option for use with AWS_\n\n--awsIniFileName\n                    Override the default aws ini file name when using --awsIniFileProfile\n                    Filename is relative to ~/.aws/\n                    (default: config)\n\n--awsIniFileProfile\n                    Alternative to --awsAccessKeyId and --awsSecretAccessKey,\n                    loads credentials from a specified profile in aws ini file.\n                    For greater flexibility, consider using --awsChain\n                    and setting AWS_PROFILE and AWS_CONFIG_FILE\n                    environment variables to override defaults if needed\n\n--awsRegion\n                    Sets the AWS region that the signature will be generated for\n                    (default: calculated from hostname or host)\n\n--awsService\n                    Sets the AWS service that the signature will be generated for\n                    (default: calculated from hostname or host)\n\n--awsUrlRegex\n                    Overrides the default regular expression that is used to validate AWS urls that should be signed\n                    (default: ^https?:\\/\\/.*\\.amazonaws\\.com.*$)\n\n--s3ACL\n                    S3 ACL: private | public-read | public-read-write | authenticated-read | aws-exec-read |\n                    bucket-owner-read | bucket-owner-full-control [default private]\n\n--s3AccessKeyId\n                    AWS access key ID\n\n--s3SessionToken\n                    AWS session token in case of using temporary credentials\n\n--s3Compress\n                    gzip data before sending to s3\n\n--s3Configs\n                    Set all s3 constructor configurations\n                    A escaped JSON string or file can be supplied. File location must be prefixed with the @ symbol\n                    (default: null)\n\n--s3Endpoint\n                    AWS endpoint that can be used for AWS compatible backends such as\n                    OpenStack Swift and OpenStack Ceph\n\n--s3ForcePathStyle\n                    Force path style URLs for S3 objects [default false]\n\n--s3Options\n                    Set all s3 parameters shown here https://docs.aws.amazon.com/AWSJavaScriptSDK/latest/AWS/S3.html#createMultipartUpload-property\n                    A escaped JSON string or file can be supplied. File location must be prefixed with the @ symbol\n                    (default: null)\n\n--s3Region\n                    AWS region\n\n--s3SSEKMSKeyId\n                    KMS Id to be used with aws:kms uploads\n\n--s3SSLEnabled\n                    Use SSL to connect to AWS [default true]\n\n--s3SecretAccessKey\n                    AWS secret access key\n\n--s3ServerSideEncryption\n                    Enables encrypted uploads\n\n--s3StorageClass\n                    Set the Storage Class used for s3\n                    (default: STANDARD)\n
\n

Elasticsearch's Scroll API

\n

Elasticsearch provides a scroll API to fetch all documents of an index starting from (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.

\n

NOTE: only works for --output

\n

Bypassing self-sign certificate errors

\n

Set the environment NODE_TLS_REJECT_UNAUTHORIZED=0 before running elasticdump

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

MultiElasticDump

\n

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.

\n

The limited option set includes:

\n\n

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.

\n

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.

\n

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

\n

--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
\nand 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
\ni.e analyzer,alias types are ignored by default

\n

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

\n

--ignoreChildError allows multi-elasticdump to continue if a child throws an error.

\n

--matchType allows multi-elasticdump to fetch indices from the specified elasticsearch endpoint. Two options are supported - alias,datastream

\n

New options, --suffix allows you to add a suffix to the index name being created e.g. es6-${index} and
\n--prefix allows you to add a prefix to the index name e.g. ${index}-backup-2018-03-13.
\n--order accepts asc or desc and allows the indexes/aliases to be sorted before processing is performed

\n

Usage Examples

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

Custom Matcher - MultiElasticDump

\n

The default matcher for multielasticdump is regex based and won't handle complex conditions or business rules.
\nSupport was added for defining custom matchers.

\n

When specifying the customMatcher option, prefix the value with @ (a curl convention) to load matcher file

\n
multielasticdump \\\n --direction=dump \\\n --customMatcher='@./customMatcher/backup.js'\\\n --input=http://production.es.com:9200 \\\n --ignoreType='mapping,settings,template' \\\n --output=/tmp/es_backup
\n

The only requirement for this module is that it must define a test function.

\n
module.exports = {\n  test: function (indexName) {\n    // determine if the index should be loaded/dumped.\n    // must return a boolen(true/false)\n  }\n};
\n

Module Transform

\n

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.

\n

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

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

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

\n
module.exports = function(doc, options) {\n  // do something to doc\n};
\n

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

\n

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

\n

searchBody Template

\n

When specifying the searchBodyTemplate 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.

\n

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

\n
elasticdump --searchBodyTemplate='@./templates/my-template?param1=value&param2=another-value'
\n

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

\n
module.exports = function(doc, options) {\n  // result must be added to doc.searchBody\n  doc.searchBody = {}\n};
\n

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

\n

An example template for modifying dates using a simple templating engine is available in the templates folder.

\n

How Elasticdump handles Nested Data in CSV

\n

Elasticdump is capable of reading/writing nested data, but in an _opinionated way. This is to reduce complexity while parsing/saving CSVs
\nThe format flattens all nesting to a single level (an example of this is shown below)

\n
{\n   \"elasticdump\":{\n      \"version\":\"6.51.0\",\n      \"formats\":[\n         \"json\",\n         \"csv\"\n      ]\n   },\n   \"contributors\":[\n      {\n         \"name\":\"ferron\",\n         \"id\":3\n      }\n   ],\n   \"year\":112\n}
\n

Output format

\n
{\n  \"elasticdump\":\"{\\\"version\\\":\\\"6.51.0\\\",\\\"formats\\\":[\\\"json\\\",\\\"csv\\\"]}\",\n  \"contributors\":\"{\\\"contributors\\\":[{\\\"name\\\":\\\"ferron\\\",\\\"id\\\":3}]}\",\n  \"year\":2020\n}
\n

Notice that the data is flattened to 1 level. Object keys are used for headers and values as row data.
\nThis might not work with existing nested data formats, but that's the format that was chosen for elasticdump
\nbecause of its simplicity. This detection is disabled by default, to enable use the --csvHandleNestedData flag

\n

Notes

\n\n

Articles on Elasticdump

\n\n

Inspired by https://github.com/crate/elasticsearch-inout-plugin and https://github.com/jprante/elasticsearch-knapsack

","updatedAt":"2025-05-21T15:56:40Z","upvoteCount":null,"author":{"login":"eryajf","avatarUrl":"https://avatars.githubusercontent.com/u/33259379?u=e4a4090a38ac2473aaed4ef9945233636776c6c3&v=4","url":"https://github.com/eryajf"},"category":null,"labels":{"edges":[{"node":{"name":"更多","color":"25B472"}},{"node":{"name":"ElasticSearch-Manage","color":"6b7852"}},{"node":{"name":"elasticsearch-dump","color":"0c8879"}}]},"comments":{"edges":[]}}},"pageContext":{"number":151,"previous":{"title":"anjia0532/elastalert-docker: ES 告警组件 ElastAlert 的 Docker镜像","number":150},"next":{"title":"1340691923/ElasticView: 一个简单好用的 ElasticSearch 可视化客户端，支持连接6，7，8版本的ES","number":152}}}, "staticQueryHashes": ["151096407","2861350382"]}