Советы для начинающих разработчиков PostgreSQL
2 likes691 views
Документ представляет собой руководство для разработчиков PostgreSQL, описывающее структуру международного сообщества, процесс написания патчей и инструменты для разработчиков. В нем рассматриваются этапы разработки, включая создание веток, тестирование и коммитфесты, а также содержит советы по общению в рассылках. Также документ охватывает важные ресурсы и настройки для работы с PostgreSQL.
Советы для начинающих разработчиков PostgreSQL
- 2. 2 Содержание • Как устроено международное сообщество PostgreSQL • Как написать патч (от Proposal до Commit'а) • Инструменты разработчика
- 3. 3 Мотивация • Изучение PostgreSQL • Создание материала для обучения новых разработчиков • Шпаргалка и чек-лист для себя • Обмен опытом *Подчеркнутый текст – это ссылки
- 4. 4 Содержание • Как устроено международное сообщество PostgreSQL • Как написать патч (от Proposal до Commit'а) • Инструменты разработчика
- 5. 5
- 6. 6 Сообщество PostgreSQL • The PostgreSQL Global Development Group (PGDG) – Основная команда – core team – Коммитеры – commiters – (Основные) разработчики – (Major) contributors • Компании-спонсоры (Postgres Professional, EnterpriseDB, 2ndQuadrant, Cybertec...)
- 7. 7 Open source • Распространяется свободно • Лицензия PostgreSQL License – похожа на BSD • Исходный код PostgreSQL доступен на Github • Документация в открытом доступе на официальном сайте – Содержит разделы и для DBA, и для разработчиков
- 8. 8 Конференции и встречи • PGCon в Оттаве (в середине июня) • PGConf.eu (в конце октября) • PGConf.ru (в начале февраля) • Множество локальных PGConf и PGDay (в течение года) • #PostgreSQLRussia Meetup (каждый месяц) • Семинары Postgres Professional
- 9. 9 Mailing lists (листы рассылки) • pgsql-hackers – основной лист для общения разработчиков • pgsql-bugs • pgsql-general • pgsql-perfomance • pgsql-novice • И так далее...
- 10. 10 Правила хорошего тона в листах рассылки • Отдельное письмо для новой темы • Используйте теги и пометки – PROPOSAL, WIP (Work In Progress), POC (Proof Of Concept), PATCH • Отвечайте в рассылку или “Ответить всем” • Цитируйте
- 11. 11 Правила хорошего тона в листах рассылки • Используйте подпись, если работаете в компании Hi, hackers! Blablabla. Anastasia Lubennikova Postgres Professional: http://www.postgrespro.com The Russian Postgres Company
- 12. 12 Правила хорошего тона в листах рассылки • Пишите ответ в конце письма A: Because it reverses the logical flow of conversation. Q: Why is top posting frowned upon? A: Topposting. Q: What is the most annoying thing on usenet and in email?
- 13. 13 Цикл разработки • Создание ветки для новой версии • Commitfests (с июля по март) • Feature Freeze (середина апреля) • Alpha-версия • Тестирование и доработка • Beta-версия (середина июня) • Выпуск новой версии PostgreSQL (середина октября)
- 14. 14 Commitfests • Разработчики выкладывают патчи • Получают обратную связь от Reviewers • Автор дорабатывает патч • Reviewer отмечает патч как готовый для коммита • Коммитер добавляет патч в репозиторий на Github
- 15. 15 Где найти материалы? • Документация • Feature Matrix • Архивы листов рассылок • Wiki PostgreSQL • Блоги о PostgreSQL • Книги • Видео докладов с конференций • README и комментарии к коду
- 16. 16 Содержание • Как устроено международное сообщество PostgreSQL • Как написать патч (от Proposal до Commit'а) • Инструменты разработчика
- 17. 17 Как написать патч • Идея • Proposal (предложение) • Обсуждение • Разработка • Ревью • Принятый патч
- 18. 18 Идея • Есть ли готовые решения? • Это задача из TODO? • Предыдущие обсуждения в hackers? • Аналоги в других системах? • Документация и README • Исходный код
- 19. 19 Proposal • Идея, use case • Измеримые результаты • Необходимые изменения – например, новый синтаксис • Ссылки на: – прошлые обсуждения в hackers – академические статьи • Вопросы
- 20. 20 Обсуждение • Кто-то уже работает над этим • Подводные камни • Вопросы реализации • Предложения • Это слишком сложно внедрить • Это никому не нужно =( Защищайте свою идею!
- 21. 21 Разработка • Код • Отладка • Тесты – regression tests – concurrency tests – обратная совместимость • Code style • Документация
- 22. 22 Код
- 23. 23 Отладка • Gdb – select pg_backend_pid(); pg_backend_pid 5140 (1 row) – gdb p 5140 • Logfile
- 24. 24 Отладочный вывод • elog elog(LOG,“Server msg”); elog(NOTICE,“Client expected msg”); elog(WARNING,“Client unexpected msg”); elog(ERROR, “Abort transaction”); ● print.c, outfuncs.c ● Assert Assert(some_ptr != NULL);
- 25. 25 Regression tests • Regression tests – make check – vi src/test/regress/regression.diffs • Добавить новый – src/test/regress/sql/new.sql – src/test/regress/expected/new.out – src/test/regress/serial_schedule – src/test/regress/parallel_schedule
- 27. 27 Buildfarm • PostgreSQL Buildfarm • Только после коммита
- 28. 28 Dataset • Sample Databases • Встроенные функции – random(); – generate_series(start, stop, step); CREATE TABLE test (id integer, b box); INSERT INTO test (SELECT x, point(random(), random()) FROM generate_series(1,10) as x);
- 29. 29 Настройки • postgresql.conf – SHOW config_file; – SHOW ALL; – select * from pg_settings; • ? – timing – x
- 30. 30 Настройки • Planner configuration – SET enable_indexscan=false; – SET enable_mergejoin=false; • EXPLAIN – explain (analyze, buffers) table t; – explain (analyze, verbose) table t; – explain (analyze, format xml) table t;
- 31. 31 Code style • Выравнивание Tab'ами • Tab-size = 4 • Без концевых пробелов • {} на отдельной строке • Перенос длинных строк • Объявления переменных в начале блока
- 32. 32 Code style • Комментарии /* * (___/) комментарий * (='.'=) со сложным * (")_(") форматированием * */ • src/tools/pgindent
- 33. 33 Документация • Комментарии – объяснить “зачем”, а не “как” – упомянуть зависимости • README – обзор раздела кода • Документация – примеры – предупреждения
- 34. 34 Патч • Новое письмо в hackers. – Ссылка на прошлое обсуждение – Описание ситуации – На какой коммит оно ложится – Тесты и результаты – Документация • Патч на коммитфесте
- 35. 35 Содержание • Как устроено международное сообщество PostgreSQL • Как написать патч (от Proposal до Commit'а) • Инструменты разработчика
- 37. 37 Git ● Ежедневная работа с Git ● Шпаргалка ● Поиск коммита по изменениям – git log S 'vacuum'
- 38. 38 IDE / Текстовый редактор ● Vim. Filestyle ● Emacs. src/tools/editors ● Sublime Text. Trailing Spaces ● KDevelop ● Eclipse ● Doxygen* *только web-интерфейс к коду
- 42. 42 Установка ● Installation guide ./configure // не забывайте флаги make j4 make check // временная установка и тесты su #make install #adduser postgres #mkdir $WORKSPACE_PATH/postgres_data #chown postgres $WORKSPACE_PATH/postgres_data
- 44. 44 Продолжение следует... ● В следующий раз: – как организован исходный код – System Catalogs – Node, Oid, Datum, Relation и прочие страшные слова