Подключение к базе данных в кластере MySQL®

К хостам кластера Managed Service for MySQL® можно подключиться:

• Через интернет, если вы настроили публичный доступ для нужного хоста. К таким хостам подключиться можно только используя SSL-соединение.

• С виртуальных машин Yandex Cloud, расположенных в той же облачной сети. Если к хосту нет публичного доступа, для подключения с таких виртуальных машин необязательно использовать SSL-соединение.

Максимальное количество подключений определяется настройкой Max connections, которая зависит от класса хостов.

Подробнее см. в разделе Сеть и кластеры в Managed Service for MySQL®.

Настройка групп безопасностиНастройка групп безопасности

Для подключения к кластеру необходимо, чтобы группы безопасности содержали правила, которые разрешают трафик с определенных портов, IP-адресов или из других групп безопасности.

Настройки правил будут различаться в зависимости от выбранного способа подключения:

Подробнее о группах безопасности см. в разделе Группы безопасности.

Получение SSL-сертификатаПолучение SSL-сертификата

MySQL®-хосты с публичным доступом поддерживают только шифрованные соединения. Чтобы использовать их, получите SSL-сертификат:

mkdir -p ~/.mysql && \
wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
     --output-document ~/.mysql/root.crt && \
chmod 0600 ~/.mysql/root.crt

mkdir $HOME\.mysql; curl.exe -o $HOME\.mysql\root.crt https://storage.yandexcloud.net/cloud-certs/CA.pem

Для использования графических IDE сохраните сертификат в локальную папку и укажите путь к нему в настройках подключения.

FQDN хостов MySQL®FQDN хостов MySQL®

Для подключения к хосту потребуется его FQDN — доменное имя. Вы можете использовать FQDN конкретного хоста в кластере или один из особых FQDN, всегда указывающий на текущий хост-мастер или наименее отстающую реплику.

Пример FQDN хоста:

rc1a-goh2a9tr********.mdb.yandexcloud.net

Получить FQDN хостаПолучить FQDN хоста

FQDN хоста MySQL® можно получить несколькими способами:

• Посмотрите FQDN в консоли управления:

  1. Перейдите на страницу кластера.
  2. Перейдите в раздел Хосты.
  3. Скопируйте значение в столбце FQDN хоста.

• Скопируйте команду для подключения к кластеру в консоли управления. Команда содержит заполненный FQDN хоста. Чтобы получить команду, перейдите на страницу кластера и нажмите кнопку Подключиться.

• Запросите список хостов в кластере с помощью CLI или API.

Особые FQDNОсобые FQDN

Наравне с обычными FQDN, Managed Service for MySQL® предоставляет несколько особых FQDN, которые также можно использовать при подключении к кластеру.

В кластерах из нескольких хостов особые FQDN могут некоторое время (до 10 минут) указывать на старый хост, даже если он сменил роль (например, из мастера стал репликой). Если используется особый FQDN, который указывает на текущий мастер, то часть запросов на запись может завершиться неудачей — они могут быть направлены к реплике. Это связано с тем, что на обновление DNS-записей для особых FQDN требуется время. Если запрос на запись завершился ошибкой, повторите его позднее.

Текущий мастерТекущий мастер

FQDN вида c-<идентификатор_кластера>.rw.mdb.yandexcloud.net всегда указывает на текущий хост-мастер в кластере. Идентификатор кластера можно получить со списком кластеров в каталоге.

При подключении к этому FQDN разрешено выполнять операции чтения и записи.

Наименее отстающая репликаНаименее отстающая реплика

FQDN вида c-<идентификатор_кластера>.ro.mdb.yandexcloud.net указывает на наименее отстающую от мастера реплику. Идентификатор кластера можно запросить со списком кластеров в каталоге.

Особенности:

• При подключении к этому FQDN разрешено выполнять только операции чтения.
• Если в кластере нет активных реплик, то подключиться к этому FQDN невозможно: соответствующая CNAME-запись в DNS будет указывать на пустой объект (null).

