MySQL- Руководство разработчика

Модуль MySQLServer


Этот модуль включает объект TMySQLServer, полученный из стандартного класса Delphi 5 TCustomConnection.

Компонент: TMySQLServer

Типы: TMySQLServerLoginEvent

Подпрограммы: MYSQLError

Описание

TMySQLServer представляет собой основной компонент в наборе TMySQLComponent. TMySQLServer используется, чтобы обработать фактические подключения к серверу MySQL, используя стандартные функции из libmysql.dll. Большую часть времени Вы будете использовать только один компонент сервера, зато много компонентов TMySQLDatasets.

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

Помимо этих функций, этот компонент имеет много полезных свойств и функций, чтобы создавать, удалять, использовать базы данных, получать информацию о версии, собирать списки баз данных, таблиц, полей и т. д.

Свойства

AfterConnect!AL("AfterConnect_Property") AfterDisconnect!AL("AfterDisconnect_Property") BeforeConnect!AL("BeforeConnect_Property") BeforeDisconnect!AL("BeforeDisconnect_Property") Build ClientVersion Compression Connected!AL("Connected_Property") DatabaseName Host IdleTimer Info IntVer LoginPrompt Major Minor Params Password Port Protocol ServerVersion UserName

Методы

Create!AL("Create_Method") Destroy!AL("Destroy_Method") AllocConnection ExecSQL FormatIdentifier FormatIdentifiers SelectDatabase Server CreateDatabase DropDatabase FreeConnection GetDatabaseNames GetFieldNames GetTableNames RegisterClient!AL("RegisterClient_Method") Reload SendEvent UnRegisterClient!AL("UnRegisterClient_Method")

События

Key events OnIdleTimer OnLogin

Цель

Обеспечить все приложенные наборы данных физическими подключениями к серверу MySQL, используя стандартную библиотеку libmysql.dll. Это основной компонент в наборе TMySQLComponent.




Свойство Build

Применимо к TMySQLServer

Определение

property Build : word;

Описание



Сервер формирует версию как слово, например, 32

Read-only

Свойство ClientVersion

Применимо к TMySQLServer

Определение

property ClientVersion : string;

Описание



Используемая версия клиентской разделяемой библиотеки libmysql.dll.

Read-only

Свойство Compression

Применимо к TMySQLServer

Определение

property Compression : boolean;

Описание



Определяет протокол сжатия, используемый при связи с сервером MySQL.

Свойство DatabaseName

Применимо к TMySQLServer

Определение

property DatabaseName : string;

Описание



Получает или определяет текущую (актуальную) базу данных для этого подключения.

Свойство Host

Применимо к TMySQLServer

Определение

property Host : string;

Описание



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

Свойство IdleTimer

Применимо к TMySQLServer

Определение

property IdleTimer : longword;

Описание



Получает или определяет актуальное время неактивности (тайм-аут), позволенное для этого подключения. Подключение автоматически будет пересоздано после того, как это время закончится, а связь еще нужна.

Свойство Info

Применимо к TMySQLServer

Определение

property Info : string;

Описание



Более подробная информация о сервере.

Read-only

Свойство IntVer

Применимо к TMySQLServer

Определение

property IntVer : longword;

Описание



Версия сервера как слово, например, 32306.

Read-only

Свойство LoginPrompt

Применимо к TMySQLServer

Определение

property LoginPrompt;

Описание



Если установлено в True, это учитывает настроенный диалог подсказки MySQL входа в систему, который будет появляться каждый раз, когда устанавливается связь с этим сервером.

Свойство Major

Применимо к TMySQLServer

Определение

property Major : word;

Описание



Старшая часть версии сервера как слово, например, 3

Read-only

Свойство Minor

Применимо к TMySQLServer

Определение

property Minor : word;

Описание



Младшая часть версии сервера как слово, например, 22



Read-only

Свойство Params

Применимо к TMySQLServer

Определение

property Params : TStrings;

Описание



Стандартные параметры, используемые для сервера событием OnLogin. Могут быть изменены во время выполнения.

Свойство Password

Применимо к TMySQLServer

Определение

property Password : string;

Описание



Получает или определяет текущий пароль, используемый при создании нового подключения.

Свойство Port

Применимо к TMySQLServer

Определение

property Port : word;

Описание



Получает или определяет текущий порт, используемый при связи с сервером.

Свойство Protocol

Применимо к TMySQLServer

Определение

property Protocol : string;

Описание



Используемый протокол связи: TCP/IP, Pipes и т.д.

Read-only

Свойство ServerVersion

Применимо к TMySQLServer

Определение

property ServerVersion : string;

Описание



Версия сервера MySQL в виде строки.

Read-only

Свойство UserName

Применимо к TMySQLServer

Определение

property UserName : string;

Описание



Получает или определяет текущее имя пользователя, используемое при создании нового подключения.

