# django-pgstats
`django-pgstats` provides commands and models for tracking internal postgres stats. Specifically, the `IndexStats` model stores stats about postgres indices and the `TableStats` model stores stats about postgres tables.
Postgres stat tables contain global statistical information. `django-pgstats` is meant to be executed periodically so that one can later analyze table and index usage. This is done by periodically calling `python manage.py snapshot_pgstats` using a task runner such as [Celery](http://www.celeryproject.org/).
Stats are stored as JSON fields in the respective `IndexStats` and `TableStats` models. Each key in the JSON field is in the format of `{schema}.{table}` for table stats or `{schema}.{table}.{index}` for index stats.
## Compatibility
`django-pgstats` is compatible with Python 3.9 - 3.13, Django 4.2 - 5.1, Psycopg 2 - 3, and Postgres 13 - 17.
## Documentation
[View the django-pgstats docs here](https://django-pgstats.readthedocs.io/)
## Installation
Install `django-pgstats` with:
pip3 install django-pgstats
After this, add `pgstats` to the `INSTALLED_APPS` setting of your Django project.
## Contributing Guide
For information on setting up django-pgstats for development and contributing changes, view [CONTRIBUTING.md](CONTRIBUTING.md).
## Creators
- @wesleykendall (Wes Kendall)
- @tomage (Tómas Árni Jónasson)
Raw data
{
"_id": null,
"home_page": "https://github.com/AmbitionEng/django-pgstats",
"name": "django-pgstats",
"maintainer": null,
"docs_url": null,
"requires_python": "<4,>=3.9.0",
"maintainer_email": null,
"keywords": null,
"author": "Wes Kendall",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/dd/16/78c4eab52395175f5264f3a9aece6e93fba145468f95e6ad7c3316fd57f0/django_pgstats-1.5.1.tar.gz",
"platform": null,
"description": "# django-pgstats\n\n`django-pgstats` provides commands and models for tracking internal postgres stats. Specifically, the `IndexStats` model stores stats about postgres indices and the `TableStats` model stores stats about postgres tables.\n\nPostgres stat tables contain global statistical information. `django-pgstats` is meant to be executed periodically so that one can later analyze table and index usage. This is done by periodically calling `python manage.py snapshot_pgstats` using a task runner such as [Celery](http://www.celeryproject.org/).\n\nStats are stored as JSON fields in the respective `IndexStats` and `TableStats` models. Each key in the JSON field is in the format of `{schema}.{table}` for table stats or `{schema}.{table}.{index}` for index stats.\n\n## Compatibility\n\n`django-pgstats` is compatible with Python 3.9 - 3.13, Django 4.2 - 5.1, Psycopg 2 - 3, and Postgres 13 - 17.\n\n## Documentation\n\n[View the django-pgstats docs here](https://django-pgstats.readthedocs.io/)\n\n## Installation\n\nInstall `django-pgstats` with:\n\n pip3 install django-pgstats\nAfter this, add `pgstats` to the `INSTALLED_APPS` setting of your Django project.\n\n## Contributing Guide\n\nFor information on setting up django-pgstats for development and contributing changes, view [CONTRIBUTING.md](CONTRIBUTING.md).\n\n## Creators\n\n- @wesleykendall (Wes Kendall)\n- @tomage (T\u00f3mas \u00c1rni J\u00f3nasson)\n\n",
"bugtrack_url": null,
"license": "BSD-3-Clause",
"summary": "Commands and models for tracking internal postgres stats.",
"version": "1.5.1",
"project_urls": {
"Documentation": "https://django-pgstats.readthedocs.io",
"Homepage": "https://github.com/AmbitionEng/django-pgstats",
"Repository": "https://github.com/AmbitionEng/django-pgstats"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1f3c8442d7f2f8917454fa61f28f610392a5a263b333a3867fdb5891d4d83bc0",
"md5": "357aa4a7dd2fe8dfa4df58ad23ab85c1",
"sha256": "3105f8202ee9146a5178ddda32149cd0f22ab052831a1d69bf6156f795e3f54d"
},
"downloads": -1,
"filename": "django_pgstats-1.5.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "357aa4a7dd2fe8dfa4df58ad23ab85c1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4,>=3.9.0",
"size": 5542,
"upload_time": "2024-12-16T01:47:56",
"upload_time_iso_8601": "2024-12-16T01:47:56.403031Z",
"url": "https://files.pythonhosted.org/packages/1f/3c/8442d7f2f8917454fa61f28f610392a5a263b333a3867fdb5891d4d83bc0/django_pgstats-1.5.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dd1678c4eab52395175f5264f3a9aece6e93fba145468f95e6ad7c3316fd57f0",
"md5": "dc7c9dee7204deb6448f59849b1284be",
"sha256": "60d1bb57120587875446d09fd5d0e95fd12bad6a5be60e3e4ff70362f16163b6"
},
"downloads": -1,
"filename": "django_pgstats-1.5.1.tar.gz",
"has_sig": false,
"md5_digest": "dc7c9dee7204deb6448f59849b1284be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4,>=3.9.0",
"size": 4441,
"upload_time": "2024-12-16T01:47:58",
"upload_time_iso_8601": "2024-12-16T01:47:58.325770Z",
"url": "https://files.pythonhosted.org/packages/dd/16/78c4eab52395175f5264f3a9aece6e93fba145468f95e6ad7c3316fd57f0/django_pgstats-1.5.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-16 01:47:58",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "AmbitionEng",
"github_project": "django-pgstats",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "django-pgstats"
}
JSON
