README.md in pgdexter-0.3.10 vs README.md in pgdexter-0.4.0

- old
+ new

@@ -10,12 +10,12 @@ First, install [HypoPG](https://github.com/HypoPG/hypopg) on your database server. This doesn’t require a restart. ```sh cd /tmp -curl -L https://github.com/HypoPG/hypopg/archive/1.2.0.tar.gz | tar xz -cd hypopg-1.2.0 +curl -L https://github.com/HypoPG/hypopg/archive/1.3.1.tar.gz | tar xz +cd hypopg-1.3.1 make make install # may need sudo ``` > Note: If you have issues, make sure `postgresql-server-dev-*` is installed. @@ -30,11 +30,11 @@ ```sh gem install pgdexter ``` -The command line tool is also available as a [Linux package](guides/Linux.md). +The command line tool is also available with [Docker](#docker), [Homebrew](#homebrew), or as a [Linux package](guides/Linux.md). ## How to Use Dexter needs a connection to your database and a log file to process. @@ -188,12 +188,42 @@ dexter --log-sql --log-level debug2 ``` ## Hosted Postgres -Some hosted providers like Amazon RDS and Heroku do not support the HypoPG extension, which Dexter needs to run. See [how to use Dexter](guides/Hosted-Postgres.md) in these cases. +Some hosted providers like Amazon RDS and Heroku do not support the HypoPG extension, which Dexter needs to run. See [how to use Dexter](guides/Hosted-Postgres.md) in these cases. To request the extension: +- Amazon RDS - follow the instructions on [this page](https://aws.amazon.com/rds/postgresql/faqs/) +- Google Cloud SQL - star the [feature request](https://issuetracker.google.com/issues/69250435) +- DigitalOcean Managed Databases - follow the instructions on [this page](https://docs.digitalocean.com/products/databases/postgresql/details/supported-extensions/#supported-extensions) + +## Additional Installation Methods + +### Docker + +Get the [Docker image](https://hub.docker.com/r/ankane/dexter) with: + +```sh +docker pull ankane/dexter +``` + +And run it with: + +```sh +docker run -ti ankane/dexter <connection-options> +``` + +On Mac and Windows, use `host.docker.internal` as the database hostname for databases on your local machine. + +### Homebrew + +With Homebrew, you can use: + +```sh +brew install ankane/brew/dexter +``` + ## Future Work [Here are some ideas](https://github.com/ankane/dexter/issues/1) ## Upgrading @@ -211,10 +241,10 @@ gem specific_install https://github.com/ankane/dexter.git ``` ## Thanks -This software wouldn’t be possible without [HypoPG](https://github.com/dalibo/hypopg), which allows you to create hypothetical indexes, and [pg_query](https://github.com/lfittl/pg_query), which allows you to parse and fingerprint queries. A big thanks to Dalibo and Lukas Fittl respectively. +This software wouldn’t be possible without [HypoPG](https://github.com/HypoPG/hypopg), which allows you to create hypothetical indexes, and [pg_query](https://github.com/lfittl/pg_query), which allows you to parse and fingerprint queries. A big thanks to Dalibo and Lukas Fittl respectively. ## Research This is known as the Index Selection Problem (ISP).