Метод AllocConnection

Применим к TMySQLServer

Определение

function AllocConnection : PMYSQL;

Описание



Распределяет новое подключение для TMySQLServer и TMySQLDatasets, используя текущие параметры настройки Username, Password, Port и прочие.

Это внутренне используемый метод, обычно он используется только порожденными классами TMySQLServer.

Метод ExecSQL

Применим к TMySQLServer

Определение

function ExecSQL(SQL : string) : boolean;

Описание



Используя подключение, выполнит любую инструкцию SQL на сервере.

Метод FormatIdentifier

Применим к TMySQLServer

Определение

function FormatIdentifier(Value : string) : string;

Описание



Форматирует идентификатор Value, используя информацию о версии сервера. Например, "Table 1" превратится в "`Table 1`".

Метод FormatIdentifiers

Применим к TMySQLServer

Определение

function FormatIdentifiers(const Value : string) : string;

Описание



Форматирует идентификаторы, полученные в строке Value, используя информацию о версии сервера. Например, "Table 1#10#13Table2#10#13Table 3" превратится в "`Table 1`,Table 2,`Table 3`".



Метод SelectDatabase

Применим к TMySQLServer

Определение

function SelectDatabase(Conn : PMYSQL; DB : string) : boolean;

Описание



Для данного подключения выбирает текущую (актуальную) базу данных, то есть действует аналогично команде "USE Database;". Это внутренне используемый метод. Обычно он применяется только классами, порожденными от TMySQLServer.

Метод Server

Применим к TMySQLServer

Определение

function Server : PMYSQL;

Описание



Представляет собой указатель на текущее потоковое подключение к серверу. Это может использоваться со всеми стандартными функциями mysql_, найденными в библиотеке libmysql.dll. Это внутренне используемый метод. Обычно он применяется только классами, порожденными от TMySQLServer.

Метод CreateDatabase

Применим к TMySQLServer

Определение

procedure CreateDatabase(Value : string);

Описание



При использовании подключения к серверу создает новую базу данных, то есть работает аналогично инструкции "CREATE Database;".

Метод DropDatabase

Применим к TMySQLServer

Определение

procedure DropDatabase(Value : string);

Описание



При использовании текущего подключения к серверу удаляет указанную базу данных, то есть работает аналогично инструкции "DROP Database;".

Метод FreeConnection

Применим к TMySQLServer

Определение

procedure FreeConnection(var Value : PMYSQL);

Описание



Освобождает активное подключение.

Метод GetDatabaseNames

Применим к TMySQLServer

Определение

procedure GetDatabaseNames(List : TStrings);

Описание



Заполняет список со всеми именами баз данных, найденными на сервере. Замечание: в этом списке не будут перечислены те базы данных, на которых Вы не имеете никаких привилегий.

Метод GetFieldNames

Применим к TMySQLServer

Определение

procedure GetFieldNames(const DatabaseName, TableName : string; List : TStrings);

Описание

Заполняет cписок всеми именами полей для таблицы TableName из базы данных DatabaseName с сервера.

Метод GetTableNames

Применим к TMySQLServer

Определение

procedure GetTableNames(const DatabaseName : string; List : TStrings);



Описание



Заполняет cписок всеми именами таблиц из базы данных DatabaseName.

Метод Reload

Применим к TMySQLServer

Определение

procedure Reload;

Описание



Перезагружает права доступа на сервере, то есть работает как команда "RELOAD;"

Метод SendEvent

Применим к TMySQLServer

Определение

procedure SendEvent(Connecting : Boolean);

Описание



Используется, чтобы разъединить все наборы данных, если сервер завершается. Это внутренне используемый метод. Обычно он применяется только классами, порожденными от TMySQLServer.

Событие OnIdleTimer

Применимо к TMySQLServer

Определение

property OnIdleTimer : TNotifyEvent;

Описание



Это событие происходит, когда заканчивается время ожидания подключения.

Событие OnLogin

Применимо к TMySQLServer

Определение

property OnLogin : TMySQLServerLoginEvent;

Описание



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

Тип TMySQLServerLoginEvent

Модуль MySQLServer

Определение

type TMySQLServerLoginEvent = procedure(Server : TMySQLServer; LoginParams : TStrings); of object;

Описание



Это событие происходит до установки связи с сервером MySQL. Список строк LoginParams в настоящее время поддерживает только два ключевых слова в форме: USERNAME=root, PASSWORD=.

Процедура MYSQLError

Модуль MySQLServer

Определение

procedure MYSQLError(MySQLHandle : PMySQL=nil; ErrNo : integer=-1; Msg : string=''; IntVer : longword=32100);

Описание



Универсальная функция создания исключительной ситуации, предоставляет зависящую от версии информацию относительно последней ошибки MySQL.


Содержание раздела