Подключение из графических IDEПодключение из графических IDE

Подключения проверялись в следующем окружении:

• Ubuntu 20.04, DBeaver: 22.2.4;
• MacOS Monterey 12.7:
  • JetBrains DataGrip: 2023.3.4;
  • DBeaver Community: 24.0.0.

Подключаться из графических IDE можно только к хостам кластера в публичном доступе с использованием SSL-сертификата.

Чтобы избежать ошибок при подключении, сохраните сертификат в локальную папку, для доступа к которой не требуются права администратора.

Подключение из Yandex WebSQLПодключение из Yandex WebSQL

Вы можете отправлять SQL-запросы к базам данных в кластере Managed Service for MySQL® с помощью сервиса Yandex WebSQL.

WebSQL — это сервис Yandex Cloud, который позволяет подключаться к кластерам управляемых баз данных, работать с БД, таблицами и схемами и выполнять запросы. Сервис работает в браузере, не требует дополнительной авторизации и предлагает удобные подсказки для работы с SQL-командами.

Чтобы подключаться из WebSQL к кластеру Managed Service for MySQL®, необходимо создать подключение:

1. Перейдите на страницу каталога и выберите сервис Managed Service for MySQL.
2. Нажмите на имя нужного кластера.
3. Включите опцию Доступ из WebSQL в настройках кластера, если она еще не включена.
4. Выберите вкладку WebSQL.
5. Нажмите кнопку Создать подключение и укажите параметры подключения:
   • Имя подключения.
   • Тип базы данных — MySQL®.
   • Кластер — будет автоматически выбран текущий кластер MySQL®.
   • Имя пользователя, от лица которого вы будете подключаться к базе данных в кластере.
   • Пароль пользователя.
   • Базы данных, к которым вы хотите подключиться. Вы можете подключиться только к существующим в этом кластере БД. У пользователя, которого вы указали, должен быть настроен доступ к ним.
6. Нажмите кнопку Создать.

Чтобы открыть SQL-редактор, нажмите на созданное подключение на вкладке WebSQL.

Подробнее о работе с WebSQL см. в документации сервиса.

Подготовка к подключению из Docker-контейнераПодготовка к подключению из Docker-контейнера

Чтобы подключаться к кластеру Managed Service for MySQL® из Docker-контейнера, добавьте в Dockerfile строки:

RUN apt-get update && \
    apt-get install mysql-client --yes

RUN apt-get update && \
    apt-get install wget mysql-client --yes && \
    mkdir --parents ~/.mysql && \
    wget "https://storage.yandexcloud.net/cloud-certs/CA.pem" \
         --output-document ~/.mysql/root.crt && \
    chmod 0600 ~/.mysql/root.crt

Примеры строк подключенияПримеры строк подключения

Примеры для Linux проверялись в следующем окружении:

• Виртуальная машина в 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.

Примеры для Windows проверялись в следующем окружении:

• Локальная машина с Windows 10 Pro build 19042.1052.
• PowerShell: 5.1.19041.
• cURL: 7.55.1 WinSSL.

Подключиться к MySQL®-хостам в публичном доступе можно только с использованием SSL-сертификата.

BashBash

Перед подключением установите утилиту mysql:

sudo apt update && sudo apt install --yes mysql-client

mysql --host=<имя_хоста_MySQL®>.mdb.yandexcloud.net \
      --port=3306 \
      --ssl-ca=~/.mysql/root.crt \
      --ssl-mode=VERIFY_IDENTITY \
      --user=<имя_пользователя> \
      --password \
      <имя_БД>

mysql --host=<FQDN_любого_хоста_MySQL®> \
      --port=3306 \
      --ssl-mode=DISABLED \
      --user=<имя_пользователя> \
      --password \
      <имя_БД>

