RU/dbConnect: Difference between revisions
No edit summary |
(→Пример) |
||
(4 intermediate revisions by 3 users not shown) | |||
Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
{{Translate}} | |||
{{RU/Server function}} | {{RU/Server function}} | ||
Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с [[RU/dbQuery|dbQuery]]. Для отключения используйте [[RU/destroyElement|destroyElement]]. | Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с [[RU/dbQuery|dbQuery]]. Для отключения используйте [[RU/destroyElement|destroyElement]]. | ||
{{RU/Note| | {{RU/Note|Подсоединение и отсоединение много раз может негативно повлиять на производительность сервера. Для оптимальной производительности рекомендуется использовать dbConnect только один раз, когда ресурс запускается, и использовать это соединение во всем ресурсе.}} | ||
{{RU/Note|dbConnect на Linux MySQL требует libmysqlclient.so.15 (для MTA 1.3), или libmysqlclient.so.16 (для MTA 1.4)}} | {{RU/Note|dbConnect на Linux MySQL требует libmysqlclient.so.15 (для MTA 1.3), или libmysqlclient.so.16 (для MTA 1.4)}} | ||
==Синтаксис== | ==Синтаксис== | ||
Line 11: | Line 12: | ||
===Обязательные параметры=== | ===Обязательные параметры=== | ||
*'''databaseType:''' Тип базы данных. Может быть ''sqlite'' или ''mysql'' | *'''databaseType:''' Тип базы данных. Может быть ''sqlite'' или ''mysql'' | ||
*'''host:''' | *'''host:''' Цель для подключения. Формат зависит от типа базы данных. | ||
** Для SQLite | ** Для SQLite это [[filepath|путь]] к файлу SQLite базы данных. Если путь начинается с ":/" будет использоваться глобальный каталог баз данных сервера. Файл будет создан, если он не существует. | ||
** Для MySQL | ** Для MySQL это список формата ключ=значение, разделенный точкой с запятой. Поддерживаются следующие ключи: | ||
*** '''dbname''': | *** '''dbname''': Имя базы данных для использования. Например: ''dbname=test'' | ||
*** '''host''': | *** '''host''': Адрес хоста. Например: ''host=127.0.0.1'' | ||
*** '''port''': | *** '''port''': Порт хоста. Например: ''port=1234'' (опционально, по умолчанию используется стандартный порт MySQL) | ||
*** '''unix_socket''': Unix | *** '''unix_socket''': Unix-сокет или именованный канал для использования (опционально) | ||
===Необязательные параметры=== | ===Необязательные параметры=== | ||
*'''username:''' Обычно требуется для MySQL, игнорируется для SQLite | *'''username:''' Обычно требуется для MySQL, игнорируется для SQLite | ||
*'''password:''' Обычно требуется для MySQL, игнорируется для SQLite | *'''password:''' Обычно требуется для MySQL, игнорируется для SQLite | ||
*'''options :''' | *'''options :''' Список ключей = Пары значений, которые разделены точкой с запятой. Поддерживаемые ключи: | ||
**'''share''' | **'''share''' может быть установлен на 0 или 1. (Значение по умолчанию для SQLite это "share=1", а для MySQL это "share=0"). Когда установлено значение 1, подключение становится общим и это будет использоваться другими вызовами dbConnect с той же строкой хоста. Это обычно хорошо для SQLite подключений, но не очень хорошо для MySQL если не соблюдать осторожность. | ||
**'''batch''' | **'''batch''' может быть установлен на 0 ил 1. (По умолчанию "batch=1"). Когда установлено на 1, запросы, вызываемые в одном кадре, автоматически объединяются, что может значительно ускорить вставку / обновление. Недостатком является то, что вы теряете контроль над функцией, которая используется для достижения пакетной обработки (для SQLite это транзакции, для MySQL это режим autocommit). Следовательно, если вы используете транзакции, блокируете таблицы или управляйте режимом autocommit самостоятельно, вы можете отключить эту функцию. | ||
**'''autoreconnect''' | **'''autoreconnect''' может быть установлен на 0 или 1. (По умолчанию "autoreconnect=1"). Когда установлено на 1, разорванные подключения будут автоматически переподключены. Обратите внимание, что переменные сеанса (вкл. SET NAMES), пользовательские переменные, закрытые и временные таблицы будут сброшены из-за переподключения. Так что, если вы используете необычные функции, вам нужно будет отключить автоподключение и справиться с разорванными соединениями другим способом. | ||
**'''log''' | **'''log''' может быть установлен на 0 или 1. (Значение по умолчанию "log=1"). Когда установлено на 0, активность с данного подключения не будет записана в [[Server_Commands#debugdb|файл журнала отладки базы данных.]]. | ||
**'''tag''' ( | **'''tag''' (Значение по умолчанию "tag<nowiki>=</nowiki>script"). Строка, которая помогает идентифицировать активность этого соединения в [[Server_Commands#debugdb|файле журнала отладки базы данных]]. | ||
**'''suppress''' | **'''suppress''' разделенный запятыми список кодов ошибок, которые следует игнорировать. (например "suppress<nowiki>=</nowiki>1062,1169"). | ||
**'''charset''' | **'''charset''' если вы хотите общаться с сервером, используя набор символов, отличный от набора по умолчанию, вам необходимо указать, какой из них. (например "charset<nowiki>=</nowiki>utf8"). (используется только в MySQL) | ||
===Возвращает=== | ===Возвращает=== | ||
Line 35: | Line 36: | ||
==Пример== | ==Пример== | ||
В этом примере открывается соединение с файлом базы данных SQLite в текущем ресурсе. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "sqlite", "file.db" ) | test_db = dbConnect( "sqlite", "file.db" ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В этом примере открывается соединение с файлом базы данных SQLite в другом ресурсе. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "sqlite", ":resname/file.db" ) | test_db = dbConnect( "sqlite", ":resname/file.db" ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В этом примере открывается соединение с файлом базы данных SQLite в каталоге глобальных баз данных. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "sqlite", ":/file.db" ) | test_db = dbConnect( "sqlite", ":/file.db" ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В этом примере открывается соединение с файлом базы данных SQLite в подкаталоге каталога глобальных баз данных. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "sqlite", ":/example/sub/dir/file.db" ) | test_db = dbConnect( "sqlite", ":/example/sub/dir/file.db" ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В этом примере открывается соединение с базой данных MySQL с именем «frank» на сервере с ip 1.2.3.4 используя набор символов utf8 и с разрешением совместного использования соединения. Обратите внимание, что изменение базы данных или других зависимых от подключения настроек влияет на все общие подключения. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "mysql", "dbname=frank;host=1.2.3.4", "username", "password", "share=1" ) | test_db = dbConnect( "mysql", "dbname=frank;host=1.2.3.4", "username", "password", "share=1" ) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
В этом примере открывается соединение с базой данных SQLite, запрещается совместное использование соединения. | |||
<syntaxhighlight lang="lua"> | <syntaxhighlight lang="lua"> | ||
test_db = dbConnect( "sqlite", "file.db", "", "", "share=0" ) | test_db = dbConnect( "sqlite", "file.db", "", "", "share=0" ) | ||
</syntaxhighlight> | |||
В этом примере выводится сообщение об отладке, установлено ли соединение с базой данных SQLite или нет | |||
<syntaxhighlight lang="lua"> | |||
test_db = dbConnect( "sqlite", "file.db" ) | |||
if test_db then | |||
outputDebugString( "Связь с базой данных была успешно установлена." ) | |||
else | |||
outputDebugString( "Не удалось установить соединение с базой данных." ) | |||
end | |||
</syntaxhighlight> | |||
В следующем примере показано, как можно найти общий ресурс для операций с базой данных с экспортированными функциями (запросить и выполнить): | |||
<syntaxhighlight lang="lua"> | |||
function connect() | |||
DBConnection = dbConnect( "mysql", "dbname=DBNAME;host=HOST;charset=utf8", "USERNAME", "PASSWORD" ) | |||
if (not DBConnection) then | |||
outputDebugString("Ошибка: не удалось установить соединение с сервером базы данных MySQL") | |||
else | |||
outputDebugString("Успешно: Соединено с сервером базы данных MySQL") | |||
end | |||
end | |||
addEventHandler("onResourceStart",resourceRoot, connect) | |||
function query(...) | |||
local queryHandle = dbQuery(DBConnection, ...) | |||
if (not queryHandle) then | |||
return nil | |||
end | |||
local rows = dbPoll(queryHandle, -1) | |||
return rows | |||
end | |||
function execute(...) | |||
local queryHandle = dbQuery(DBConnection, ...) | |||
local result, numRows = dbPoll(queryHandle, -1) | |||
return numRows | |||
end | |||
function getDBConnection() | |||
return DBConnection | |||
end | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Latest revision as of 19:15, 18 February 2020
Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с dbQuery. Для отключения используйте destroyElement.
Примечание: Подсоединение и отсоединение много раз может негативно повлиять на производительность сервера. Для оптимальной производительности рекомендуется использовать dbConnect только один раз, когда ресурс запускается, и использовать это соединение во всем ресурсе. |
Примечание: dbConnect на Linux MySQL требует libmysqlclient.so.15 (для MTA 1.3), или libmysqlclient.so.16 (для MTA 1.4) |
Синтаксис
element dbConnect ( string databaseType, string host [, string username = "", string password = "", string options = "" ] )
Синтаксис ООП Помогите! Я не понимаю, что это!
- Метод: Connection(...)
Обязательные параметры
- databaseType: Тип базы данных. Может быть sqlite или mysql
- host: Цель для подключения. Формат зависит от типа базы данных.
- Для SQLite это путь к файлу SQLite базы данных. Если путь начинается с ":/" будет использоваться глобальный каталог баз данных сервера. Файл будет создан, если он не существует.
- Для MySQL это список формата ключ=значение, разделенный точкой с запятой. Поддерживаются следующие ключи:
- dbname: Имя базы данных для использования. Например: dbname=test
- host: Адрес хоста. Например: host=127.0.0.1
- port: Порт хоста. Например: port=1234 (опционально, по умолчанию используется стандартный порт MySQL)
- unix_socket: Unix-сокет или именованный канал для использования (опционально)
Необязательные параметры
- username: Обычно требуется для MySQL, игнорируется для SQLite
- password: Обычно требуется для MySQL, игнорируется для SQLite
- options : Список ключей = Пары значений, которые разделены точкой с запятой. Поддерживаемые ключи:
- share может быть установлен на 0 или 1. (Значение по умолчанию для SQLite это "share=1", а для MySQL это "share=0"). Когда установлено значение 1, подключение становится общим и это будет использоваться другими вызовами dbConnect с той же строкой хоста. Это обычно хорошо для SQLite подключений, но не очень хорошо для MySQL если не соблюдать осторожность.
- batch может быть установлен на 0 ил 1. (По умолчанию "batch=1"). Когда установлено на 1, запросы, вызываемые в одном кадре, автоматически объединяются, что может значительно ускорить вставку / обновление. Недостатком является то, что вы теряете контроль над функцией, которая используется для достижения пакетной обработки (для SQLite это транзакции, для MySQL это режим autocommit). Следовательно, если вы используете транзакции, блокируете таблицы или управляйте режимом autocommit самостоятельно, вы можете отключить эту функцию.
- autoreconnect может быть установлен на 0 или 1. (По умолчанию "autoreconnect=1"). Когда установлено на 1, разорванные подключения будут автоматически переподключены. Обратите внимание, что переменные сеанса (вкл. SET NAMES), пользовательские переменные, закрытые и временные таблицы будут сброшены из-за переподключения. Так что, если вы используете необычные функции, вам нужно будет отключить автоподключение и справиться с разорванными соединениями другим способом.
- log может быть установлен на 0 или 1. (Значение по умолчанию "log=1"). Когда установлено на 0, активность с данного подключения не будет записана в файл журнала отладки базы данных..
- tag (Значение по умолчанию "tag=script"). Строка, которая помогает идентифицировать активность этого соединения в файле журнала отладки базы данных.
- suppress разделенный запятыми список кодов ошибок, которые следует игнорировать. (например "suppress=1062,1169").
- charset если вы хотите общаться с сервером, используя набор символов, отличный от набора по умолчанию, вам необходимо указать, какой из них. (например "charset=utf8"). (используется только в MySQL)
Возвращает
Возвращает элемент подключения к базе данных, если проблем нет, в противном случае false.
Пример
В этом примере открывается соединение с файлом базы данных SQLite в текущем ресурсе.
test_db = dbConnect( "sqlite", "file.db" )
В этом примере открывается соединение с файлом базы данных SQLite в другом ресурсе.
test_db = dbConnect( "sqlite", ":resname/file.db" )
В этом примере открывается соединение с файлом базы данных SQLite в каталоге глобальных баз данных.
test_db = dbConnect( "sqlite", ":/file.db" )
В этом примере открывается соединение с файлом базы данных SQLite в подкаталоге каталога глобальных баз данных.
test_db = dbConnect( "sqlite", ":/example/sub/dir/file.db" )
В этом примере открывается соединение с базой данных MySQL с именем «frank» на сервере с ip 1.2.3.4 используя набор символов utf8 и с разрешением совместного использования соединения. Обратите внимание, что изменение базы данных или других зависимых от подключения настроек влияет на все общие подключения.
test_db = dbConnect( "mysql", "dbname=frank;host=1.2.3.4", "username", "password", "share=1" )
В этом примере открывается соединение с базой данных SQLite, запрещается совместное использование соединения.
test_db = dbConnect( "sqlite", "file.db", "", "", "share=0" )
В этом примере выводится сообщение об отладке, установлено ли соединение с базой данных SQLite или нет
test_db = dbConnect( "sqlite", "file.db" ) if test_db then outputDebugString( "Связь с базой данных была успешно установлена." ) else outputDebugString( "Не удалось установить соединение с базой данных." ) end
В следующем примере показано, как можно найти общий ресурс для операций с базой данных с экспортированными функциями (запросить и выполнить):
function connect() DBConnection = dbConnect( "mysql", "dbname=DBNAME;host=HOST;charset=utf8", "USERNAME", "PASSWORD" ) if (not DBConnection) then outputDebugString("Ошибка: не удалось установить соединение с сервером базы данных MySQL") else outputDebugString("Успешно: Соединено с сервером базы данных MySQL") end end addEventHandler("onResourceStart",resourceRoot, connect) function query(...) local queryHandle = dbQuery(DBConnection, ...) if (not queryHandle) then return nil end local rows = dbPoll(queryHandle, -1) return rows end function execute(...) local queryHandle = dbQuery(DBConnection, ...) local result, numRows = dbPoll(queryHandle, -1) return numRows end function getDBConnection() return DBConnection end
Требования
Минимально поддерживаемый сервер | 1.1.1-9.03328 |
---|---|
Минимально поддерживаемый клиент | n/a |
Примечание: Использование этой функции требует указания минимальной версии в разделе <min_mta_version> meta.xml ресурса. Пример: <min_mta_version server="1.1.1-9.03328" />
Список изменений
Version | Description |
---|
1.3.1-9.04817 | Добавлены опции 'log', 'tag' и 'suppress' |
1.3.5-9.06386 | Добавлена опция 'charset' |