lucky_pg_extras

Version, currently 0.2.02 versions

github.com/matthewmcgarvey/lucky_pg_extras

Crystal/Lucky PostgreSQL database performance insights. Locks, index usage, buffer cache hit ratios, vacuum stats and more.

1 stars
0 dependents
License: MIT

Installation

# Add this to your shard.yml
dependencies:
  lucky_pg_extras:
    github: matthewmcgarvey/lucky_pg_extras
    version: ~> 0.2.0

Then run:

shards install

shard.yml

Crystal
>= 1.0.0
License
MIT
Author
Matthew McGarvey

Dependencies

Runtime Dependencies

  • avram~> 0.20github: luckyframework/avram
  • habitat~> 0.4.7github: luckyframework/habitat
  • tallboy*github: epoch/tallboy, branch: master
  • lucky_task~> 0.1github: luckyframework/lucky_task

README

Lucky PG Extras

Crystal port of Ruby PG Extras which is a Ruby port of Heroku PG Extras.

Installation

  1. Add the dependency to your shard.yml:

    dependencies:
      lucky_pg_extras:
        github: matthewmcgarvey/lucky_pg_extras
  2. Run shards install

  3. Require the shard in src/shards.cr

    require "lucky_pg_extras"
  4. Set up the configuration in config/lucky_pg_extras.cr

    LuckyPgExtras.configure do |settings|
      settings.database = AppDatabase
    end

Some of the queries (e.g., calls and outliers) require pg_stat_statements 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 (https://github.com/matthewmcgarvey/lucky_pg_extras/fork)
  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