{
"info": {
"author": "PlayNetwork, Inc.",
"author_email": "industrial@playnetwork.com",
"bugtrack_url": null,
"classifiers": [],
"description": "ElasticSearch Import Utility (esimport)\n=======================================\n\nTool exists to index content from a CSV in ElasticSearch.\n\nUse\n---\n\nTo index the contents of a CSV file (where the first row contains field\nnames) into an ElasticSearch server, you must supply the -s, -f, -i and\n-t arguments. If the specified index or type does not exist within the\nspecified ElasticSearch server, it will be created when the module\nexecutes. The following example will index data from data.file into\nElasticSearch at http://myserver:9200/myindex/mytype:\n\n.. code:: Bash\n\n python -m esimport -s myserver:9200 -f /path/to/import/data.file -i myindex -t mytype\n\n- -s *server* (may either be a hostname:port or fully qualified, i.e.\n https://servername:port)\n- -f *filepath* (location of tab-delimited file to import data from)\n- -i *index*\\ name\\_ (name of the target index within ElasticSearch)\n- -t *type*\\ name\\_ (name of the target document type within\n ElasticSearch)\n\nFurther help available via the script:\n\n.. code:: Bash\n\n python -m esimport --help\n\nAdditional Options\n~~~~~~~~~~~~~~~~~~\n\nCustom Delimiter\n^^^^^^^^^^^^^^^^\n\nThe default delimiter for the operation is a \",\", but you may specify different delimiters via the -d argument.\n\n.. code:: Bash\n\n python -m esimport -s myserver:9200 -f /path/to/import/data.file -i myindex -t mytype -d '|'\n\n- -d *delimiter* (the delimiter separating columns within the CSV)\n\nClear Existing Data First\n^^^^^^^^^^^^^^^^^^^^^^^^^\n\nWhen indexing data in ElasticSearch, you may optionally clear the\nexisting ElasticSearch type before data is added by including the -rm\nargument.\n\n.. code:: Bash\n\n python -m esimport -s myserver:9200 -f /path/to/import/data.file -i myindex -t mytype -rm\n\n- -rm (removes all documents of given type within the specified index\n on ElasticSearch)\n\nMapping\n^^^^^^^\n\nMapping is the definitiion of the field names and value types of a\ndocument indexed within ElasticSearch. Characteristics such as field\ntype, whether a field is searchable, and whether to include a timestamp\nmay all be defined in a map.\n\n*Please note:* If the specified mapping does not match the field names\nin the tab-delimited file, you should supply a field translation file\n(described below).\n\nA mapping file can be specified by adding the -m parameter to the\ncommand:\n\n.. code:: Bash\n\n python -m esimport -s myserver:9200 -f /path/to/import/data.file -i myindex -t mytype -m /path/to/mapping.json\n\n- -m *mapping*\\ filepath\\_ (location of JSON formatted mapping file for\n specified type)\n\nMaps should be provided in JSON format, as seen below and on the\nElasticSearch website.\n\nSample mapping for a document type \"tracks\"\n'''''''''''''''''''''''''''''''''''''''''''\n\n.. code:: JSON\n\n {\n \"tracks\" : {\n \"properties\" : {\n \"genre\" : {\n \"type\" : \"string\"\n },\n \"album\" : {\n \"type\" : \"string\"\n },\n \"ISRC\" : {\n \"type\" : \"string\"\n },\n \"recordCompany\" : {\n \"type\" : \"string\"\n },\n \"artist\" : {\n \"type\" : \"string\"\n },\n \"songToken\" : {\n \"type\" : \"integer\"\n },\n \"durationInSeconds\" : {\n \"type\" : \"integer\"\n },\n \"title\" : {\n \"type\" : \"string\"\n }\n }\n }\n }\n\nMore details on mapping may be found in `ElasticSearch's mapping\nreference `__.\n\nField Translations\n^^^^^^^^^^^^^^^^^^\n\nIf the original field names from the CSV file need to be altered or\nfiltered during the import, you may provide a field translations file.\nThe first row of this file should consist of the original field names,\nseparated by the specified delimiter; the second, the new names, again\nseparated by the specified delimeter.\n\n*Please note:* Any original field names omitted from the first row, will\nbe omitted from the indexed data as well. This is a handy way to filter\nthe columns at time of indexing if that is necessary.\n\n.. code:: Bash\n\n python -m esimport -s myserver:9200 -f /path/to/import/data.file -i myindex -t mytype -rm -m /path/to/mapping.json -n /path/to/field/name/translations.file\n\n- -n *field*\\ translation\\_filepath\\_ (location of CSV field\n translation file for specified type)\n\nSample Field Name Translations File\n'''''''''''''''''''''''''''''''''''\n\n::\n\n Album_Category,Album_ID,ISRC,Record_Co,Song_Artist,Song_ID,Song_Secs,Song_Title\n genre,albumID,ISRC,recordCompany,artist,songID,duration,title\n\nBasic Auth\n^^^^^^^^^^\n\nIf login credentials are required, add the arguments -user and -pass\n\n.. code:: Bash\n\n python -m esimport -s https://myserver.com -f /path/to/import/data.file -i myindex -t mytype -user exampleuser -pass examplepassword\n\nVerify SSL\n^^^^^^^^^^\n\nIf ElasticSearch requires SSL, the -nv setting can be used to bypass certificate verification if necessary.\n\n.. code:: Bash\n\n python -m esimport -s https://myserver.com -f /path/to/import/data.file -i myindex -t mytype -user exampleuser -pass examplepassword -nv\n\nBulk Index Count\n^^^^^^^^^^^^^^^^\n\nYou may specify the max number of records to index at time (defaults to 1000) by using the `-bc` argument.\n\n.. code:: Bash\n\n python -m esimport -s https://myserver.com -f /path/to/import/data.file -i myindex -t mytype -user exampleuser -pass examplepassword -bc 500\n\nTimeout\n^^^^^^^\n\nYou may specify the timeout (defaults to 60) for communication with Elasticsearch using the `-T` argument..\n\n.. code:: Bash\n\n python -m esimport -s https://myserver.com -f /path/to/import/data.file -i myindex -t mytype -user exampleuser -pass examplepassword -T 30\n\nDependencies\n------------\n\n- Python libraries\n\n - ``rawes``: `Github `__ \\|\n `documentation `__\n\n- ElasticSearch",
"description_content_type": null,
"docs_url": null,
"download_url": "UNKNOWN",
"downloads": {
"last_day": -1,
"last_month": -1,
"last_week": -1
},
"home_page": "https://github.com/playnetwork/esimport",
"keywords": null,
"license": "MIT license, see LICENSE.txt",
"maintainer": null,
"maintainer_email": null,
"name": "esimport",
"package_url": "https://pypi.org/project/esimport/",
"platform": "UNKNOWN",
"project_url": "https://pypi.org/project/esimport/",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/playnetwork/esimport"
},
"release_url": "https://pypi.org/project/esimport/0.1.9/",
"requires_dist": null,
"requires_python": null,
"summary": "Facilitates the indexing of content from a CSV into ElasticSearch",
"version": "0.1.9"
},
"last_serial": 880571,
"releases": {
"0.1.3": [
{
"comment_text": "",
"digests": {
"md5": "416d27b6141d32d577e49af6de89a57a",
"sha256": "4d9ebbe4faff31472630c2210b84ecfa3bfd4e17741d473b8b7023e329b94f33"
},
"downloads": -1,
"filename": "esimport-0.1.3.tar.gz",
"has_sig": false,
"md5_digest": "416d27b6141d32d577e49af6de89a57a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6550,
"upload_time": "2013-06-12T15:42:22",
"url": "https://files.pythonhosted.org/packages/6e/0b/97d637e54e83a14bf85f5645cf335d81f63f6a5bbf036c469be1a72e1e23/esimport-0.1.3.tar.gz"
}
],
"0.1.4": [
{
"comment_text": "",
"digests": {
"md5": "299c93ffa6738b111b6906ba056f07ea",
"sha256": "4597161fb8658fe27dad63c56fa4696cbfa54d6e431ae096aa2631a5bfb1d48f"
},
"downloads": -1,
"filename": "esimport-0.1.4.tar.gz",
"has_sig": false,
"md5_digest": "299c93ffa6738b111b6906ba056f07ea",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6735,
"upload_time": "2013-06-15T00:08:16",
"url": "https://files.pythonhosted.org/packages/fd/7e/bd2bfc5469845c793d69a873e2f758ad60d31e05c13501aaff3dba999e7b/esimport-0.1.4.tar.gz"
}
],
"0.1.5": [
{
"comment_text": "",
"digests": {
"md5": "1200021db3fca2e52294f21bad9e7426",
"sha256": "0dad5679cb836d5063430ee4ef2f252b5d1208d527b3606c3615a83631e5a5c7"
},
"downloads": -1,
"filename": "esimport-0.1.5.tar.gz",
"has_sig": false,
"md5_digest": "1200021db3fca2e52294f21bad9e7426",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6863,
"upload_time": "2013-06-18T16:07:47",
"url": "https://files.pythonhosted.org/packages/4f/8c/d66fbbc66f154a1a0a7cda0d1e891f1b4d7992997474886a38a71837f69c/esimport-0.1.5.tar.gz"
}
],
"0.1.6": [
{
"comment_text": "",
"digests": {
"md5": "58d3ce531465b114dc422d32926341c3",
"sha256": "372d0ae6a3dffa13f735072301f78dc2a85666cf16864a372cc94692f5c2e21d"
},
"downloads": -1,
"filename": "esimport-0.1.6.tar.gz",
"has_sig": false,
"md5_digest": "58d3ce531465b114dc422d32926341c3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6864,
"upload_time": "2013-06-26T04:45:40",
"url": "https://files.pythonhosted.org/packages/37/d9/4edd48c2ef6c4d2cdb12f5e0a89e78b61e682ea4cff3d6358297fce32f13/esimport-0.1.6.tar.gz"
}
],
"0.1.7": [
{
"comment_text": "",
"digests": {
"md5": "6a6d29f4c89d41be1afa8b119d5974fa",
"sha256": "f1c639843c6cc7d3048627f8202f1e5bbfb0013f01f72c423695cbb436a50dae"
},
"downloads": -1,
"filename": "esimport-0.1.7.tar.gz",
"has_sig": false,
"md5_digest": "6a6d29f4c89d41be1afa8b119d5974fa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7034,
"upload_time": "2013-06-29T15:00:46",
"url": "https://files.pythonhosted.org/packages/97/ce/8aa806366095ea95bf7891a23154416e76d7ac241c599c05eff71cc44737/esimport-0.1.7.tar.gz"
}
],
"0.1.8": [
{
"comment_text": "",
"digests": {
"md5": "0e6d232b937e2459291b280635ffffcf",
"sha256": "72329c5c000e2737ffcf5367f9d05673ec3a4b06fbdc77880b7511e1176a000b"
},
"downloads": -1,
"filename": "esimport-0.1.8.tar.gz",
"has_sig": false,
"md5_digest": "0e6d232b937e2459291b280635ffffcf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7156,
"upload_time": "2013-06-30T17:19:14",
"url": "https://files.pythonhosted.org/packages/12/02/56aeb244e280e70c7f7c38a9f21def9f018c33532f04015c0c0a752bf2b8/esimport-0.1.8.tar.gz"
}
],
"0.1.9": [
{
"comment_text": "",
"digests": {
"md5": "bd54b990f8dbcc92fd60401def2afbeb",
"sha256": "08922a68a275086c58a8db970c011fb1a5b86251290f111689d95c111cd3b0d9"
},
"downloads": -1,
"filename": "esimport-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "bd54b990f8dbcc92fd60401def2afbeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7188,
"upload_time": "2013-10-03T23:10:33",
"url": "https://files.pythonhosted.org/packages/07/77/46afc03bc3c9bf81ac338d9de1c1a5e43e84407f04b19d5ccb9cb19ee27a/esimport-0.1.9.tar.gz"
}
]
},
"urls": [
{
"comment_text": "",
"digests": {
"md5": "bd54b990f8dbcc92fd60401def2afbeb",
"sha256": "08922a68a275086c58a8db970c011fb1a5b86251290f111689d95c111cd3b0d9"
},
"downloads": -1,
"filename": "esimport-0.1.9.tar.gz",
"has_sig": false,
"md5_digest": "bd54b990f8dbcc92fd60401def2afbeb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 7188,
"upload_time": "2013-10-03T23:10:33",
"url": "https://files.pythonhosted.org/packages/07/77/46afc03bc3c9bf81ac338d9de1c1a5e43e84407f04b19d5ccb9cb19ee27a/esimport-0.1.9.tar.gz"
}
]
}