https://github.com/matthewmcgarvey/lucky_pg_extras
Crystal/Lucky PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more.
https://github.com/matthewmcgarvey/lucky_pg_extras
crystal lucky-framework postgresql
Last synced: 2 months ago
JSON representation
Crystal/Lucky PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more.
- Host: GitHub
- URL: https://github.com/matthewmcgarvey/lucky_pg_extras
- Owner: matthewmcgarvey
- License: mit
- Created: 2020-09-30T02:23:40.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2021-08-02T20:12:00.000Z (almost 5 years ago)
- Last Synced: 2025-03-30T19:24:34.700Z (over 1 year ago)
- Topics: crystal, lucky-framework, postgresql
- Language: Crystal
- Homepage:
- Size: 27.3 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Lucky PG Extras
Crystal port of [Ruby PG Extras](https://github.com/pawurb/ruby-pg-extras) which is a Ruby port of [Heroku PG Extras](https://github.com/heroku/heroku-pg-extras).
## Installation
1. Add the dependency to your `shard.yml`:
```yaml
dependencies:
lucky_pg_extras:
github: matthewmcgarvey/lucky_pg_extras
```
2. Run `shards install`
3. Require the shard in `src/shards.cr`
```crystal
require "lucky_pg_extras"
```
4. Set up the configuration in `config/lucky_pg_extras.cr`
```crystal
LuckyPgExtras.configure do |settings|
settings.database = AppDatabase
end
```
Some of the queries (e.g., `calls` and `outliers`) require [pg_stat_statements](https://www.postgresql.org/docs/current/pgstatstatements.html) extension enabled.
## Usage
Running `lucky -h` should now show the `pg_extras` commands that are available.
## Development
TODO: Write development instructions here
## Contributing
1. Fork it ()
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request
## Contributors
- [Matthew McGarvey](https://github.com/matthewmcgarvey) - creator and maintainer