pgscope

PL/pgSQL source code tree search and browse tool

Embed seamlessly with vim

Getting Started

Download

Fedora 27 RPM Package

Installation from source

git clone https://github.com/gjalves/pgscope.git
cd pgscope
git clone https://github.com/lfittl/libpg_query.git
cd libpg_query
make
cd -
make
cp pgscope /usr/bin/pgscope
mkdir -p ~/.vim/after/ftplugin/
cp sql.vim ~/.vim/after/ftplugin/sql.vim

Using

Type pgscope to index all .sql files in current and descending directories. After that, open your .sql file with vim and put cursor under any external function. Call it using CTRL+]. If you wish to came back to calling function, use CTRL+o

You can autocomplete functions using CTRL+x and CTRL+o If you need to reindex, use :!pgscope in vim.

If you wish to reindex automatically after save, type in vim command mode:

:autocmd BufWritePost *.sql :silent !pgscope

Donation

Contributions of any amount are very welcome and will help the continuity of this software development

Author

Gustavo Junior Alves

License

PgScope is copyright 2017 for Gustavo Junior Alves and available under BSD 3-Clause License. See the LICENSE file.