{"id":21660088,"url":"https://github.com/slub/solr-fstats","last_synced_at":"2025-05-08T00:21:56.919Z","repository":{"id":41279301,"uuid":"136599604","full_name":"slub/solr-fstats","owner":"slub","description":"A Python3 program that extracts some statistics regarding field coverage from a Solr index.","archived":false,"fork":false,"pushed_at":"2021-07-07T13:51:44.000Z","size":12,"stargazers_count":2,"open_issues_count":0,"forks_count":3,"subscribers_count":8,"default_branch":"master","last_synced_at":"2024-11-25T09:44:35.568Z","etag":null,"topics":["cli","command-line-tool","python","solr","statistics"],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/slub.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-06-08T09:42:50.000Z","updated_at":"2024-04-17T19:47:11.000Z","dependencies_parsed_at":"2022-09-19T02:40:20.479Z","dependency_job_id":null,"html_url":"https://github.com/slub/solr-fstats","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slub%2Fsolr-fstats","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slub%2Fsolr-fstats/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slub%2Fsolr-fstats/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/slub%2Fsolr-fstats/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/slub","download_url":"https://codeload.github.com/slub/solr-fstats/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":235547097,"owners_count":19007626,"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":["cli","command-line-tool","python","solr","statistics"],"created_at":"2024-11-25T09:32:10.883Z","updated_at":"2025-01-25T07:09:02.562Z","avatar_url":"https://github.com/slub.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# solr-fstats - Solr fields statistics\n\nsolr-fstats is a commandline command (Python3 program) that extracts some statistics regarding field coverage from a Solr index. It prints the output as pure CSV data (all values are quoted) to stdout.\n\n## Usage\n\n```\nsolr-fstats\n    required arguments:\n        -core CORE  Solr core to use (default: None)\n\n    optional arguments:\n        -h, --help  show this help message and exit\n        -host HOST  hostname or IP address of the Solr instance to use (default:localhost)\n        -port PORT  port of the Solr instance to use (default: 8983)\n```\n\n* example:\n    ```\n    solr-fstats -host [HOSTNAME OF YOUR SOLR INSTANCE] -core [YOUR SOLR CORE] \u003e [OUTPUT STATISTICS DOCUMENT]\n    ```\n\n## Requirements\n\n* [requests](http://docs.python-requests.org/en/master/)\n* [sortedcontainers](http://www.grantjenks.com/docs/sortedcontainers/)\n\n### Install requirements\n\n1. (optionally) install [pip](https://pip.pypa.io/) for Python 3.x:\n\n    sudo apt-get install python3-pip\n\n2. install requirements with pip:\n\n    sudo -H pip3 install -r requirements.txt\n\n## Run\n\n* install requirements\n* clone this git repo or just download the [solr_fstats.py](solr_fstats/solr_fstats.py) file\n* run ./solr_fstats.py\n* for a hackish way to use solr_fstats system-wide, copy to /usr/local/bin\n\n### Install system-wide via pip\n\n* via pip:\n    ```\n    sudo -H pip3 install --upgrade [ABSOLUTE PATH TO YOUR LOCAL GIT REPOSITORY OF SOLR-FSTATS]\n    ```\n    (which provides you ```solr-fstats``` as a system-wide commandline command)\n\n## Description\n\n(of the column headers of a resulting statistic)\n\n### ... in English\n\n#### field_name\n* the field (path) of this statistic line\n\n#### existing\n* number of records that contain this field (path), i.e., field coverage\n\n#### existing_percentage\n* ^ percentage of 'existing'\n* (existing / Total Records * 100)\n\n#### notexisting\n* number of records that do not contain this field (path)\n\n#### notexisting_percentage\n* ^ percentage of 'notexisting'\n* (not existing / Total Records * 100)\n\n### ... in German\n\nErklärung der Spaltenköpfe\n\n#### field_name\n* Der Pfad zu den analysierten Werten\n\n#### existing\n* gibt an, wieviele Felder diesen Pfades existieren.\n\n#### existing_percentage\n* existing in Prozent\n* existing / Total Records * 100\n\n#### notexisting\n* gibt an, wieviele Rekords nicht über diesen Pfad verfügen\n\n#### notexisting_percentage\n* notexisting in Prozent\n* notexisting / Total Records * 100)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslub%2Fsolr-fstats","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fslub%2Fsolr-fstats","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fslub%2Fsolr-fstats/lists"}