О том, как получить FQDN хоста, см. инструкцию.

При выполнении любой из команд введите пароль пользователя БД.

После подключения к СУБД выполните команду SELECT version();.

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

GoGo

Перед подключением установите зависимости:

sudo apt update && sudo apt install --yes golang git && \
go get github.com/go-sql-driver/mysql

package main

import (
  "io/ioutil"
  "crypto/tls"
  "crypto/x509"
  "database/sql"
  "fmt"
  "github.com/go-sql-driver/mysql"
)

const (
  host     = "<FQDN_любого_хоста_MySQL®>"
  port     = 3306
  user     = "<имя_пользователя>"
  password = "<пароль_пользователя>"
  dbname   = "<имя_БД>"
)

func main() {
  rootCertPool := x509.NewCertPool()
  pem, err := ioutil.ReadFile("/home/<домашняя_директория>/.mysql/root.crt")
  if err != nil {
    panic(err)
  }
  if ok := rootCertPool.AppendCertsFromPEM(pem); !ok {
    panic("Failed to append PEM.")
  }

  mysql.RegisterTLSConfig("custom", &tls.Config{
    RootCAs: rootCertPool,
  })

  mysqlInfo := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s?tls=custom",
    user, password, host, port, dbname)
  conn, err := sql.Open("mysql", mysqlInfo)
  if err != nil {
    panic(err)
  }

  defer conn.Close()

  q, err := conn.Query("SELECT version()")
  if err != nil {
    panic(err)
  }

  var result string

  for q.Next() {
   q.Scan(&result)
   fmt.Println(result)
  }
}

package main

import (
  "database/sql"
  "fmt"
  _ "github.com/go-sql-driver/mysql"
)

const (
  host     = "<FQDN_любого_хоста_MySQL®>"
  port     = 3306
  user     = "<имя_пользователя>"
  password = "<пароль_пользователя>"
  dbname   = "<имя_БД>"
)

func main() {
  mysqlInfo := fmt.Sprintf("%s:%s@tcp(%s:%d)/%s",
    user, password, host, port, dbname)
  conn, err := sql.Open("mysql", mysqlInfo)
  if err != nil {
    panic(err)
  }

  defer conn.Close()

  q, err := conn.Query("SELECT version()")
  if err != nil {
    panic(err)
  }

  var result string

  for q.Next() {
   q.Scan(&result)
   fmt.Println(result)
  }
}

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

go run connect.go

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

JavaJava

Перед подключением:

1. Установите зависимости:

   sudo apt update && sudo apt install --yes default-jdk maven
   

2. Добавьте SSL-сертификат в хранилище доверенных сертификатов Java (Java Key Store), чтобы драйвер MySQL® мог использовать этот сертификат при защищенном подключении к хостам кластера. При этом задайте пароль в параметре -storepass для защиты хранилища:

   cd ~/.mysql && \
   sudo keytool -importcert \
                -alias YandexCA \
                -file root.crt \
                -keystore YATrustStore \
                -storepass <пароль_хранилища_сертификатов> \
                --noprompt
   

   Где storepass — пароль хранилища сертификатов, не короче 6 символов.

3. Создайте директорию для проекта Maven:

   cd ~/ && mkdir -p project/src/java/com/example && cd project/
   

4. Создайте конфигурационный файл для 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>mysql</groupId>
               <artifactId>mysql-connector-java</artifactId>
               <version>8.0.21</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>
   

   Актуальную версию mysql-connector-java уточняйте на странице проекта в репозитории Maven.

package com.example;

import java.sql.*;

