Debian Codegraph @

doc/README.user.embedded

raw
1 -----------------------------------------------------------
2 Firebird 3.0 Embedded Server notes
3 -----------------------------------------------------------
4
5 1. GENERIC INFORMATION
6
7 The embedded server is a fully functional server linked
8 as a dynamic library (fbembed.dll). It has exactly the
9 same features as the usual server and exports the
10 standard Firebird API entrypoints.
11
12 2. ISSUES AND LIMITATIONS
13
14 2.1. Registry
15
16 The Firebird registry entries are ignored. The root
17 directory of the embedded server is the directory of
18 its binary file (library).
19
20 2.2. Database access
21
22 Client access can be only via the local protocol,
23 i.e. NOT a TCP/IP connection string that includes
24 the server name "localhost" or IP address 127.0.0.1.
25
26 The embedded server supports only the local connection
27 to a database file path without a server name.
28
29 The database file can be accessed by multiple client
30 programs. The database consistency in this case is
31 guaranteed internally (by the shared lock table).
32
33 The embedded server acts as a true local server for a single
34 client accessing databases on a local machine. It can also
35 act as a remote gateway that redirects all network calls to
36 other hosts, just as the regular client library does.
37
38 2.3. Authentication and security
39
40 The security database (namely security2.fdb) is not used
41 in the embedded server and hence is not required. Any
42 user is able to attach to any database. Since both
43 the server and the client run in the same address space,
44 the security becomes just an agreement between both
45 sides which can be easily compromised.
46
47 But note that SQL privileges are still checked.
48
49 2.4. Compatibility
50
51 You may run any number of applications with the embedded
52 server without any conflicts. Having IB/FB server running
53 is not a problem either.
54
55 3. USAGE
56
57 Just copy fbembed.dll, icudt30.dll, icuin30.dll and
58 icuuc30.dll into the directory with your application.
59 Then rename fbembed.dll to either fbclient.dll or
60 gds32.dll depending on your database connectivity software.
61 Then start your application and it will use the embedded
62 server as a client library and will be able to access
63 local datasases. You should also copy firebird.msg and
64 firebird.conf (if necessary) to the same directory.
65
66 If external libraries are required for your application,
67 then you should have them separately. Most probably, it
68 will be INTL support (fbintl.dll and fbintl.conf) or UDF
69 libraries. To be able to use them, you should place them
70 into the directory tree which emulates the Firebird server
71 one, i.e. has subdirectories like /intl or /udf:
72
73 c:\my_app\app.exe
74 c:\my_app\gds32.dll
75 c:\my_app\ib_util.dll
76 c:\my_app\icudt30.dll
77 c:\my_app\icuin30.dll
78 c:\my_app\icuuc30.dll
79 c:\my_app\firebird.conf
80 c:\my_app\firebird.msg
81 c:\my_app\intl\fbintl.dll
82 c:\my_app\intl\fbintl.conf
83 c:\my_app\udf\fbudf.dll
84
85 If you want to place the Firebird files (excluding the
86 renamed fbembed.dll) in another directory, you need to
87 modify your firebird.conf and set RootDirectory to the
88 Firebird directory tree. Example:
89
90 c:\my_app\app.exe
91 c:\my_app\gds32.dll
92 c:\my_app\ib_util.dll
93 c:\my_app\icudt30.dll
94 c:\my_app\icuin30.dll
95 c:\my_app\icuuc30.dll
96 c:\my_app\firebird.conf
97 d:\fb\firebird.msg
98 d:\fb\intl\fbintl.dll
99 c:\fb\intl\fbintl.conf
100 d:\fb\udf\fbudf.dll
101
102 firebird.conf:
103 RootDirectory = d:\fb