Skip to content

Commit

Permalink
Slight improvements to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
davidfetter authored and David Fetter committed May 14, 2019
1 parent a551bed commit c5dccfe
Show file tree
Hide file tree
Showing 4 changed files with 37 additions and 13 deletions.
21 changes: 21 additions & 0 deletions LICENSE
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2015-2019 David Fetter

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
2 changes: 1 addition & 1 deletion META.json
Expand Up @@ -4,7 +4,7 @@
"description": "A long description",
"version": "1.1.0",
"maintainer": "David Fetter <david@fetter.org>",
"license": "bsd2",
"license": "mit",
"provides": {
"pgbouncer_wrapper": {
"abstract": "Wrap pgbouncer output in a FDW",
Expand Down
6 changes: 3 additions & 3 deletions README.md
Expand Up @@ -3,20 +3,20 @@ pgbouncer_wrapper

This is a wrapper around Peter Eisentraut's excellent [post](http://peter.eisentraut.org/blog/2015/03/25/retrieving-pgbouncer-statistics-via-dblink/)

A long description
If you've ever wanted to run SQL queries against pgbouncer's SHOW output, this
is a handy way to do just that.

To build it, just do this:

make
make installcheck
make install

Be sure that you have `pg_config` installed and in your path. If you used a
package management system such as RPM to install PostgreSQL, be sure that the
`-devel` package is also installed. If necessary tell the build process where
to find it:

env PG_CONFIG=/path/to/pg_config make && make installcheck && make install
env PG_CONFIG=/path/to/pg_config make && make install

Once pgbouncer_wrapper is installed, you can add it to a database like this:

Expand Down
21 changes: 12 additions & 9 deletions doc/pgbouncer_wrapper.md
Expand Up @@ -4,30 +4,33 @@ pgbouncer_wrapper
Synopsis
--------

Show a brief synopsis of the extension.
```sql
SELECT count(*) FROM pgbouncer.sockets;
```

Description
-----------

A long description
pgbouncer provides a tantalizingly tabular-looking set of primitives for
monitoring it. `pgbouncer_wrapper` goes the rest of the way and exposes them
for reading via SQL.

Usage
-----

Show usage.
Install the extension. Connect it to pgbouncer. Enjoy the SQL!

Support
-------

There is issues tracker? Github? Put this information here.
https://github.com/davidfetter/pgbouncer_wrapper/issues

Author
------

[David Fetter <david@fetter.org>]
[David Fetter](mailto:david@fetter.org)

Copyright and License
---------------------

Copyright (c) 2015-2019 David Fetter <david@fetter.org>.
Copyright
---------

Copyright (c) 2015-2019 David Fetter &lt;david@fetter.org&gt;.

0 comments on commit c5dccfe

Please sign in to comment.