{"id":27933443,"url":"https://github.com/timescale/doctor","last_synced_at":"2025-05-07T04:58:44.447Z","repository":{"id":194109446,"uuid":"560323821","full_name":"timescale/doctor","owner":"timescale","description":"Rule-based recommendations about your timeseries database.","archived":false,"fork":false,"pushed_at":"2025-02-26T15:36:20.000Z","size":48,"stargazers_count":4,"open_issues_count":12,"forks_count":3,"subscribers_count":7,"default_branch":"main","last_synced_at":"2025-05-07T04:58:39.111Z","etag":null,"topics":[],"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/timescale.png","metadata":{"files":{"readme":"README.rst","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-01T08:25:54.000Z","updated_at":"2025-02-26T15:35:56.000Z","dependencies_parsed_at":"2023-09-11T22:54:11.923Z","dependency_job_id":"9ec8df2c-9b19-4f5f-ad6b-66541bd948ab","html_url":"https://github.com/timescale/doctor","commit_stats":null,"previous_names":["timescale/doctor"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdoctor","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdoctor/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdoctor/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/timescale%2Fdoctor/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/timescale","download_url":"https://codeload.github.com/timescale/doctor/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252816948,"owners_count":21808704,"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":"2025-05-07T04:58:43.908Z","updated_at":"2025-05-07T04:58:44.431Z","avatar_url":"https://github.com/timescale.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"Timescale Database Doctor\n=========================\n\nRule-based recommendations about your timeseries database.\n\nInstallation\n------------\n\nYou can install ``timescale-doctor`` using ``pip``::\n\n  pip install timescale-doctor\n\nRunning the tool\n----------------\n\nJust call it in a similar manner to how ``psql`` is called::\n\n  timescale-doctor my_database\n\nIt understands the usual environment variables `PGUSER`, `PGHOST`,\n`PGDATABASE`, etc. Note that it do *not* understand PostgreSQL URLs\nyet. See `Support PostgreSQL URLs for connection\n\u003chttps://github.com/timescale/doctor/issues/5\u003e`_.\n\nRules that are checked\n----------------------\n\nThe Doctor currently has the following rules:\n\n* `index.UnusedIndex`: If an index is unused, it can likely be\n  removed. This will (of course) generate a false positive for\n  databases that have not seen a lot of active use.\n\n* `hypertable.HypertableCandidate`: Detect tables that can be turned\n  into a hypertable. This is mostly beneficial for large tables, but\n  this rule checks if there are 10 pages or more, which is kind of\n  arbitrary.\n\n* `hypertable.ChunkPermissions`: Check that all chunks have\n  permissions that are compatible with the hypertable. If that is not\n  the case, strange errors can be generated for queries on the table.\n\n* `compression.LinearSegmentBy`: If a compressed table uses a\n  segment-by column that increases linearly with rows added, it is\n  probably not a good choice for segment-by.\n\n* `compression.PointlessSegmentBy`: If the compressed table is using a\n  column that is estimated to have a single value, it is usually\n  pointless to use as a segment-by.\n\n\nWriting new rules\n-----------------\n\nInstructions for writing new rules are available in the `README in the\nrules package \u003csrc/doctor/rules/README.rst\u003e`_.\n\nLicense\n-------\n\nCopyright 2023 Timescale, Inc.\n\nLicensed under the Apache License, Version 2.0 (the \"License\"); you\nmay not use this file except in compliance with the License.  You may\nobtain a copy of the License at\n\n    http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or\nimplied.  See the License for the specific language governing\npermissions and limitations under the License.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Fdoctor","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftimescale%2Fdoctor","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftimescale%2Fdoctor/lists"}