public class App {
  public static void main(String[] args) {
    String DB_URL     = "jdbc:mysql://<FQDN_любого_хоста_MySQL®>:3306/<имя_БД>?useSSL=true";
    String DB_USER    = "<имя_пользователя>";
    String DB_PASS    = "<пароль_пользователя>";

    System.setProperty("javax.net.ssl.trustStore", "/home/<домашняя_директория>/.mysql/YATrustStore");
    System.setProperty("javax.net.ssl.trustStorePassword", "<пароль_хранилища_сертификатов>");

    try {
      Class.forName("com.mysql.cj.jdbc.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();}
  }
}

package com.example;

import java.sql.*;

public class App {
  public static void main(String[] args) {
    String DB_URL     = "jdbc:mysql://<FQDN_любого_хоста_MySQL®>:3306/<имя_БД>?useSSL=false";
    String DB_USER    = "<имя_пользователя>";
    String DB_PASS    = "<пароль_пользователя>";

    try {
      Class.forName("com.mysql.cj.jdbc.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();}
  }
}

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

mvn clean package && \
java -jar target/app-0.1.0-jar-with-dependencies.jar

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

Node.jsNode.js

Перед подключением установите зависимости:

sudo apt update && sudo apt install --yes nodejs npm && \
npm install mysql2

"use strict"
const fs = require('fs');
const mysql = require('mysql2');

const config = {
  host     : '<FQDN_любого_хоста_MySQL®>',
  port     : 3306,
  user     : '<имя_пользователя>',
  password : '<пароль_пользователя>',
  database : '<имя_БД>',
  ssl: {
    rejectUnauthorized: true,
    ca: fs.readFileSync('/home/<домашняя_директория>/.mysql/root.crt').toString(),
  },
}

const conn = mysql.createConnection(config)
conn.connect(err => {if (err) throw err})
  conn.query('SELECT version()', (err, result, fields) => {
    if (err) throw err
    console.log(result[0])
    conn.end()
  })

"use strict"
const mysql = require('mysql2');

const config = {
  host     : '<FQDN_любого_хоста_MySQL®>',
  port     : 3306,
  user     : '<имя_пользователя>',
  password : '<пароль_пользователя>',
  database : '<имя_БД>',
}

const conn = mysql.createConnection(config)
conn.connect(err => {if (err) throw err})
  conn.query('SELECT version()', (err, result, fields) => {
    if (err) throw err
    console.log(result[0])
    conn.end()
  })

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

node app.js

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

ODBCODBC

Перед подключением установите зависимости:

sudo apt update && sudo apt install --yes unixodbc && \
wget https://dev.mysql.com/get/Downloads/Connector-ODBC/8.0/mysql-connector-odbc_8.0.21-1ubuntu20.04_amd64.deb && \
sudo dpkg -i mysql-connector-odbc_8.0.21-1ubuntu20.04_amd64.deb

Драйвер MySQL® Connector/ODBC будет автоматически зарегистрирован в файле /etc/odbcinst.ini. Актуальная версия драйвера: mysql-connector-odbc.

Настройки подключения необходимо задать в файле /etc/odbc.ini.

[mysql]
Driver=MySQL ODBC 8.0 Unicode Driver
SERVER=<FQDN_любого_хоста_MySQL®>
UID=<имя_пользователя>
PWD=<пароль_пользователя>
DATABASE=<имя_БД>
PORT=3306
SSLCA=/home/<домашняя_директория>/.mysql/root.crt
SSLVERIFY=1

[mysql]
Driver=MySQL ODBC 8.0 Unicode Driver
SERVER=<FQDN_любого_хоста_MySQL®>
UID=<имя_пользователя>
PWD=<пароль_пользователя>
DATABASE=<имя_БД>
PORT=3306

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

isql -v mysql

После подключения к СУБД выполните команду SELECT version();.

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

PHPPHP

Перед подключением установите зависимости:

sudo apt update && apt install --yes php php-mysql

<?php
    $conn = mysqli_init();

    $conn->options(MYSQLI_OPT_SSL_VERIFY_SERVER_CERT, true);
    $conn->ssl_set(NULL, NULL, '/home/<домашняя_директория>/.mysql/root.crt', NULL, NULL);
    $conn->real_connect('<FQDN_любого_хоста_MySQL®>', '<имя_пользователя>', '<пароль_пользователя>', '<имя_БД>', 3306, NULL, MYSQLI_CLIENT_SSL);

    $q = $conn->query('SELECT version()');
    $result = $q->fetch_row();
    echo($result[0]);

    $q->close();
    $conn->close();
?>

<?php
    $conn = mysqli_init();

    $conn->options(MYSQLI_OPT_SSL_VERIFY_SERVER_CERT, false);
    $conn->real_connect('<FQDN_любого_хоста_MySQL®>', '<имя_пользователя>', '<пароль_пользователя>', '<имя_БД>', 3306, NULL, NULL);

    $q = $conn->query('SELECT version()');
    $result = $q->fetch_row();
    echo($result[0]);

    $q->close();
    $conn->close();
?>

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

php connect.php

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

PowerShellPowerShell

Перед подключением скачайте и установите утилиту MySQL Shell.

mysqlsh --host=<FQDN_любого_хоста_MySQL®> `
        --port=3306 `
        --ssl-ca=<абсолютный_путь_к_файлу_сертификата> `
        --ssl-mode=VERIFY_IDENTITY `
        --user=<имя_пользователя> `
        --password `
        --database=<имя_БД> `
        --sql

mysqlsh --host=<FQDN_любого_хоста_MySQL®> `
        --port=3306 `
        --ssl-mode=DISABLED `
        --user=<имя_пользователя> `
        --password `
        --database=<имя_БД>

О том, как получить FQDN хоста, см. инструкцию.

При выполнении любой из команд введите пароль пользователя БД.

После подключения к СУБД выполните команду SELECT version();.

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

PythonPython

Перед подключением установите зависимости:

sudo apt update && sudo apt install --yes python3 python3-pip libmysqlclient-dev && \
pip3 install mysqlclient

import MySQLdb

conn = MySQLdb.connect(
      host="<FQDN_любого_хоста_MySQL®>",
      port=3306,
      db="<имя_БД>",
      user="<имя_пользователя>",
      passwd="<пароль_пользователя>",
      ssl={'ca': '~/.mysql/root.crt'})

cur = conn.cursor()
cur.execute('SELECT version()')

print(cur.fetchone()[0])

conn.close()

import MySQLdb

conn = MySQLdb.connect(
      host="<FQDN_любого_хоста_MySQL®>",
      port=3306,
      db="<имя_БД>",
      user="<имя_пользователя>",
      passwd="<пароль_пользователя>")

cur = conn.cursor()
cur.execute('SELECT version()')

print(cur.fetchone()[0])

conn.close()

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

python3 connect.py

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

RubyRuby

Перед подключением установите зависимости:

sudo apt update && sudo apt install --yes ruby ruby-mysql2

require "mysql2"

conn = Mysql2::Client.new(
        :host => "<FQDN_любого_хоста_MySQL®>",
        :port => 3306,
        :database => "<имя_БД>",
        :username => "<имя_пользователя>",
        :password => "<пароль_пользователя>",
        :ssl_mode => "verify_identity",
        :sslca => "~/.mysql/root.crt")

q = conn.query("SELECT version()")

q.each do |result|
  puts result["version()"]
end

conn.close()

require "mysql2"

conn = Mysql2::Client.new(
        :host => "<FQDN_любого_хоста_MySQL®>",
        :port => 3306,
        :database => "<имя_БД>",
        :username => "<имя_пользователя>",
        :password => "<пароль_пользователя>")

q = conn.query("SELECT version()")

q.each do |result|
  puts result["version()"]
end

conn.close()

О том, как получить FQDN хоста, см. инструкцию.

Подключение:

ruby connect.rb

При успешном подключении к кластеру и выполнении тестового запроса будет выведена версия MySQL®.

ClickHouse® является зарегистрированным товарным знаком ClickHouse, Inc.