Примеры кода для подключения к кластеру PostgreSQL
Примеры проверялись в следующем окружении:
- Виртуальная машина в Yandex Cloud с Ubuntu 20.04 LTS:
- Bash:
5.0.16. - Python:
3.8.2; pip3:20.0.2. - PHP:
7.4.3. - OpenJDK:
11.0.8; Maven:3.6.3. - Node.JS:
10.19.0, npm:6.14.4. - Go:
1.13.8. - Ruby:
2.7.0p0. - unixODBC:
2.3.6.
- Bash:
- Виртуальная машина в Yandex Cloud с Windows Server 2019 Datacenter:
- PostgreSQL:
13. - PowerShell:
5.1.17763.1490 Desktop. - .NET 5
- Microsoft.EntityFrameworkCore 5.0.9
- Npgsql.EntityFrameworkCore.PostgreSQL 5.0.7
- PostgreSQL:
Подключиться к хостам PostgreSQL в публичном доступе можно только с использованием SSL-сертификата. Перед подключением к таким хостам подготовьте сертификат.
В примерах ниже предполагается, что SSL-сертификат root.crt расположен в директории:
/home/<домашняя_директория>/.postgresql/для Ubuntu;$HOME\AppData\Roaming\postgresqlдля Windows.
Подключение без использования SSL-сертификата поддерживается только для хостов, находящихся не в публичном доступе. В этом случае трафик внутри облачной сети при подключении к БД шифроваться не будет.
Подключиться к кластеру возможно как с использованием обычных FQDN хостов (можно передавать список из нескольких таких FQDN, разделенных запятой), так и особых FQDN. В примерах используется особый FQDN текущего хоста-мастера.
Примеры кода с заполненным FQDN хоста доступны в консоли управления
1C:Предприятие
Если кластер использует версию PostgreSQL, оптимизированную для работы с системой 1С:Предприятие
, укажите в настройках:
- Защищенное соединение — отключено.
- Тип СУБД —
PostgreSQL. - Сервер баз данных —
с-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432. - Имя базы данных —
<имя_БД>. - Пользователь базы данных —
<имя_пользователя>. - Пароль пользователя —
<пароль>. - Создать базу данных в случае ее отсутствия — отключено.
C++ (фреймворк userver)
Асинхронный фреймворк userver
Перед подключением получите доступ к фреймворку одним из способов:
- Создайте виртуальную машину Yandex Compute Cloud из образа userver. Этот образ уже содержит фреймворк и все необходимые зависимости.
- Вручную установите фреймворк и все необходимые зависимости
.
-
Создайте проект на основе шаблона для сервиса
. -
Измените конфигурационный файл
configs/config_vars.yaml. В качестве значения переменнойdbconnectionукажите строку подключения к кластеру PostgreSQL:postgres://<имя_пользователя>:<пароль_пользователя>@c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД> -
Соберите проект и запустите сервис:
make build-debug && \ ./build_debug/pg_service_template -c configs/static_config.yaml --config_vars configs/config_vars.yaml
-
Создайте проект на основе шаблона для сервиса
. -
Измените конфигурационный файл
configs/config_vars.yaml. В качестве значения переменнойdbconnectionукажите строку подключения к кластеру PostgreSQL:postgres://<имя_пользователя>:<пароль_пользователя>@c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД>?ssl=true&sslmode=verify-full -
Соберите проект и запустите сервис:
make build-debug && \ ./build_debug/pg_service_template -c configs/static_config.yaml --config_vars configs/config_vars.yaml
После запуска сервис будет ожидать поступления POST-запроса от пользователя. В ходе ожидания запроса сервис будет периодически проверять доступность кластера PostgreSQL, выполняя запрос SELECT 1 as ping. Информация об этом содержится в логах работы сервиса.
Пример содержимого логов при успешном подключении к кластеру
tskv ... level=INFO module=MakeQuerySpan ( userver/postgresql/src/storages/postgres/detail/connection_impl.cpp:647 )
...
db_statement=SELECT 1 AS ping
db_type=postgres
db_instance=********
peer_address=c-********.rw.mdb.yandexcloud.kz:6432
...
C# EF Core
Для подключения к кластеру необходим пакет Npgsql
using Npgsql;
namespace ConsoleApp
{
class Program
{
static async Task Main(string[] args)
{
var host = "c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz";
var port = "6432";
var db = "<имя_БД>";
var username = "<имя_пользователя>";
var password = "<пароль_пользователя>";
var connString = $"Host={host};Port={port};Database={db};Username={username};Password={password};Ssl Mode=VerifyFull;";
await using var conn = new NpgsqlConnection(connString);
await conn.OpenAsync();
await using (var cmd = new NpgsqlCommand("SELECT VERSION();", conn))
await using (var reader = await cmd.ExecuteReaderAsync())
{
while (await reader.ReadAsync())
{
Console.WriteLine(reader.GetInt32(0));
}
}
}
}
}
Go
Перед подключением установите зависимости:
sudo apt update && sudo apt install --yes golang git && \
go mod init example && go get github.com/jackc/pgx/v4
-
Пример кода:
connect.gopackage main import ( "context" "fmt" "os" "github.com/jackc/pgx/v4" ) const ( host = "c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz" port = 6432 user = "<имя_пользователя>" password = "<пароль_пользователя>" dbname = "<имя_БД>" ) func main() { connstring := fmt.Sprintf( "host=%s port=%d dbname=%s user=%s password=%s target_session_attrs=read-write", host, port, dbname, user, password) connConfig, err := pgx.ParseConfig(connstring) if err != nil { fmt.Fprintf(os.Stderr, "Unable to parse config: %v\n", err) os.Exit(1) } conn, err := pgx.ConnectConfig(context.Background(), connConfig) if err != nil { fmt.Fprintf(os.Stderr, "Unable to connect to database: %v\n", err) os.Exit(1) } defer conn.Close(context.Background()) var version string err = conn.QueryRow(context.Background(), "select version()").Scan(&version) if err != nil { fmt.Fprintf(os.Stderr, "QueryRow failed: %v\n", err) os.Exit(1) } fmt.Println(version) } -
Подключение:
go run connect.go
-
Пример кода:
connect.gopackage main import ( "context" "crypto/tls" "crypto/x509" "fmt" "io/ioutil" "os" "github.com/jackc/pgx/v4" ) const ( host = "c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz" port = 6432 user = "<имя_пользователя>" password = "<пароль_пользователя>" dbname = "<имя_БД>" ca = "/home/<домашняя_директория>/.postgresql/root.crt" ) func main() { rootCertPool := x509.NewCertPool() pem, err := ioutil.ReadFile(ca) if err != nil { panic(err) } if ok := rootCertPool.AppendCertsFromPEM(pem); !ok { panic("Failed to append PEM.") } connstring := fmt.Sprintf( "host=%s port=%d dbname=%s user=%s password=%s sslmode=verify-full target_session_attrs=read-write", host, port, dbname, user, password) connConfig, err := pgx.ParseConfig(connstring) if err != nil { fmt.Fprintf(os.Stderr, "Unable to parse config: %v\n", err) os.Exit(1) } connConfig.TLSConfig = &tls.Config{ RootCAs: rootCertPool, ServerName: "c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz", } conn, err := pgx.ConnectConfig(context.Background(), connConfig) if err != nil { fmt.Fprintf(os.Stderr, "Unable to connect to database: %v\n", err) os.Exit(1) } defer conn.Close(context.Background()) var version string err = conn.QueryRow(context.Background(), "select version()").Scan(&version) if err != nil { fmt.Fprintf(os.Stderr, "QueryRow failed: %v\n", err) os.Exit(1) } fmt.Println(version) }При этом способе подключения в коде необходимо указывать полный путь к сертификату
root.crtдля PostgreSQL в переменнойca. -
Подключение:
go run connect.go
Java
Перед подключением:
-
Установите зависимости:
sudo apt update && sudo apt install --yes default-jdk maven -
Создайте директорию для проекта Maven:
cd ~/ && mkdir -p project/src/java/com/example && cd project/ -
Создайте конфигурационный файл для Maven:
pom.xml
<?xml version="1.0" encoding="utf-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>com.example</groupId> <artifactId>app</artifactId> <packaging>jar</packaging> <version>0.1.0</version> <properties> <maven.compiler.source>1.8</maven.compiler.source> <maven.compiler.target>1.8</maven.compiler.target> </properties> <dependencies> <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> <version>42.2.16</version> </dependency> </dependencies> <build> <finalName>${project.artifactId}-${project.version}</finalName> <sourceDirectory>src</sourceDirectory> <resources> <resource> <directory>src</directory> </resource> </resources> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-assembly-plugin</artifactId> <executions> <execution> <goals> <goal>attached</goal> </goals> <phase>package</phase> <configuration> <descriptorRefs> <descriptorRef> jar-with-dependencies</descriptorRef> </descriptorRefs> <archive> <manifest> <mainClass>com.example.App</mainClass> </manifest> </archive> </configuration> </execution> </executions> </plugin> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-jar-plugin</artifactId> <version>3.1.0</version> <configuration> <archive> <manifest> <mainClass>com.example.App</mainClass> </manifest> </archive> </configuration> </plugin> </plugins> </build> </project>Актуальная версия зависимости для Maven: postgresql
.
-
Пример кода:
src/java/com/example/App.javapackage com.example; import java.sql.*; public class App { public static void main(String[] args) { String DB_URL = "jdbc:postgresql://c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД>?targetServerType=master&ssl=false&sslmode=disable"; String DB_USER = "<имя_пользователя>"; String DB_PASS = "<пароль_пользователя>"; try { Class.forName("org.postgresql.Driver"); Connection conn = DriverManager.getConnection(DB_URL, DB_USER, DB_PASS); ResultSet q = conn.createStatement().executeQuery("SELECT version()"); if(q.next()) {System.out.println(q.getString(1));} conn.close(); } catch(Exception ex) {ex.printStackTrace();} } } -
Сборка и подключение:
mvn clean package && \ java -jar target/app-0.1.0-jar-with-dependencies.jar
-
Пример кода:
src/java/com/example/App.javapackage com.example; import java.sql.*; public class App { public static void main(String[] args) { String DB_URL = "jdbc:postgresql://c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД>?targetServerType=master&ssl=true&sslmode=verify-full"; String DB_USER = "<имя_пользователя>"; String DB_PASS = "<пароль_пользователя>"; try { Class.forName("org.postgresql.Driver"); Connection conn = DriverManager.getConnection(DB_URL, DB_USER, DB_PASS); ResultSet q = conn.createStatement().executeQuery("SELECT version()"); if(q.next()) {System.out.println(q.getString(1));} conn.close(); } catch(Exception ex) {ex.printStackTrace();} } } -
Сборка и подключение:
mvn clean package && \ java -jar target/app-0.1.0-jar-with-dependencies.jar
Node.js
Перед подключением установите зависимости:
sudo apt update && sudo apt install --yes nodejs npm && \
npm install pg
app.js
"use strict";
const pg = require("pg");
const config = {
connectionString:
"postgres://<имя_пользователя>:<пароль_пользователя>@c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД>"
};
const conn = new pg.Client(config);
conn.connect((err) => {
if (err) throw err;
});
conn.query("SELECT version()", (err, q) => {
if (err) throw err;
console.log(q.rows[0]);
conn.end();
});
app.js
"use strict";
const fs = require("fs");
const pg = require("pg");
const config = {
connectionString:
"postgres://<имя_пользователя>:<пароль_пользователя>@c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz:6432/<имя_БД>",
ssl: {
rejectUnauthorized: true,
ca: fs
.readFileSync("/home/<домашняя_директория>/.postgresql/root.crt")
.toString(),
},
};
const conn = new pg.Client(config);
conn.connect((err) => {
if (err) throw err;
});
conn.query("SELECT version()", (err, q) => {
if (err) throw err;
console.log(q.rows[0]);
conn.end();
});
При этом способе подключения в коде необходимо указывать полный путь к сертификату root.crt для PostgreSQL в переменной ca.
Идентификатор кластера можно получить со списком кластеров.
Подключение:
node app.js
ODBC
Перед подключением установите зависимости:
sudo apt update && sudo apt install --yes unixodbc odbc-postgresql
Драйвер PostgreSQL ODBC будет автоматически зарегистрирован в файле /etc/odbcinst.ini.
-
Пример кода:
/etc/odbc.ini[postgresql] Driver=PostgreSQL Unicode Servername=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz Username=<имя_пользователя> Password=<пароль_пользователя> Database=<имя_БД> Port=6432 Pqopt=target_session_attrs=read-write -
Подключение:
isql -v postgresqlПосле подключения к СУБД выполните команду
SELECT version();.
-
Пример кода:
/etc/odbc.ini[postgresql] Driver=PostgreSQL Unicode Servername=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz Username=<имя_пользователя> Password=<пароль_пользователя> Database=<имя_БД> Port=6432 Pqopt=target_session_attrs=read-write Sslmode=verify-full -
Подключение:
isql -v postgresqlПосле подключения к СУБД выполните команду
SELECT version();.
PHP
Перед подключением установите зависимости:
sudo apt update && sudo apt install --yes php php-pgsql
-
Пример кода:
connect.php<?php $conn = pg_connect(" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 sslmode=disable dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write "); $q = pg_query($conn, "SELECT version()"); $result = pg_fetch_row($q); echo $result[0]; pg_close($conn); ?> -
Подключение:
php connect.php
-
Пример кода:
connect.php<?php $conn = pg_connect(" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 sslmode=verify-full dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write "); $q = pg_query($conn, "SELECT version()"); $result = pg_fetch_row($q); echo $result[0]; pg_close($conn); ?> -
Подключение:
php connect.php
Python
Перед подключением установите зависимости:
sudo apt update && sudo apt install -y python3 python3-pip && \
pip3 install psycopg2-binary
-
Пример кода:
connect.pyimport psycopg2 conn = psycopg2.connect(""" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 sslmode=disable dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write """) q = conn.cursor() q.execute('SELECT version()') print(q.fetchone()) conn.close() -
Подключение:
python3 connect.py
-
Пример кода:
connect.pyimport psycopg2 conn = psycopg2.connect(""" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 sslmode=verify-full dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write """) q = conn.cursor() q.execute('SELECT version()') print(q.fetchone()) conn.close() -
Подключение:
python3 connect.py
R
Перед подключением:
-
Установите зависимости:
sudo apt update && sudo apt install libpq-dev r-base --yes -
Установите библиотеку RPostgres
:sudo R --interactive install.packages("RPostgres") quit()
-
Пример кода:
connect.rlibrary(DBI) conn <- dbConnect(RPostgres::Postgres(), dbname="<имя_БД>", host="c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz", port=6432, user="<имя_пользователя>", password="<пароль_пользователя>" ) res <- dbSendQuery(conn, "SELECT VERSION();") dbFetch(res) dbClearResult(res) dbDisconnect(conn) -
Подключение:
R connect.r
-
Пример кода:
connect.rlibrary(DBI) conn <- dbConnect(RPostgres::Postgres(), dbname="<имя_БД>", host="c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz", port=6432, sslmode="verify-full", user="<имя_пользователя>", password="<пароль_пользователя>" ) res <- dbSendQuery(conn, "SELECT VERSION();") dbFetch(res) dbClearResult(res) dbDisconnect(conn) -
Подключение:
R connect.r
Ruby
Перед подключением установите зависимости:
sudo apt update && sudo apt install --yes ruby ruby-pg
-
Пример кода:
connect.rbrequire "pg" conn = PG.connect(" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write sslmode=disable ") q = conn.exec("SELECT version()") puts q.getvalue 0, 0 conn.close() -
Подключение:
ruby connect.rb
-
Пример кода:
connect.rbrequire "pg" conn = PG.connect(" host=c-<идентификатор_кластера>.rw.mdb.yandexcloud.kz port=6432 dbname=<имя_БД> user=<имя_пользователя> password=<пароль_пользователя> target_session_attrs=read-write sslmode=verify-full ") q = conn.exec("SELECT version()") puts q.getvalue 0, 0 conn.close() -
Подключение:
ruby connect.rb
При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия PostgreSQL. Исключение — пример для фреймворка userver, в котором будет выполняться тестовый запрос SELECT 1 as ping для периодической проверки доступности кластера PostgreSQL.