Глобальные настройки

Основные настройки pgCodeKeeper

_images/main_prefs.png
  • Show console on new output / Показывать консоль - позволяет автоматически показывать консоль программы при выводе в нее.
  • Ignore privileges and owners of database objects / Не учитывать привилегии и владельцев объектов - позволяет отключить поиск различий в свойствах объектов, связанных с ролями БД.
  • Ignore differences in table column order / Игнорировать различия в порядке столбцов таблицы - позволяет не учитывать порядок столбцов при сравнении таблиц.
  • Reuse compare editor instead of opening new ones / Использовать открытый редактор сравнения вместо создания новых - позволяет использовать открытый редактор сравнения при сравнения объектов базы данных (В контекстном меню таблицы различий выбрать пункт Show Diff / Показать различия).
  • Enable full dependencies from bodies of functions and procedures (experimental) / Учитывать все зависимости из тел функций и процедур (экспериментально) - позволяет искать внутри тел функций и процедур зависимости к другим функциям и процедурам.
  • Simple formatting for VIEVs when reading via JDBC (not recommended by PostgreSQL) / Упрощенное форматирование представлений при чтении через JDBC (не рекомендовано PostgreSQL) - позволяет использовать упрощенное форматирование представлений, убирая лишние скобки в выражениях. Данный формат может не поддерживаться в будущих версиях PostgeSQL.
  • Ignore concurrent modification errors when reading DB / Игнорировать ошибки конкурентной модификации объектов при чтении БД - позволяет игнорировать ошибки, возникающие при модификации объекта БД во время его чтения.
  • Free parser cache memory if not used for (minutes): / Освобождать память кэша парсера если он не использовался последние (минут): - позволяет автоматически очищать неиспользуемый кэш парсера через определенный промежуток времени. Значение равное 0 отключает данное поведение.
  • Clear parser cache / Очистить кэш парсера - позволяет очистить кэш парсера.

Исключенные объекты

Объекты, которые не должны учитываться при сравнении БД, возможно указать на странице настроек pgCodeKeeper -> Ignored Objects / Исключенные объекты.

_images/ignore_list.png

Переключатель Черный список - Белый список позволяет инвертировать черный список в белый и обратно.

  • Text / Текст – имя объекта.
  • Pattern / Шаблон – воспринимать имя объекта как регулярное выражение.
  • Ignore Contents / Игнорировать содержимое – применять правило для совпавшего объекта и всего его содержимого.
  • Qualification / Квалификация – искать объекты по квалифицированному имени.
  • Type / Тип – тип объекта («ALL» предназначен для указания любого типа объекта).

Для добавления объекта в список исключенных или удаления из него, служат кнопки add_obj и delete соответственно.

Примечание

В данном случае список исключаемых объектов будет общим и будет распространять свое действие на все проекты находящиеся в директории проектов. Подробное описание работы со списками находится в разделе Список исключаемых объектов.

Обновление БД

Настройки, управляющие обновлением базы данных.

_images/db_update_prefs.png

На странице настроек pgCodeKeeper -> Update DB / Обновление БД Вы можете настроить параметры для работы редактора скрипта наката.

  • Create migration script files in project directory / Создавать скрипт миграции в директории проекта – определяет поведение при создании скриптов миграции.
  • Delete migration script files when closing migration editor / Удалять файлы скриптов миграции после закрытия редактора – определяет поведение при закрытии скриптов миграции, если они были созданы в директории проекта.
  • Warn about dangerous scripts containing: / Предупреждать, если в скрипте присутствуют следующие выражения: – позволяет предупреждать, если при генерации скрипта образовались выбранные опасные выражения.
  • Show script output in separate window / Показывать вывод скрипт наката в отдельном окне – позволяет просмотреть сообщение с ответом сервера при выполнении наката.
  • Surround migration script with START TRANSACTION; … COMMIT TRANSACTION; / Заключить скрипт наката в блок START TRANSACTION; … COMMIT TRANSACTION; – позволяет дополнять генерируемые скрипты парой start … commit.
  • Allow PostgreSQL to validate function bodies in DDL update script / Разрешить PostgreSQL проверять тела функций в скрипте наката – позволяет при генерации скрипта добавлять проверку «SET check_function_bodies = true;» в начало скрипта.
  • Print ALTER COLUMN … TYPE with USING expression / Печатать ALTER COLUMN … TYPE … с USING expression – позволяет добавлять в скрипт выражение, позволяющее изменить тип данных, при изменении типа столбца
  • Print CREATE INDEX CONCURRENTLY (without locks) / Печатать CREATE INDEX CONCURRENTLY (без блокировок) – позволяет в скриптах создавать индексы в режиме CONCURRENTLY.
  • Create a script only from objects selected in the comparison panel / Создавать скрипт только из объектов, выбранных в панели сравнения – позволяет исключить из скрипта объекты, которые не были выбраны явно.
  • Migration command / Команда миграции - позволяет использовать другую утилиту или параметры запуска при применении скрипта наката к базе данных.

Отчеты об использовании

Настройки, управляющие отправкой отчетов.

_images/report.png

На странице настроек pgCodeKeeper -> Usage Reporting / Отчеты об использовании Вы можете включить или выключить отправление статистики об использовании pgCodeKeeper.

Отправляемые значения для статистики Вы можете просмотреть в поле Reported Values / Отправляемые значения.

Редактор проекта

Настройки, управляющие редактором проекта.

_images/proj_editor_prefs.png

