{"id":19083705,"url":"https://github.com/deepstreamio/deepstream.io-storage-elasticsearch","last_synced_at":"2025-04-30T08:55:09.664Z","repository":{"id":44219648,"uuid":"57392042","full_name":"deepstreamIO/deepstream.io-storage-elasticsearch","owner":"deepstreamIO","description":"A deepstream.io storage connector for elasticsearch","archived":false,"fork":false,"pushed_at":"2023-01-06T03:13:09.000Z","size":212,"stargazers_count":7,"open_issues_count":6,"forks_count":6,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-12T01:18:30.424Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deepstreamIO.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-04-29T14:49:39.000Z","updated_at":"2021-05-27T08:44:05.000Z","dependencies_parsed_at":"2023-02-05T04:46:56.393Z","dependency_job_id":null,"html_url":"https://github.com/deepstreamIO/deepstream.io-storage-elasticsearch","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepstreamIO%2Fdeepstream.io-storage-elasticsearch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepstreamIO%2Fdeepstream.io-storage-elasticsearch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepstreamIO%2Fdeepstream.io-storage-elasticsearch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deepstreamIO%2Fdeepstream.io-storage-elasticsearch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deepstreamIO","download_url":"https://codeload.github.com/deepstreamIO/deepstream.io-storage-elasticsearch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223780069,"owners_count":17201287,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-09T02:48:49.603Z","updated_at":"2024-11-09T02:48:50.369Z","avatar_url":"https://github.com/deepstreamIO.png","language":"JavaScript","readme":"# deepstream.io-storage-elasticsearch [![npm version](https://badge.fury.io/js/%40deepstream%2Fstorage-elasticsearch.svg)](https://badge.fury.io/js/%40deepstream%2Fstorage-elasticsearch)\n\n[deepstream](http://deepstream.io) storage connector for [elasticsearch](https://www.elastic.co/)\n\nThis connector uses [the npm elasticsearch package](https://www.npmjs.com/package/elasticsearch). Please have a look there for detailed options.\n\n## Configuration Options\n```yaml\nplugins:\n  storage:\n    name: elasticsearch\n    options:\n      host: 'localhost:9200'\n      index: 'someIndex'\n      defaultType: 'someType'\n      splitChar: '/'\n      indexSettings: '\n        {\n          \"number_of_shards\" : 1\n        }\n      '\n      indexMappings: '\n        {\n          \"type1\" : {\n            \"properties\" : {\n              \"field1\" : { \"type\" : \"string\", \"index\" : \"not_analyzed\" }\n            }\n          }\n        }\n      '\n```\n\n```javascript\n{\n\t//The host that elasticsearch should use\n\thost: 'localhost:9200',\n\n\t//(Optional, no default). The authentication to elasticsearch\n\tauth: 'user:password',\n\tusername: 'user'\n\tpassword: 'password'\n\n\t//(Optional, defaults to 'deepstream'). This is the index in elasticsearch,\n\t//using database for consistency across all plugins.\n\tindex: 'someIndex',\n\n\t//(Optional, defaults to 'deepstream_records'). This is the type in elasticsearch,\n\t//using table for consistency across all plugins\n\tdefaultType: 'someType',\n\n\t//(Optional, defaults to 1000). This is the ping timeout used\n\t//when doing the initial ping to ensure the connection is setup correctly\n\tpingTimeout: 200,\n\n\t/* (Optional) A character that's used as part of the\n\t* record names to split it into a tabel and an id part, e.g.\n\t*\n\t* books/dream-of-the-red-chamber\n\t*\n\t* would create a type called 'books' and store the record under the name\n\t* 'dream-of-the-red-chamber'\n\t*/\n\tsplitChar: '/'\n\n\t/* (Optional) Index settings:\n\t* https://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-update-settings.html\n\t*/\n\tindexSettings: {\n\t\tnumber_of_shards: 1\n\t}\n\n\t/* (Optional) Index mapping:\n\t* https://www.elastic.co/guide/en/elasticsearch/reference/2.3/indices-put-mapping.html\n\t*/\n\tindexMappings: {\n    type1: {\n\t\t\tproperties: {\n\t\t\t\tfield1: {\n\t\t\t\t\ttype: 'string',\n\t\t\t\t\tindex: 'not_analyzed'\n\t\t\t\t}\n\t\t\t}\n\t\t}\n\t}\n}\n```\n\n## Basic Setup\n```javascript\nvar Deepstream = require( 'deepstream.io' ),\n    ElasticSearchStorageConnector = require( 'deepstream.io-storage-elasticsearch' ),\n    server = new Deepstream();\n\nserver.set( 'storage', new ElasticSearchStorageConnector( {\n  host: 'localhost:9200',\n  splitChar: '/'\n}));\n\nserver.start();\n```\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepstreamio%2Fdeepstream.io-storage-elasticsearch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeepstreamio%2Fdeepstream.io-storage-elasticsearch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeepstreamio%2Fdeepstream.io-storage-elasticsearch/lists"}