1
0
mirror of https://github.com/alm494/sql_proxy.git synced 2025-10-08 22:01:51 +02:00

update readme

This commit is contained in:
Almaz Sharipov
2025-04-22 07:15:32 +03:00
parent 1c18f45fd1
commit fc0c73e2f2

View File

@@ -30,17 +30,18 @@
## Основные особенности
+ Поддержка нескольких баз данных : совместим с PostgreSQL, Microsoft SQL Server и MySQL. Не требуется устанавливать
+ Поддержка нескольких баз данных: совместим с PostgreSQL, Microsoft SQL Server и MySQL. Не требуется устанавливать
драйверы и настраивать источники ODBC. При необходимости можно интегрировать дополнительные стандартные драйверы баз данных Golang добавив несколько строчек кода;
+ Безопасное управление учетными данными : не хранит данные учетных записей, гарантируя защиту конфиденциальной информации;
+ Защищённое соединение : при необходимости, поддерживает HTTPS для безопасной передачи данных;
+ Пул соединений : использует общий переиспользуемый пул SQL-соединений с регламентными задачами обслуживания для удаления устаревших или зависших соединений;
+ Поддержка языка SQL : поддерживает любые SQL-команды без ограничений. Команда SELECT возвращает результаты запроса в виде гибкого JSON-формата набора записей;
+ Ограничение результатов : позволяет настраивать ограничения на количество строк, возвращаемых командами SELECT;
+ Поддержка подготовленных выражений : реализована;
+ Гибкая привязка : может быть привязан к localhost или любому указанному IP-адресу для повышения безопасности. По умолчанию предполагается привязка к localhost и работа в паре с устаревшим программным обеспечением;
+ Ответственность за безопасность : не выполняет валидацию SQL-запросов в целях безопасности. Ответственность за настройку соответствующих привилегий базы данных лежит на администраторе СУБД;
+ Мониторинг и метрики : предоставляет метрики Prometheus;
+ Режим запуска: можно настроить как простую отдельную службу, либо использовать в контейнере в k8s;
+ Безопасное управление учетными данными: не хранит данные учетных записей, гарантируя защиту конфиденциальной информации;
+ Защищённое соединение: при необходимости, поддерживает HTTPS для безопасной передачи данных;
+ Пул соединений: использует общий переиспользуемый пул SQL-соединений с регламентными задачами обслуживания для удаления устаревших или зависших соединений;
+ Поддержка языка SQL: поддерживает любые SQL-команды без ограничений. Команда SELECT возвращает результаты запроса в виде гибкого JSON-формата набора записей;
+ Ограничение результатов: позволяет настраивать ограничения на количество строк, возвращаемых командами SELECT;
+ Поддержка подготовленных выражений: реализована;
+ Гибкая привязка: может быть привязан к localhost или любому указанному IP-адресу для повышения безопасности. По умолчанию предполагается привязка к localhost и работа в паре с устаревшим программным обеспечением;
+ Ответственность за безопасность: не выполняет валидацию SQL-запросов в целях безопасности. Ответственность за настройку соответствующих привилегий базы данных лежит на администраторе СУБД;
+ Мониторинг и метрики: предоставляет метрики Prometheus;
## Описание API
@@ -58,7 +59,7 @@ make prod
## Как запустить
Все параметры передаются через переменные окружения, см. Makefile для детальной информации:
Все параметры передаются через переменные окружения, см. Makefile для детальной информации и значений настроек по умолчанию:
```
BIND_ADDR=localhost BIND_PORT=8081 MAX_ROWS=10000 LOG_LEVEL=3 sql-proxy