Firebird embedded/ru: what changed
Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.
| Old | New | Line | |
|---|---|---|---|
| 1 | 1 | ## Что это такое | |
| 2 | 2 | ||
| 3 | 3 | Firebird Embedded - это специальная версия сервера баз данных [[Firebird/ru|Firebird]]. Она позволяет вам запускать ваши программы без выделенного (прим.перев.: предварительно запущенного) сервера базы данных. Вместо этого вы добавляете библиотеку (.dll/.so/.dylib) в свое приложение) и позволяете вашему приложению получать доступ к файлу базы данных Firebird .fdb с помощью этой библиотеки. | |
| 4 | 4 | ||
| 5 | 5 | Это похоже на работу таких программ, как Microsoft Access и LibreOffice Base. | |
| 6 | 6 | ||
| 7 | 7 | Преимущества: | |
| 8 | 8 | ||
| 9 | 9 | - работает на многих архитектурах (Linux, macOS, Windows, FreeBSD, Solaris) | |
| 10 | 10 | - отдельная настройка сервера не требуется, что снижает сложность использования | |
| 11 | 11 | - вы можете легко переключаться с embedded на полноценный клиент/сервер - без изменения строк кода (кроме строки подключения). Это, вероятно, хорошее преимущество по сравнению с sqlite. | |
| 12 | 12 | - прим.перев.: не требуется пароль (он может быть произвольным) | |
| 13 | 13 | ||
| 14 | 14 | Недостатки: | |
| 15 | 15 | ||
| 16 | 16 | - только однопользовательский доступ | |
| 17 | 17 | - необходимо распространять некоторые библиотеки вместе с вашей программой при ее распространении (если вы не можете статически связать их) | |
| 18 | 18 | ||
| 19 | 19 | ## Предупреждение: Windows x64 | |
| 20 | 20 | ||
| 21 | 21 | > **Warning:** В версиях FPC ниже FPC 2.7.1 r23738 (март 2013 г.), FPC x64 в Windows не очень хорошо работает с embedded dll Firebird или другими DLL. Раздел ниже содержит обходной путь, если у вас есть старая версия FPC | |
| 22 | 22 | ||
| 23 | 23 | В версиях FPC ниже 2.7.1 r23738 вы можете получать ошибки/исключения объекта IBConnection, даже если вы пишете правильный код(см., например, [Create database bug report](http://bugs.freepascal.org/view.php?id=21581). | |
| 24 | 24 | ||
| 25 | 25 | Обходное решение: | |
| 26 | 26 | ||
| 27 | 27 | 1. перейти к моментальному снимку разработки/версии FPC после FPC 2.7.1 r23738; см. [[User Changes 3.0|Exception handling has been changed to be ABI-conformant]] | |
| 28 | 28 | 2. если на FPC 2.7.1 ниже, чем r23738, скомпилируйте FPC с ключом `-dTEST_WIN64_SEH`, чтобы использовать новый код Структурированной Обработки Исключений (SEH) на Win64. | |
| 29 | 29 | 3. использовать 32-битную FPC и Lazarus на Windows 64 | |
| 30 | 30 | ||
| 31 | 31 | ## Установка | |
| 32 | 32 | ||
| 33 | 33 | В Windows встроенный Firebird и обычные клиентские библиотеки Firebird - это разные файлы. Встроенный Firebird всегда может служить обычным клиентом, что делает его логичным выбором для включения в вашу установку. | |
| 34 | 34 | ||
| 35 | 35 | ### Windows | |
| 36 | 36 | ||
| 37 | 37 | Загрузите и разархивируйте комплект embedded Firebird. Убедитесь, что файлы .dll и .manifest находятся либо: | |
| 38 | 38 | ||
| 39 | 39 | - в каталоге вашего проекта и в каталоге исполняемых файлов (где генерируется .exe), либо | |
| 40 | 40 | - в каталоге в вашем PATH (не в системном каталоге) (полезно, если вы не хотите сохранять скопированные dll) | |
| 41 | 41 | ||
| 42 | 42 | Обратите внимание, что битность должна совпадать: вы должны использовать embedded x64 версию, если вы компилируете свою программу под 64-бит, и embedded x32, если вы пишете 32-битные программы. Также убедитесь, что файлы .dlls и .manifest размещены в выходном (исполняемом) каталоге вашего проекта, и распространяйте их вместе с приложениями и файлами лицензий. | |
| 43 | 43 | ||
| 44 | 44 | Как указание, минимально необходимыми файлами для Firebird 2.5 являются: | |
| 45 | 45 | ||
| 46 | 46 | - fbembed.dll | |
| 47 | 47 | - firebird.msg | |
| 48 | 48 | - ib_util.dll | |
| 49 | 49 | - icudt30.dll | |
| 50 | 50 | - icuin30.dll | |
| 51 | 51 | - icuuc30.dll | |
| 52 | 52 | - IDPLicense.txt | |
| 53 | 53 | - IPLicense.txt | |
| 54 | 54 | - Microsoft.VC80.CRT.manifest | |
| 55 | 55 | - msvcp80.dll | |
| 56 | 56 | - msvcr80.dll | |
| 57 | 57 | ||
| 58 | 58 | ### Linux | |
| 59 | 59 | ||
| 60 | 60 | Для Debian, вероятно, похоже на Ubuntu: получите файлы библиотеки, а также символическую ссылку: например, /usr/lib/x86_64-linux-gnu/libfbembed.so linking для /user/lib/x86_64-linux-gnu/libfbembed.so.bla.x.y | |
| 61 | 61 | ||
| 62 | 62 | ``` bash | |
| 63 | 63 | aptitude install libfbembed2.5 firebird-dev | |
| 64 | 64 | ``` | |
| 65 | 65 | ||
| 66 | 66 | По крайней мере, для Firebird 2.5+: не указывайте имя пользователя или пароль, так как это приведет к поиску security.fdb, что может привести к сбою в случае невозможности доступа к общесистемному security.fdb. Укажите роль RDB\$ADMIN в Firebird 2.5+, так как она должна дать вам полный контроль над файлом базы данных. | |
| 67 | 67 | ||
| 68 | 68 | Поместите эти файлы в каталог вашего проекта (для этого: проверьте, все ли это необходимо): | |
| 69 | 69 | ||
| 70 | - | ||
| 71 | - | ||
| 72 | - | ||
| 73 | - | ||
| 74 | - | ||
| 70 | + | ```text | |
| 71 | + | firebird/libfbembed.so (или возможно libfbembed.so.2.5) | |
| 72 | + | firebird.conf | |
| 73 | + | firebird/security.fdb #возможно, нет необходимости | |
| 74 | + | firebird/intl/fbintl | |
| 75 | + | firebird/udf/fbudf.so | |
| 76 | + | ``` | |
| 75 | 77 | ||
| 76 | 78 | Для Firebird 3 вам понадобится: | |
| 77 | 79 | ||
| 78 | - | ||
| 79 | - | ||
| 80 | + | ```text | |
| 81 | + | firebird/libfbclient.so | |
| 82 | + | plugins/libEngine12.so | |
| 83 | + | ``` | |
| 80 | 84 | ||
| 81 | 85 | Вам нужно изменить переменную каталога плагинов. Если вы не можете этого сделать, вам нужно поместить libEngine в его оригинальный каталог. | |
| 82 | 86 | ||
| 83 | 87 | Установите это в firebird.conf (для этого: проверьте, все ли это необходимо) | |
| 84 | 88 | ||
| 85 | 89 | ``` ini | |
| 86 | 90 | RootDirectory=./firebird #замените на ваш каталог | |
| 87 | 91 | DatabaseAccess = Full #наверное полезно | |
| 88 | 92 | ExternalFileAccess = Full #наверное полезно | |
| 89 | 93 | UdfAccess = Full #наверное полезно | |
| 90 | 94 | #disable | |
| 91 | 95 | #TempDirectories = /tmp #=> не удалось исправить проблемы блокировки /tmp/firebird | |
| 92 | 96 | #TempDirectories = ~/tmp #=> не удалось исправить проблемы блокировки /tmp/firebird | |
| 93 | 97 | ``` | |
| 94 | 98 | ||
| 95 | 99 | Перед запуском приложения необходимо установить 2 переменные среды. Предположим, что приложение установлено в /home/pascaldev/embed: | |
| 96 | 100 | ||
| 97 | 101 | ``` bash | |
| 98 | 102 | # сообщаем динамическому загрузчику, где найти embedded lib: | |
| 99 | 103 | LD_LIBRARY_PATH=/home/pascaldev/embed/firebird | |
| 100 | 104 | # сообщаем серверу, где искать файлы (сообщения, настройки и т. д.) | |
| 101 | 105 | FIREBIRD=. #или используйте абсолютный путь: /home/pascaldev/embed | |
| 102 | 106 | ``` | |
| 103 | 107 | ||
| 104 | 108 | Если вы поймали ошибку такую, как | |
| 105 | 109 | ||
| 106 | - | ||
| 107 | - | ||
| 110 | + | ```text | |
| 111 | + | EIBDatabaseError/ : DoInternalConnect : | |
| 112 | + | -Can't access lock files' directory /tmp/firebird | |
| 113 | + | ``` | |
| 108 | 114 | ||
| 109 | 115 | возможно, у вас лежат устаревшие файлы блокировки, принадлежащие другому пользователю. Удаление каталога /tmp/firebird работает, но проблема в том, что он будет воссоздан под вашими локальными разрешениями. | |
| 110 | 116 | ||
| 111 | 117 | См. [Как установить embedded Firebird на Linux or Mac?](http://www.firebirdfaq.org/faq51/) для подсказок по работе со встроенным Firebird на Linux или Apple macOS. Кто-то использовал embedded Firebird в FPC: [Более ранняя версия embedded Firebird на Linux](http://www.mwasoftware.co.uk/index.php?option=com_content&task=view&id=105). | |
| 112 | 118 | ||
| 113 | 119 | ### macOS | |
| 114 | 120 | ||
| 115 | 121 | - todo: описать это, возможно адаптация [Более ранняя версия embedded Firebird на Linux](http://www.mwasoftware.co.uk/index.php?option=com_content&task=view&id=105) и особенно [Firebird Embedded на macOS](http://paulbeachsblog.blogspot.mx/2012/09/firebird-embedded-on-macosx.html) | |
| 116 | 122 | ||
| 117 | 123 | ### FreeBSD | |
| 118 | 124 | ||
| 119 | 125 | - to do: описать это, возможно адаптация [Более ранняя версия embedded Firebird на Linux](http://www.mwasoftware.co.uk/index.php?option=com_content&task=view&id=105) | |
| 120 | 126 | ||
| 121 | 127 | ## Коннект к серверу Firebird | |
| 122 | 128 | ||
| 123 | 129 | Как уже упоминалось, встроенный Firebird может работать как обычный клиент Firebird. Следовательно, использование встроенной библиотеки Firebird вместо клиент-серверной библиотеки Firebird может помочь сделать ваше приложение более гибким. | |
| 124 | 130 | ||
| 125 | 131 | > **Note:** по крайней мере, в Firebird Embedded 2.5.3 и FPC 2.6.4 есть ошибка, которая вылетает при закрытии соединения с удаленным сервером. Эта ошибка была исправлена в транке FPC. | |
| 126 | 132 | ||
| 127 | 133 | ## Использование | |
| 128 | 134 | ||
| 129 | 135 | Как только в вашем распоряжении окажутся подходящие библиотеки встроенного Firebird по правильному пути (см. выше), вам нужно указать, что вы подключаетесь к встроенной версии сервера, а не к клиент-серверной. Оставьте свойство hostname объекта *IBConnection* пустым. Остальные свойства работают так же, как в версии клиент/сервер, например DatabaseName - это полный путь к файлу .fdb или просто имя базы данных, если оно находится в том же каталоге, что и fbembed.dll. Кроме того, в старых версиях FPC (FPC 2.6.2+ это точно не нужно) может потребоваться установить для свойства UseEmbeddedFirebird значение true. Это свойство отсутствует в модуле SQLDB, но вам нужно добавить *ibase60dyn* в секцию uses. | |
| 130 | 136 | ||
| 131 | 137 | ### Создание базы данных | |
| 132 | 138 | ||
| 133 | 139 | #### Использование Firebird ISQL | |
| 134 | 140 | ||
| 135 | 141 | Вы можете создавать базы данных с помощью приложения Firebird isql (например, как это предусмотрено в обычном пакете Firebird (клиент)). В Windows этот исполняемый файл должен находиться в том же каталоге, что и ваш fbembed.dll. | |
| 136 | 142 | ||
| 137 | 143 | > **Note:** isql ожидает библиотеку fbclient, а не fbembed; Вы можете скопировать и переименовать fbembed, например, в fbclient.dll в Windows, чтобы это исправить. | |
| 138 | 144 | ||
| 139 | 145 | Запустите **isql**, затем сделайте: | |
| 140 | 146 | ||
| 141 | 147 | ``` sql | |
| 142 | 148 | create database 'employee.fdb' user 'SYSDBA' password 'masterkey' page_size 16384 default character set UTF8; | |
| 143 | 149 | exit; | |
| 144 | 150 | ``` | |
| 145 | 151 | ||
| 146 | 152 | Удаление базы данных в основном означало бы удаление файла, но вы также можете запустить: **isql** | |
| 147 | 153 | ||
| 148 | 154 | ``` sql | |
| 149 | 155 | connect 'employee.fdb' user 'sysdba' password 'masterkey'; | |
| 150 | 156 | drop database; | |
| 151 | 157 | commit; | |
| 152 | 158 | exit; | |
| 153 | 159 | ``` | |
| 154 | 160 | ||
| 155 | 161 | #### Программно | |
| 156 | 162 | ||
| 157 | 163 | Вы также можете создать базу данных из вашей программы. Программа в разделе [[Firebird embedded/ru|Создание тестовой базы данных]] ниже показывает, как вы можете обнаружить отсутствующие базы данных и создать их на лету. | |
| 158 | 164 | ||
| 159 | 165 | Аналогичная процедура может быть вызвана в приложениях Lazarus при инициализации вашей формы (событие FormShow). | |
| 160 | 166 | ||
| 161 | 167 | ### Создание таких объектов, как таблицы, вьюхи, триггеры,... | |
| 162 | 168 | ||
| 163 | 169 | Создание объектов - как и большинство вещей - одинаково, что в embedded Firebird, что в Firebird. См. [[Firebird/ru|Программное создание объектов]] | |
| 164 | 170 | ||
| 165 | 171 | ## Запуск набора тестов базы данных FPC | |
| 166 | 172 | ||
| 167 | 173 | Может быть полезно запускать среду тестирования базы данных FPC (в каталоге packages\fcl-db\tests), когда вы охотитесь за ошибками, пытаетесь выяснить, как что-то работает или улучшаете код базы данных. | |
| 168 | 174 | ||
| 169 | 175 | ### Сообщаем платформе, какую базу данных использовать | |
| 170 | 176 | ||
| 171 | 177 | Вам нужно будет отредактировать INI-файл db test framework, чтобы сообщить исполняемому файлу теста, что ему нужно использовать вашу встроенную базу данных. См. [[Databases/ru|Выполнение тестов базы данных FPC]] для получения инструкций о том, как это сделать. | |
| 172 | 178 | ||
| 173 | 179 | ### Создание тестовой базы данных | |
| 174 | 180 | ||
| 175 | 181 | Если вы настроили среду для использования Firebird, вам нужно будет подготовить среду для тестирования. | |
| 176 | 182 | ||
| 177 | 183 | Скопируйте библиотеки embedded Firebird и другие файлы для вашей архитектуры в тестовый каталог. | |
| 178 | 184 | ||
| 179 | 185 | Затем создайте тестовую базу данных - вручную или программно/ | |
| 180 | 186 | ||
| 181 | 187 | #### Создание базы данных вручную | |
| 182 | 188 | ||
| 183 | 189 | **isql** | |
| 184 | 190 | ||
| 185 | 191 | ``` sql | |
| 186 | 192 | create database 'test.fdb' user 'SYSDBA' password 'masterkey' page_size 16384 default character set UTF8; | |
| 187 | 193 | exit; | |
| 188 | 194 | ``` | |
| 189 | 195 | ||
| 190 | 196 | #### Программное создание базы данных | |
| 191 | 197 | ||
| 192 | 198 | Вы можете программно создать базу данных. В приведенном ниже примере создается локальная встроенная база данных, но ее можно легко изменить на удаленную базу данных (измените имя хоста и, если необходимо, путь): | |
| 193 | 199 | ||
| 194 | 200 | ``` pascal | |
| 195 | 201 | program firebirdembeddedtest; | |
| 196 | 202 | {$mode objfpc}{$H+} | |
| 197 | 203 | ||
| 198 | 204 | uses | |
| 199 | 205 | {$IFDEF UNIX}{$IFDEF UseCThreads} | |
| 200 | 206 | cthreads, | |
| 201 | 207 | {$ENDIF}{$ENDIF} | |
| 202 | 208 | Classes, SysUtils, | |
| 203 | 209 | sqldb, IBConnection {for Firebird}; | |
| 204 | 210 | ||
| 205 | 211 | const | |
| 206 | 212 | // Имя для базы данных. Обязательно укажите одно и то же имя в вашем database.ini | |
| 207 | 213 | DatabaseFile = 'test.fdb'; //Разумное имя для тестовой базы данных, верно? | |
| 208 | 214 | var | |
| 209 | 215 | Fire: TIBConnection; | |
| 210 | 216 | ||
| 211 | 217 | begin | |
| 212 | 218 | //Подключение к базе данных Firebird | |
| 213 | 219 | //Следующая строка нужна для довольно старых версий FPC | |
| 214 | 220 | //UseEmbeddedFirebird: = true; | |
| 215 | 221 | //Более новые версии сначала будут искать файл fbembed.dll в каталоге приложения автоматически | |
| 216 | 222 | //Использование встроенного (и fbembed.dll) или обычного клиент/сервера (fbclient.dll) требует использования ibase60dyn | |
| 217 | 223 | Fire:=TIBConnection.Create(nil); | |
| 218 | 224 | try | |
| 219 | 225 | Fire.HostName := ''; //должен быть пустым для embedded Firebird; должен быть заполнен для клиент/сервера Firebird | |
| 220 | 226 | Fire.DatabaseName := DatabaseFile; //(путь и ) имя файла | |
| 221 | 227 | // Имя пользователя и пароль не имеют значения для аутентификации, но вы получаете авторизацию в базе данных | |
| 222 | 228 | // на основе имени (и, возможно, роли), которое вы даете. | |
| 223 | 229 | Fire.Username := 'SYSDBA'; | |
| 224 | 230 | Fire.Password := 'masterkey'; //пароль для SYSDBA по умолчанию | |
| 225 | 231 | Fire.Charset := 'UTF8'; //Отправка и получение строковых данных в кодировке UTF8 | |
| 226 | 232 | Fire.Dialect := 3; //Никто больше не использует диалекты 1 или 2 (прим.перев.: это справедливо лишь в отношении новых проектов) | |
| 227 | 233 | Fire.Params.Add('PAGE_SIZE=16384'); //Мне нравится большой размер страницы (используется при создании базы данных). Полезно для больших индексов ⇒ больший возможный размер столбца | |
| 228 | 234 | // Выясните, есть ли база данных в каталоге приложения. | |
| 229 | 235 | // Если нет, создайте его. Примечание: это может не сработать, если у вас недостаточно прав. | |
| 230 | 236 | ||
| 231 | 237 | // Если вы используете клиент / сервер, вам явно не нужна эта часть кода. | |
| 232 | 238 | if (not FileExists(DatabaseFile)) then | |
| 233 | 239 | begin | |
| 234 | 240 | writeln('Файл '+DatabaseFile+' не существует.'); | |
| 235 | 241 | writeln('Создание базы данных Firebird embedded ...'); | |
| 236 | 242 | // Создаем базу данных, поскольку она не существует | |
| 237 | 243 | try | |
| 238 | 244 | Fire.CreateDB; //Создаем файл базы данных. | |
| 239 | 245 | except | |
| 240 | 246 | on E: Exception do | |
| 241 | 247 | begin | |
| 242 | 248 | writeln('ОШИБКА при создании базы данных. Возможно проблемы с загрузкой встроенной библиотеки:'); | |
| 243 | 249 | writeln('- не все файлы присутствуют'); | |
| 244 | 250 | writeln('- неправильная архитектура (например, 32 бит вместо 64 бит)'); | |
| 245 | 251 | writeln('Exception message:'); | |
| 246 | 252 | writeln(E.ClassName+'/'+E.Message); | |
| 247 | 253 | end; | |
| 248 | 254 | end; | |
| 249 | 255 | Fire.Close; | |
| 250 | 256 | end; | |
| 251 | 257 | finally | |
| 252 | 258 | Fire.Free; | |
| 253 | 259 | end; | |
| 254 | 260 | end. | |
| 255 | 261 | ``` | |
| 256 | 262 | ||
| 257 | 263 | ### Запуск набора тестов | |
| 258 | 264 | ||
| 259 | 265 | Наконец, скомпилируйте и запустите *dbtestframework.pas* программы тестирования базы данных. Он должен генерировать вывод состояния на консоли и вывод XML в файлах с результатами теста, которые можно проанализировать и отправить разработчикам. | |
| 260 | 266 | ||
| 261 | 267 | ## Внешние ссылки | |
| 262 | 268 | ||
| 263 | 269 | - [Как настроить embedded Firebird для Linux или Mac?](http://www.firebirdfaq.org/faq51/) (англ.) | |
| 264 | 270 | - [Более ранняя версия embedded Firebird на Linux](http://www.mwasoftware.co.uk/index.php?option=com_content&task=view&id=105)(англ.) | |
| 265 | 271 | ||
| 266 | 272 | --- | |
| 267 | 273 | *From the Free Pascal wiki, page "Firebird embedded/ru", as it stood on 2020-01-26 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).* |
