{"id":21377740,"url":"https://github.com/quobject/solr-zkcli","last_synced_at":"2025-03-16T09:45:41.752Z","repository":{"id":3377903,"uuid":"49289122","full_name":"Quobject/solr-zkcli","owner":"Quobject","description":" node.js wrapper for the Solr's ZooKeeper CLI zkcli.sh to manage SolrCloud configuration parameters","archived":false,"fork":false,"pushed_at":"2022-12-07T04:23:15.000Z","size":771,"stargazers_count":1,"open_issues_count":9,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-14T12:16:29.692Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Quobject.png","metadata":{"files":{"readme":"README.md","changelog":null,"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-01-08T18:29:05.000Z","updated_at":"2024-02-19T14:42:29.000Z","dependencies_parsed_at":"2023-01-13T12:28:20.140Z","dependency_job_id":null,"html_url":"https://github.com/Quobject/solr-zkcli","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fsolr-zkcli","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fsolr-zkcli/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fsolr-zkcli/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Quobject%2Fsolr-zkcli/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Quobject","download_url":"https://codeload.github.com/Quobject/solr-zkcli/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243852430,"owners_count":20358270,"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-22T09:23:31.864Z","updated_at":"2025-03-16T09:45:41.728Z","avatar_url":"https://github.com/Quobject.png","language":"TypeScript","readme":"# solr-zkcli\nA node.js wrapper for the Solr's ZooKeeper CLI zkcli.sh to manage [SolrCloud configuration parameters](https://cwiki.apache.org/confluence/display/solr/Command+Line+Utilities)\n\n\n## Installation\n\n### Step 1: Prerequisites\n\nThe [docker](https://docs.docker.com/engine/installation/) command line tool must be installed and accessible in the path.\n\n### Step 2: Get solr image\n\n    docker pull solr:7.2.0\n\n### Step 3: Installation\n\n    npm install solr-zkcli\n\nThen:\n\n```js\nvar solrZkcli = require('solr-zkcli');\n```\n\n## Usage\n\nWith promise\n\n```js\n\nconst solrZkcliOptions = new solrZkcli.SolrZkcliOptions(\n  /* cmd */ 'upconfig',\n  /* currentWorkingDirectory */ undefined,\n  /* zkhost */ '127.0.0.1:2181',\n  /* confname */ 'my_new_config',\n  /* confdir */ 'server/solr/configsets/basic_configs/conf',\n  /* clusterprop*/ undefined,\n  /* solrhome */ undefined,\n  /* solrdockerimage */ undefined,\n  /* machineName */ 'localhost',\n  /* network */ 'host',\n);\n\n\nsolrZkcli.SolrZkCliCommand( options ).then( (data) =\u003e {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\nWith callback:\n\n```js\n\nsolrZkcli.SolrZkCliCommand( options, function (err, data) {\n  console.log('data = ', data);\n});\n\n```\n\n## typescript\n\n```js\nimport { SolrZkcliOptions, SolrZkCliCommand, SolrZkcliResult } from 'solr-zkcli';\n\nconst solrZkcliOptions = new SolrZkcliOptions(\n  /* cmd */ 'upconfig',\n  /* currentWorkingDirectory */  undefined,\n  /* zkhost */ '127.0.0.1:2181',\n  /* confname */ 'my_new_config',\n  /* confdir */ 'server/solr/configsets/basic_configs/conf',\n  /* clusterprop*/ undefined\n);\n\n\nSolrZkCliCommand(solrZkcliOptions).then((data: SolrZkcliResult) =\u003e {\n  console.log('data = ', data);\n});\n\n```\n\n\n\n\n* bootstrap\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:9983/fmlogging',\n  cmd: 'bootstrap',\n  solrhome: 'server/solr/'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* put\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:9983',\n  cmd: 'put /my_zk_file.txt \\'some data\\''\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* putfile\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:9983',\n  cmd: 'putfile /my_zk_file.txt /tmp/my_local_file.txt'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* makepath\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:9983',\n  cmd: 'makepath /solr'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* clusterprop\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:' + config.zkport,\n  cmd: 'clusterprop',\n  name: 'urlScheme',\n  val: 'https'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* downconfig\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:9983',\n  cmd: 'downconfig',\n  confname: 'my_new_config',\n  confdir: '/var/download'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n\n```\n\n* get\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:' + config.zkport,\n  cmd: 'get /my_zk_file.txt'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  data =  { ok: true, returnedData: 'some data' }\n\n```\n\n* getfile\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:' + config.zkport,\n  cmd: 'get /my_zk_file.txt /path/to/return.txt'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  data =  { ok: true }\n\n```\n\n\n\n* list\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:' + config.zkport,\n  cmd: 'list'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data = {\n//  ok: true,\n//  returnedData:\n//   ['/ (2)',\n//     'DATA:',\n//     '    ',\n//     ' /my_zk_file.txt (0)',\n//     ' DATA: ...supressed...',\n//     ' /zookeeper (1)',\n//     ' DATA:']\n//}\n\n```\n\n* clear\n\n```js\n\nvar options = {\n  zkhost: '127.0.0.1:' + config.zkport,\n  cmd: 'clear /solr'\n};\n\nsolrZkcli( options ).then(function (data) {\n  console.log('data = ', data);\n});\n\n//data =  { ok: true }\n```\n\n## License\n\nMIT\n\n[npm-image]: https://img.shields.io/npm/v/solr-zkcli.svg?style=flat\n[npm-url]: https://npmjs.org/package/solr-zkcli\n[downloads-image]: https://img.shields.io/npm/dm/solr-zkcli.svg?style=flat\n[downloads-url]: https://npmjs.org/package/solr-zkcli\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquobject%2Fsolr-zkcli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fquobject%2Fsolr-zkcli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fquobject%2Fsolr-zkcli/lists"}