← Back to branch summary

~ubuntu-branches/ubuntu/karmic/firebird2.1/karmic

« back to all changes in this revision

Viewing changes to doc/Firebird_conf.txt

  • Committer: Bazaar Package Importer
  • Author(s): Damyan Ivanov
  • Date: 2008-05-26 23:59:25 UTC
  • Revision ID: james.westby@ubuntu.com-20080526235925-2pnqj6nxpppoeaer
Tags: upstream-2.1.0.17798-0.ds2
Import upstream version 2.1.0.17798-0.ds2

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/Firebird_conf.txt
 
1
firebird.conf
 
2
=============
 
3
 
 
4
Firebird configuration can be changed by entries in the firebird.conf.
 
5
 
 
6
Depending on operating system this file is found in a little
 
7
bit of different ways.
 
8
 
 
9
 
 
10
Windows
 
11
-------
 
12
On Windows this file is located by first looking inside the registry
 
13
for a string value specifying the directory of firebird.conf:
 
14
 
 
15
HKEY_LOCAL_MACHINE\SOFTWARE\Firebird Project\Firebird Server\Instances\DefaultInstance
 
16
 
 
17
If this value is not present, it assumes firebird.conf is placed in the
 
18
directory directly above the fbserver.exe. If fbserver.exe is placed as
 
19
 
 
20
         C:\Program Files\Firebird\bin\fbserver.exe
 
21
 
 
22
then the firebird.conf file is
 
23
 
 
24
        C:\Program Files\Firebird\firebird.conf
 
25
 
 
26
 
 
27
POSIX (excluding Darwin/Mac OS X)
 
28
---------------------------------
 
29
For POSIX systems it first tries the "directory above" approach,
 
30
described above. If that fails (note: how could this be???) it
 
31
then tries to find the directory from the environment variable
 
32
FIREBIRD.
 
33
If that fails, it tries to find it inside "/usr/local/firebird".
 
34
 
 
35
Darwin
 
36
------
 
37
Darwin on the other hand first checks the environment variable
 
38
FIREBIRD. If not found, it [... John, please describe the "bundle"
 
39
stuff here].
 
40
As a last resort it too falls back to "/usr/local/firebird".
 
41
 
 
42
 
 
43
Syntax of firebird.conf
 
44
=======================
 
45
 
 
46
Comments
 
47
--------
 
48
The # character is used for comments and can be placed anywhere on a line.
 
49
Anything following the # character on a line is considered a comment.
 
50
Examples:
 
51
 
 
52
# This is a comment
 
53
DefaultDbCachePages = 2048   # This is an end-of-line comment
 
54
 
 
55
 
 
56
Configuration settings
 
57
----------------------
 
58
 
 
59
Configuration settings are placed one at each line, followed by zero or
 
60
more whitespace (tab or space) characters, a '=' character, followed by
 
61
again any number of whitespace, followed by the configuration value.
 
62
 
 
63
Example:
 
64
 
 
65
DefaultDbCachePages=2048
 
66
CpuAffinityMask    =  2  # only run on second CPU
 
67
 
 
68
Configuration settings can also be indented on a line by any number of
 
69
tabs or spaces. Example:
 
70
 
 
71
    DefaultDbCachePages = 2048  # This is also a legal config setting
 
72
 
 
73
 
 
74
 
 
75
There are as of this writing, 28 Feb. 2003, 35 user settings. Not all
 
76
settings apply to all operating systems.
 
77
 
 
78
 
 
79
There are three types of configuration values: integer, boolean and string.
 
80
 
 
81
 
 
82
Integers
 
83
--------
 
84
Integers is what they sound like, an integral value. Examples:
 
85
  1
 
86
  42
 
87
  4711
 
88
 
 
89
Boolean
 
90
-------
 
91
Boolean is expressed as integer values with 0 being "false" and
 
92
anything != 0 is taken to mean "true". For consistency we recommend
 
93
you only use 0/1
 
94
 
 
95
String
 
96
------
 
97
Strings are also what they sound like, strings. Examples:
 
98
RootDirectory  = /opt/firebird
 
99
RemotePipeName = "pipe47"
 
100
 
 
101
 
 
102
Configuration options
 
103
---------------------
 
104
 
 
105
RootDirectory              string
 
106
 
 
107
SortMemBlockSize           integer  default 1048576 (1 MB)
 
108
 
 
109
SortMemUpperLimit          integer
 
110
Defaults: Superserver (SS), 67108864 (64 MB). Classic server (CS), 0.
 
111
 
 
112
RemoteFileOpenAbility      boolean  default false.
 
113
(experimental?) Allow DB files used over NFS mounts.
 
114
 
 
115
GuardianOption             integer  default 1
 
116
Affects the operation of the guardian:
 
117
0 - only start the Firebird service once.
 
118
1 - restart the Firebird service if it should terminate.
 
119
 
 
120
CpuAffinityMask            integer  default 1
 
121
A bit-field defining what CPU's the process should be allowed to run on.
 
122
Only meaningful for Windows SS on SMP systems.
 
123
 
 
124
OldParameterOrdering       boolean  default false
 
125
TcpRemoteBufferSize        integer  default 8192 (bytes)
 
126
TcpNoNagle                 boolean  default false
 
127
IpcMapSize                 integer  default 4096 (bytes)
 
128
DefaultDbCachePages        integer  default SS: 2048. CS: 75
 
129
ConnectionTimeout          integer  default 180 (seconds)
 
130
DummyPacketInterval        integer  default  60 (seconds)
 
131
LockMemSize                integer  default 262144 (256 KB)
 
132
LockSemCount               integer  default SINIX-Z: 25. All others: 32
 
133
LockSignal                 integer  default 16 (signal # - (only used on POSIX CS?))
 
134
LockGrantOrder             boolean  default true
 
135
LockHashSlots              integer  default 101
 
136
LockRequireSpins           boolean  default false
 
137
EventMemSize               integer  default 65536
 
138
DeadlockTimeout            integer  default 10 (seconds)
 
139
SolarisStallValue          integer  default 60 (seconds)
 
140
TraceMemoryPools           boolean  default false
 
141
PrioritySwitchDelay        integer  default 100 (milliseconds)
 
142
DeadThreadsCollection      integer  default 50
 
143
PriorityBoost              integer  default 5
 
144
RemoteServiceName          string   default gds_db
 
145
RemoteServicePort          integer  default 3050 (TCP port number)
 
146
RemotePipeName             string   default "interbas" (Windows only?)
 
147
IpcName                    string   default "FirebirdIPI" (Windows only)
 
148
 
 
149
MaxUnflushedWrites         integer
 
150
# of writes before file writes are forcibly synched.
 
151
Windows default: 100. All else -1 (i.e. don't forcibly synch)
 
152
 
 
153
MaxUnflushedWriteTime      integer
 
154
Windows default:   5. All else -1 (i.e. don't forcibly synch)
 
155
 
 
156
ProcessPriorityLevel       integer  default 0 - meaning depends on system.
 
157
CreateInternalWindow       boolean  default true
 
158
Windows only. Tells if the Firebird server should create a (hidden) window
 
159
(used for IPC?) or not.
 
160
 
 
161
CompleteBooleanEvaluation  boolean  default off
 
162
 
 
163
Controls whether full evaluation of OR and AND statements is performed.
 
164
If your SQL code depends on side-effects of full evaluation of
 
165
right-hand-side terms, even if the expressions final result could
 
166
be determined by just examining the value of the first term, you
 
167
might need to turn this on.