На странице настроек pgCodeKeeper -> Project editor / Редактор проекта Вы можете настроить параметры редактора проекта.

  • Switch to pgCodeKeeper perspective when opening editor / Переключать в перспективу pgCodeKeeper при открытии редактора – определяет поведение переключения перспективы при открытии редактора проекта.
  • After applying a migration to editor’s DB do: / После выполнения миграции на БД редактора выполнить: – определяет поведение редактора при накате скриптов миграции.
  • Display git user that math the change / Отображать пользователя git, совершившего изменение – позволяет отображать в редакторе колонку с пользователем git, совершившем последнее изменение файла. Проект должен находиться под системой контроля версий.
  • Show errors while getting changes / Показывать ошибки во время получения изменений – позволяет отображать список ошибок, найденных во время получения изменений.

Редактор SQL

Настройки, управляющие редактором SQL.

_images/sql_editor_prefs.png

На странице настроек pgCodeKeeper -> SQL Editor / Редактор SQL Вы можете настроить параметры редактора SQL.

  • Disable parser for files larger than (lines): / Отключить парсер для файлов больше чем (строки): – позволяет выбрать размер файла, для которого отключается сборщик pgCodeKeeper. Это ускоряет открытие и работу с файлом, но отключает поиск ошибок и ссылок на объекты внутри этого файла. Значение равное 0 отключает данное поведение.
  • Bracket highlight / Подсветка скобок – включает подсветку скобок в одном из режимов.
  • Single bracket / Одна скобка – при выборе скобки, подсвечивает парную скобку.
  • Both brackets / Обе скобки – при выборе скобки, подсвечивает текущую и парную скобку.
  • Current block brackets / Скобки текущего блока – подсвечивает скобки, между которыми находится курсор.
  • Bracket highlight color / Цвет подсветки скобок – позволяет выбрать цвет подсветки скобок.

Подсветка синтаксиса

Настройки, управляющие подсветкой синтаксиса.

_images/syntax_highlighting.png

На странице настроек pgCodeKeeper -> SQL Editor / Редактор SQL -> Syntax Coloring / Подсветка синтаксиса Вы можете установить цвет и стиль шрифта, которым будет отображаться соответствующий синтаксис в SQL редакторе pgCodeKeeper.

Шаблоны редактора SQL

Создание, удаление и редактирование шаблонов для автоподстановки в SQL редакторе

_images/sql_templates.png

На странице настроек pgCodeKeeper -> SQL Editor / Редактор SQL -> SQL Editor Templates / Шаблоны редактора SQL Вы можете управлять SQL шаблонами, доступными в SQL редакторе pgCodeKeeper. Список доступных действий отображается справа от списка шаблонов.

Хранилище БД

Настройки, управляющие хранилищем параметров подключения к БД.

На странице настроек pgCodeKeeper -> DB Store / Хранилище БД находится список записей для подключения к базам данных.

_images/db_store.png

Для добавления хранилища нажать кнопку add_obj. Откроется диалог DB credentials (Данные подключения к БД), в котором нужно указать параметры данных подключения: хост, порт, имя БД, пользователь, пароль, а также включить запрет на запись в БД и выбрать тип БД (PostgreSQL или MS SQL). Для MS SQL можно указать домен. Название записи можно указать вручную, для этого нужно отключить опцию Auto-generate / Автогенерация.

Примечание

pgCodeKeeper поддерживает работу с pgpass файлом. Для этого поле с паролем нужно оставить пустым.

_images/new_connection.png

Список исключаемых объектов можно подключить как внешний файл.

_images/new_connection_ignore_list.png
Свойства соединения можно дополнить параметрами указанными по адресу:
_images/new_connection_properties.png
  • Use external DB loader instead of JDBC / Использовать внешний загрузчик pg_dump - позволяет использовать внешний загрузчик для базы данных вместо JDBC.
  • Loader executable / Исполняемый файл загрузчика - путь к утилите, исполняемому файлу или скрипту, используемый для загрузки.
  • Loader custom parameters / Дополнительные параметры загрузчика - дополнительные параметры вызова утилиты.
_images/new_connection_pg_dump.png

Для добавления хранилища на основе данных из уже созданного хранилища следует выделить объект хранилища баз данных, нажать кнопку copy. Откроется диалог DB credentials / Данные подключения к БД в котором можно изменить параметры подключения.

Для добавления хранилища на основе данных из файла .pgpass, нажать кнопку pg_pass. Откроется диалог в котором необходимо выбрать .pgpass файл. Далее откроется диалог Pgpass sources list / Список источников из pgpass:

_images/db_store_dialog_pg_pass_1.png

В нем нужно выбрать строку с данными на основе которых будет создаваться хранилище. Откроется диалог DB credentials / Данные подключения к БД в котором можно подтвердить параметры подключения.

_images/db_store_dialog_pg_pass_2.png

После этого можно закрывать диалог Pgpass sources list / Список источников из pgpass.

Для редактирования хранилища выделить объект хранилища баз данных, нажать кнопку editor_area. Откроется диалог DB credentials / Данные подключения к БД в котором можно изменить параметры подключения.

Для удаления хранилища выбрать необходимую запись и нажать кнопку delete.

Внимание

Кнопка Restore Defaults, на странице настроек, удаляет все записи для подключения к базам данных и создает одну запись default без данных для подключения.

Внимание

Для сохранения внесенных изменений, в хранилище параметров подключения к БД, на странице настроек необходимо нажать кнопку Apply или Apply and Close.