What is pgAdmin?
It’s a very popular open source platform fully dedicated to PostgreSQL and has a graphical user interface administration tools to manage your relational databases. Some features include a query tool for SQL statements and importing/exporting csv files.
What’s Covered:
- Download pgAdmin & PostgreSQL
- pgAdmin Overview
- Connect an Existing Database(AWS)
Note: To my knowledge the tutorial will work with macOS and Windows
Download
Notes: I’m using macOS, version # will change, and the page layout could change
To use pgAdmin, you will need to download it on your system. Pick pgAdmin 4 for your OS.
After selecting your OS, a download page showing different version releases in descending order will appear. Choose the latest version and it will take you to the file browser page. Then click the largest file to download and follow the installation instructions.
For PostgreSQL, you can download it here. Choose the latest version for your machine.
Notes: When installing PostgreSQL you don’t need to change any of the default settings. If you forget your password, you won’t have access to your PostgreSQL server anymore.
pgAdmin Overview
PgAdmin will use your preferred web browser to display a graphical user interface. You don’t need internet to view local servers. It will prompt you for a master password every time you open pgAdmin to get access. After getting access click Servers(1) on the left side to open up your PostgreSQL 12 server. If you don’t see a server, try restarting pgAdmin.
Open up your database to get a tree view menu according to the picture below. You will see a database named postgres. Selecting the database will bring up an activity dashboard to view traffic information.
You have access to useful tools by right-clicking on any object in the tree view menu. We can create a new database, schema, and tables. As well as viewing individual table data and customizing an existing table.
Create Example:
Let’s create a table by right clicking on Tables and click Table…
Give your table a name and then click Columns
Click the + symbol to add columns
Name your column, select the data type, and give a length if needed. Then click Save
Now that you have created a table, view it under the Tables object. Right click and refresh if it didn’t update.
Query Tool Example:
Note: I’m showing you my database with data for demonstration purposes
When an object is selected under the database tree view menu, you can click the Tools tab and click Query Tool. Query tool brings up an editor to execute SQL statements.
You can also right click the database and click Query Tool …
A tab called query editor will open up on the right. You can write SQL statements and click the play button to execute. Your results will show below the editor on the Data Output tab.
For more documentation on pgAdmin click here
Connect an Existing Database
Note: We will be using Amazon RDS PostgreSQL as an example and if you need help setting one up, click here
Your database will need public access to connect with pgAdmin. Depending on your database configuration this example might not work.
Database Credentials Needed: Host Name, Port, Username, Password
Right-click Servers and click on Server…
Name your server with the same AWS database name, then click Connection
Fill in your Host name/address, Port, Username and Password. Click Save
NOTE: If you don’t want to put in your database password every time you open the server click the Save password? box
Now you should have your database connected with pgAdmin. Try using the query tool to view your data with SQL statements. 🙂
pgAdmin 4¶
Welcome to pgAdmin 4. pgAdmin is the leading Open Source management tool for Postgres, the world’s most advanced Open Source database. pgAdmin 4 is designed to meet the needs of both novice and experienced Postgres users alike, providing a powerful graphical interface that simplifies the creation, maintenance and use of database objects.
Postgres, PostgreSQL and the Slonik Logo are trademarks or registered trademarks of the PostgreSQL Community Association of Canada, and used with their permission.
Установка и настройка pgAdmin 4 в режиме сервера
pgAdmin — это платформа с открытым исходным кодом для администрирования и разработки для PostgreSQL и связанных с ней систем управления базами данных. Платформа написана на Python и jQuery и поддерживает все функции PostgreSQL. Вы можете использовать pgAdmin для любых операций, начиная с записи базовых SQL-запросов и заканчивая осуществлением мониторинга ваших баз данных и настройки продвинутых архитектур баз данных.
В этом руководстве мы обсудим процесс установки и настройки последней версии pgAdmin на сервере Ubuntu 18.04, получим доступ к pgAdmin через браузер и подключим платформу к базе данных PostgreSQL на вашем сервере.
Предварительные требования
Для данного курса обучения вам потребуется следующее:
- Сервер на Ubuntu 18.04. Этот сервер должен иметь пользователя без прав root с привилегиями sudo, а также брандмауэр с ufw . Ознакомьтесь с нашим руководством по первоначальной настройке сервера для Ubuntu 18.04 для получения дополнительных сведений.
- Веб-сервер Apache, установленный на вашем сервере. Для настройки веб-сервера воспользуйтесь нашим руководством по установке веб-сервера Apache на Ubuntu 18.04.
- PostgreSQL, установленная на сервере. Вы можете воспользоваться нашим руководством по установке и использованию PostgreSQL на Ubuntu 18.04 для выполнения установки. Перед выполнением инструкций данного руководства создайте новую роль и базу данных, потому что они потребуются вам при подключении pgAdmin к экземпляру PostgreSQL.
- Python 3 и venv , установленные на сервере. Следуйте указаниям руководства Установка Python 3 и настройка среды для разработки на сервере Ubuntu 18.04, чтобы установить эти инструменты и настроить виртуальную среду.
Шаг 1 — Установка pgAdmin и необходимых зависимостей
На момент написания самой последней версией pgAdmin является pgAdmin 4, хотя самая последняя версия, доступная в репозитории Ubuntu, — это pgAdmin 3. pgAdmin 3 уже не поддерживается, и сопровождающие проект специалисты рекомендуют устанавливать pgAdmin 4. В данном руководстве мы будем рассматривать процесс установки последней версии pgAdmin 4 в виртуальной среде (согласно рекомендациям команды разработки проекта) и установки ее зависимостей с помощью apt .
Для начала обновите индекс пакетов вашего сервера, если вы не делали этого последнее время.
Затем установите следующие зависимости. Список зависимостей включает libgmp3-dev , библиотеку арифметических операций с многократно увеличенной точностью; libpq-dev с файлами заголовков и статической библиотекой, которая помогает осуществлять коммуникации с бекэндом PostgreSQL; и libapache2-mod-wsgi-py3 , модуль Apache, который позволяет вам размещать внутри Apache веб-приложения на Python:
После этого создайте несколько директорий, где pgAdmin будет хранить данные сессий, данные хранилища и журналы:
Затем измените владельца этих директорий на вашего пользователя без прав root и группу. Это необходимо, потому что первоначально они принадлежат вашему root-пользователю, но мы будем устанавливать pgAdmin из виртуальной среды, принадлежащей вашему пользователю без прав root, а процесс установки подразумевает создание ряда файлов внутри этих директорий. После завершения установки мы изменим владельца на пользователя www-data и группу, чтобы директорию можно было использовать через сеть:
Затем откройте вашу виртуальную среду. Перейдите в директорию, в которой находится ваша среда программирования, и активируйте ее. Согласно соглашениям о наименованиях из обязательного руководства Python 3, мы перейдем в директорию environments и активируем среду my_env :
После этого необходимо загрузить исходный код pgAdmin 4 на ваш компьютер. Чтобы получить последнюю версию исходного кода, перейдите на страницу загрузки pgAdmin 4 (Python Wheel) и нажмите ссылку для последней версии (на момент написания это версия 3.4). После этого вы будете перенаправлены на страницу Downloads (Загрузки) на веб-сайте PostgreSQL На этой странице вам необходимо скопировать ссылку на файл, которая заканчивается на .whl , стандартный формат пакетов для дистрибутивов Python. Затем вернитесь в терминал и запустите следующую команду wget , заменив ссылку на ту, которую вы скопировали на сайте PostgreSQL, для загрузки файла .whl на ваш сервер:
Далее установите пакет wheel , базовую реализацию стандарта пакетов wheel. Будучи библиотекой Python, данный пакет служит расширением для сборки пакетов wheel и содержит инструмент для работы с командной строкой, который позволяет выполнять различные действия с файлами .whl :
Затем установите пакет pgAdmin 4 с помощью следующей команды:
Она отвечает за установку pgAdmin и его зависимостей. Прежде чем подключаться к вашей базе данных, необходимо внести несколько изменений в настройку программы.
Шаг 2 — Настройка pgAdmin 4
Хотя pgAdmin был установлен на сервере, осталось несколько шагов, которые нужно выполнить, чтобы гарантировать, что в наличии все разрешения и конфигурации, необходимые для правильной работы с веб-интерфейсом.
Основной файл конфигурации pgAdmin с именем config.py считывается перед любым другим файлом конфигурации. Его содержание можно использовать в качестве отправной точки для последующих настроек конфигурации, которые можно указать в других файлах конфигурации pgAdmin, но чтобы избежать непредвиденных ошибок, вы не должны редактировать файл config.py самостоятельно. Мы внесем некоторые изменения конфигурации в новый файл с именем config_local.py , который будет считываться непосредственно после основного файла.
Создайте этот файл сейчас, используя текстовый редактор. Мы будем использовать nano :
В вашем редакторе добавьте следующее содержание:
Вот что делают эти пять директив:
- LOG_FILE : данная директива определяет файл, в котором будут храниться журналы pgAdmin.
- SQLITE_PATH : pgAdmin хранит данные о пользователях в базе данных SQLite, и эта директива указывает программному обеспечению PgAdmin на базу данных конфигурации. Поскольку этот файл находится в постоянной директории /var/lib/pgadmin4 , ваши пользовательские данные после обновления не будут потеряны.
- SESSION_DB_PATH : указывает, какая директория будет использоваться для хранения данных сеанса.
- STORAGE_DIR : определяет, где pgAdmin будет хранить другие данные, например резервные копии и сертификаты безопасности.
- SERVER_MODE : установка значения True для этой директивы говорит о том, что pgAdmin должен запускаться в режиме сервера, а не в режиме настольного компьютера.
Обратите внимание, что каждый из этих путей файла указывает на директории, созданные на шаге 1.
После добавления этих строк сохраните и закройте файл (нажмите CTRL + X , а затем нажмите Y и ENTER ). После внесения этих изменений запустите скрипт установки pgAdmin, чтобы задать учетные данные для входа:
После запуска этой команды вы увидите запрос на ввод адреса электронной почты и пароля. Они будут служить вашими учетными данными для последующего доступа к pgAdmin, обязательно запомните их или запишите:
После этого необходимо деактивировать вашу виртуальную среду:
Воспользуйтесь путями файла, которые вы указали в файле config_local.py . Эти файлы хранятся в директориях, созданных на шаге 1, которые в настоящее время принадлежат вашему пользователю без прав root. Однако они должны быть доступны для пользователя и группы, которые запускают ваш веб-сервер. По умолчанию в Ubuntu 18.04 это пользователь и группа www-data, поэтому необходимо обновить разрешения для следующих директорий, чтобы предоставить www-data нужные права владения:
После этого настройку pgAdmin можно считать выполненной. Однако программа еще не обслуживается на вашем сервере, поэтому она остается недоступной. Для устранения данной проблемы мы настроим Apache для обслуживания pgAdmin, чтобы вы могли получить доступ к интерфейсу пользователя через браузер.
Шаг 3 — Настройка Apache
Веб-сервер Apache использует виртуальные хосты для инкапсуляции данных конфигурации и размещения сразу нескольких доменов на одном сервере. Если вы выполнили указания предварительного руководства для Apache, у вас уже может быть настроен пример виртуального хоста с именем your_domain.conf , но на этом шаге мы создадим новый хост, откуда мы сможем обслуживать веб-интерфейс pgAdmin.
Сначала убедитесь, что вы находитесь в директории root:
Затем создайте новый файл в вашей директории /sites-available/ с именем pgadmin4.conf . Это будет файл виртуального хоста вашего сервера:
Добавьте следующее содержимое в файл, заменив выделенные части в соответствии с вашей собственной конфигурацией:
Сохраните и закройте файл виртуального хоста. Затем воспользуйтесь скриптом a2dissite для отключения файла виртуального хоста по умолчанию, 000-default.conf :
Примечание: если вы выполнили требования предварительного руководства Apache, вы должны были отключить 000-default.conf и настроить пример файла конфигурации виртуального хоста (с именем your_domain.conf согласно требованиям). В этом случае вам нужно будет отключить файл виртуального хоста your_domain.conf с помощью следующей команды:
Затем воспользуйтесь скриптом a2ensite , чтобы активировать ваш файл виртуального хоста pgadmin4.conf . В результате будет создана символьная ссылка из файла виртуального хоста в директории /sites-available/ в директорию /sites-enabled/ :
После этого проверьте на правильность синтаксис вашего файла конфигурации:
Если файл конфигурации в порядке, вы увидите сообщение Syntax OK . Если вы увидите ошибку в результатах, снова откройте файл pgadmin4.conf и повторно проверьте, что ваш IP-адрес и пути файлов корректны, после чего запустите configtest .
После появления вывода Syntax OK перезапустите службу Apache, чтобы она смогла прочитать ваш новый файл виртуального хоста:
pgAdmin теперь полностью установлен и настроен. Теперь мы перейдем к тому, как организовать доступ к pgAdmin из браузера, прежде чем подключать его к базе данных PostgreSQL.
Шаг 4 — Доступ к pgAdmin
На вашем локальном компьютере откройте предпочитаемый браузер и откройте IP-адрес вашего сервера:
После этого вы увидите экран входа, аналогичный следующему экрану:
Введите учетные данные для входа, заданные на шаге 2, после чего вы попадете на приветственный экран pgAdmin:
Теперь, когда вы выполнили настройку, вы можете получить доступ к интерфейсу pgAdmin, и вам осталось только подключить pgAdmin к базе данных PostgreSQL. Прежде чем сделать это, вам нужно будет внести одно небольшое изменение в конфигурацию суперпользователя PostgreSQL.
Шаг 5 — Настройка вашего пользователя PostgreSQL
Если вы выполнили указания предварительного руководства PostgreSQL, вы уже должны были установить PostgreSQL на ваш сервер с правами суперпользователя и настроенной базой данных.
По умолчанию в PostgreSQL вы выполняете аутентификацию пользователей базы данных с помощью “протокола идентификации” (или ident), т. е. метода аутентификации. В рамках этого процесса PostgreSQL берет имя пользователя клиента Ubuntu и использует его в качестве разрешенного пользователя базы данных. Это позволяет обеспечить более высокий уровень безопасности во многих случаях, но также может стать причиной проблем в случаях, когда вам может потребоваться подключить внешнюю программу, например, pgAdmin, к вашей базе данных. Для устранения этой проблемы мы зададим пароль для данной роли PostgreSQL, который позволит pgAdmin подключиться к вашей базе данных.
В вашем терминале откройте командную строку PostgreSQL с помощью вашего суперпользователя:
Из командной строки PostgreSQL обновите профиль пользователя, чтобы задать более надежный пароль:
Закройте командную строку PostgreSQL:
Теперь вернитесь в интерфейс pgAdmin 4 в вашем браузере и найдите меню Browser (Браузер) с левой стороны. Нажмите правой кнопкой мыши на пункт Servers (Серверы), чтобы открыть контекстное меню, наведите курсор мыши на пункт Create (Создать) и нажмите Server… (Сервер…).
В результате в браузере появится окно, в котором вы должны ввести информацию о вашем сервере, роли и базе данных.
На вкладке General (Общее) введите имя этого сервера. Это может быть любое имя по вашему желанию, но вы можете использовать описательное имя. В нашем примере сервер называется Sammy-server-1 .
Затем нажмите на вкладку Connection (Подключение). В поле Host name/address (Имя хоста/адрес) введите localhost . В поле Port (Порт) необходимо задать значение 5432 по умолчанию, которое будет работать для этой настройки, поскольку это порт, используемый для PostgreSQL по умолчанию.
В поле Maintenance database (Поддержание базы данных) введите имя базы данных, к которой вы хотите подключиться. Обратите внимание, что эта база данных должна быть уже создана на вашем сервере. Затем введите имя пользователя и пароль PostgreSQL, которые вы настроили ранее в полях Username (Имя пользователя) и Password (Пароль).
Пустые поля в других вкладках являются опциональными, их необходимо заполнять, если у вас есть конкретные требования для установки, где они могут потребоваться. Нажмите кнопку Save (Сохранить), после чего база данных появится в списке Servers (Серверы) в меню Browser (Браузер).
Вы успешно подключили pgAdmin4 к базе данных PostgreSQL. С помощью панели управления pgAdmin вы можете делать все, что вы можете делать с помощью командной строки PostgreSQL. Для иллюстрации этого факты мы создадим пример таблицы и заполним ее с помощью примера данных через веб-интерфейс.
Шаг 6 — Создание таблицы в панели pgAdmin
В панели управления pgAdmin найдите меню Browser (Браузер) с левой стороны окна. Нажмите на значок плюс (+) рядом с пунктом Servers (Серверы), чтобы развернуть дерево меню внутри. Далее нажмите значок плюс слева от сервера, добавленного на предыдущем шаге (Sammy-server-1 в нашем примере), затем разверните пункт Databases (Базы данных), имя базы данных, добавленной вами (sammy в нашем примере), а затем Schemas (1) (Схемы (1)). Вы должны увидеть следующее дерево меню:
Нажмите правой кнопкой на пункт списка Tables (Таблицы), затем наведите курсор на пункт Create (Создать) и нажмите Table…(Таблица…).
В результате будет открыто окно Create-Table (Создать — Таблица). На вкладке General (Общее) этого окна введите имя таблицы. Это может быть любое имя, но чтобы не усложнять, мы назовем ее table-01.
Перейдите на вкладку Columns (Столбцы) и нажмите знак + в правом верхнем углу окна, чтобы добавить столбцы. При добавлении столбца вам нужно указать его Name (Имя) и Data type (Тип данных), после чего вам может потребоваться указать параметр Length (Длина), если это требуется для типа данных, который вы выбрали.
Кроме того, в официальной документации PostgreSQL указано, что добавление главного ключа в таблицу является рекомендованной практикой. Главный ключ — это препятствие, указывающее конкретный столбец или набор столбцов, которые можно использовать в качестве специального идентификатора для строк в таблице. Это не обязательное требование, но если вы хотите задать один или несколько столбцов в качестве главного ключа, переведите переключатель с правого края из положения No (Нет) в положение Yes (Да).
Нажмите кнопку Save (Сохранить) для создания таблицы.
К этому моменту вы создали таблицу и добавили несколько столбцов. Однако столбцы не содержат данных. Для добавления данных в вашу новую таблицу нажмите правой кнопкой мыши на имя таблицы в меню Browser (Браузер), наведите курсор на пункт Scripts (Скрипты) и нажмите INSERT Script (ВСТАВИТЬ скрипт).
В результате будет открыта новая панель на панели управления. В самом верху вы увидите частично выполненная конструкция INSERT (ВСТАВКА) с соответствующими названиями таблицы и столбцов. Теперь необходимо заменить знаки вопроса (?) на любые данные, убедившись, что данные, которые вы добавляете, соответствуют типам данных, которые вы выбрали для каждого столбца. Обратите внимание, что вы можете добавить несколько строк данных, помещая каждую строку внутри набора скобок и разделяя скобки запятыми, как показано в следующем примере.
При желании вы можете заменить частично выполненный скрипт INSERT на следующий пример конструкции INSERT :
Нажмите значок молнии (⚡) для запуска выполнения конструкции INSERT . Чтобы просмотреть таблицу и все данные внутри ее, снова нажмите правой кнопкой мыши на имени таблицы в меню Browser (Браузер), наведите курсор на View/Edit Data (Просмотр/редактирование данных) и выберите All Rows (Все ряды).
В результате будет открыта новая панель, ниже которой, на вкладке Data Output (Вывод данных) нижней панели вы можете просмотреть все данные, хранящиеся в таблице.
Поздравляем, вы успешно создали таблицу и заполнили ее данными с помощью веб-интерфейса pgAdmin. Разумеется, это только один из методов, которые вы можете использовать для создания таблицы с помощью pgAdmin. Например, вы можете также создать и заполнить таблицу с помощью SQL вместо метода, подразумевающего использование графического интерфейса, описанного на этом шаге.
Заключение
В этом руководстве вы научились устанавливать pgAdmin 4 из виртуальной среды Python, настраивать эту платформу, выполнять подключение к веб-серверу Apache и узнали, как подключить ее к базе данных PostgreSQL. Кроме того, в этом руководстве описан один метод, который можно использовать для создания и заполнения таблицы, но pgAdmin можно использовать далеко не только для создания и редактирования таблиц.
Дополнительную информацию о том, как получить максимум от всех функций pgAdmin см. в документации проекта. Также вы можете узнать больше о PostgreSQL, ознакомившись с руководствами сообщества по этой теме.
Thanks for learning with the DigitalOcean Community. Check out our offerings for compute, storage, networking, and managed databases.
Getting Started¶
Pre-compiled and configured installation packages for pgAdmin 4 are available for a number of desktop environments; we recommend using an installer whenever possible.
In a Server Deployment, the pgAdmin application is deployed behind a webserver or with the WSGI interface. If you install pgAdmin in server mode, you will be prompted to provide a role name and pgAdmin password when you initially connect to pgAdmin. The first role registered with pgAdmin will be an administrative user; the administrative role can use the pgAdmin User Management dialog to create and manage additional pgAdmin user accounts. When a user authenticates with pgAdmin, the pgAdmin tree control displays the server definitions associated with that login role.
In a Desktop Deployment, the pgAdmin application is configured to use the desktop runtime environment to host the program on a supported platform. Typically, users will install a pre-built package to run pgAdmin in desktop mode, but a manual desktop deployment can be installed and though it is more difficult to setup, it may be useful for developers interested in understanding how pgAdmin works.
It is also possible to use a Container Deployment of pgAdmin, in which Server Mode is pre-configured for security.
Pre-compiled and configured installation packages are available for a number of platforms. These packages should be used by end-users whereever possible — the following information is useful for the maintainers of those packages and users interested in understanding how pgAdmin works.
The pgAdmin 4 client features a highly-customizable display that features drag-and-drop panels that you can arrange to make the best use of your desktop environment.
The tree control provides an elegant overview of the managed servers, and the objects that reside on each server. Right-click on a node within the tree control to access context-sensitive menus that provide quick access to management tasks for the selected object.
The tabbed browser provide quick access to statistical information about each object in the tree control, and pgAdmin tools and utilities (such as the Query tool and the debugger). pgAdmin opens additional feature tabs each time you access the extended functionality offered by pgAdmin tools; you can open, close, and re-arrange feature tabs as needed.
Use the Preferences dialog to customize the content and behaviour of the pgAdmin display. To open the Preferences dialog, select Preferences from the File menu.
Help buttons in the lower-left corner of each dialog will open the online help for the dialog. You can access additional Postgres help by navigating through the Help menu, and selecting the name of the resource that you wish to open.
You can search for objects in the database using the Search objects
Before using pgAdmin to manage objects that reside on a server, you must define a connection to the server; for more information please see Connecting to a Server in the next section.