1 |
{************************************************************************} |
2 |
{ } |
3 |
{ Borland Delphi Visual Component Library } |
4 |
{ InterBase Express core components } |
5 |
{ } |
6 |
{ Copyright (c) 1998-2000 Inprise Corporation } |
7 |
{ } |
8 |
{ InterBase Express is based in part on the product } |
9 |
{ Free IB Components, written by Gregory H. Deatz for } |
10 |
{ Hoagland, Longo, Moran, Dunst & Doukas Company. } |
11 |
{ Free IB Components is used under license. } |
12 |
{ } |
13 |
{ The contents of this file are subject to the InterBase } |
14 |
{ Public License Version 1.0 (the "License"); you may not } |
15 |
{ use this file except in compliance with the License. You } |
16 |
{ may obtain a copy of the License at http://www.Inprise.com/IPL.html } |
17 |
{ Software distributed under the License is distributed on } |
18 |
{ an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either } |
19 |
{ express or implied. See the License for the specific language } |
20 |
{ governing rights and limitations under the License. } |
21 |
{ Portions created by Inprise Corporation are Copyright (C) Inprise } |
22 |
{ Corporation. All Rights Reserved. } |
23 |
{ Contributor(s): Jeff Overcash } |
24 |
{ } |
25 |
{ IBX For Lazarus (Firebird Express) } |
26 |
{ Contributor: Tony Whyman, MWA Software http://www.mwasoftware.co.uk } |
27 |
{ Portions created by MWA Software are copyright McCallum Whyman } |
28 |
{ Associates Ltd 2011 - 2018 } |
29 |
{ } |
30 |
{************************************************************************} |
31 |
|
32 |
unit IBDatabaseInfo; |
33 |
|
34 |
{$Mode Delphi} |
35 |
|
36 |
interface |
37 |
|
38 |
uses |
39 |
SysUtils, Classes, IB, IBExternals, IBDatabase; |
40 |
|
41 |
type |
42 |
|
43 |
{ TIBDatabaseInfo } |
44 |
|
45 |
TIBDatabaseInfo = class(TComponent) |
46 |
private |
47 |
function GetDateDBCreated: TDateTime; |
48 |
function GetEncrypted: boolean; |
49 |
function GetEncryptionKeyName: string; |
50 |
function GetPagesFree: Long; |
51 |
function GetPagesUsed: Long; |
52 |
function GetTransactionCount: Long; |
53 |
protected |
54 |
FDatabase: TIBDatabase; |
55 |
FUserNames : TStringList; |
56 |
FBackoutCount: TStringList; |
57 |
FDeleteCount: TStringList; |
58 |
FExpungeCount: TStringList; |
59 |
FInsertCount: TStringList; |
60 |
FPurgeCount: TStringList; |
61 |
FReadIdxCount: TStringList; |
62 |
FReadSeqCount: TStringList; |
63 |
FUpdateCount: TStringList; |
64 |
procedure CheckDatabase; |
65 |
function GetAllocation: Long; |
66 |
function GetBaseLevel: Long; |
67 |
function GetDBFileName: String; |
68 |
function GetDBSiteName: String; |
69 |
function GetDBImplementationNo: Long; |
70 |
function GetDBImplementationClass: Long; |
71 |
function GetNoReserve: Long; |
72 |
function GetODSMinorVersion: Long; |
73 |
function GetODSMajorVersion: Long; |
74 |
function GetPageSize: Long; |
75 |
function GetVersion: String; |
76 |
function GetCurrentMemory: Long; |
77 |
function GetForcedWrites: Long; |
78 |
function GetMaxMemory: Long; |
79 |
function GetNumBuffers: Long; |
80 |
function GetSweepInterval: Long; |
81 |
function GetUserNames: TStringList; |
82 |
function GetFetches: Long; |
83 |
function GetMarks: Long; |
84 |
function GetReads: Long; |
85 |
function GetWrites: Long; |
86 |
function GetBackoutCount: TStringList; |
87 |
function GetDeleteCount: TStringList; |
88 |
function GetExpungeCount: TStringList; |
89 |
function GetInsertCount: TStringList; |
90 |
function GetPurgeCount: TStringList; |
91 |
function GetReadIdxCount: TStringList; |
92 |
function GetReadSeqCount: TStringList; |
93 |
function GetUpdateCount: TStringList; |
94 |
function GetOperationCounts(DBInfoCommand: Integer; var FOperation: TStringList): TStringList; |
95 |
function GetReadOnly: Long; |
96 |
function GetStringDatabaseInfo(DatabaseInfoCommand: Integer): String; |
97 |
function GetDBSQLDialect: Long; |
98 |
public |
99 |
constructor Create(AOwner: TComponent); override; |
100 |
destructor Destroy; override; |
101 |
function GetLongDatabaseInfo(DatabaseInfoCommand: Integer): Long; |
102 |
function GetDatabasePage(PageNo: integer): string; |
103 |
property Allocation: Long read GetAllocation; |
104 |
property BaseLevel: Long read GetBaseLevel; |
105 |
property DateDBCreated: TDateTime read GetDateDBCreated; |
106 |
property DBFileName: String read GetDBFileName; |
107 |
property DBSiteName: String read GetDBSiteName; |
108 |
property DBImplementationNo: Long read GetDBImplementationNo; |
109 |
property DBImplementationClass: Long read GetDBImplementationClass; |
110 |
property Encrypted: boolean read GetEncrypted; |
111 |
property EncryptionKeyName: string read GetEncryptionKeyName; |
112 |
property NoReserve: Long read GetNoReserve; |
113 |
property ODSMinorVersion: Long read GetODSMinorVersion; |
114 |
property ODSMajorVersion: Long read GetODSMajorVersion; |
115 |
property PageSize: Long read GetPageSize; |
116 |
property Version: String read GetVersion; |
117 |
property CurrentMemory: Long read GetCurrentMemory; |
118 |
property ForcedWrites: Long read GetForcedWrites; |
119 |
property MaxMemory: Long read GetMaxMemory; |
120 |
property NumBuffers: Long read GetNumBuffers; |
121 |
property SweepInterval: Long read GetSweepInterval; |
122 |
property UserNames: TStringList read GetUserNames; |
123 |
property Fetches: Long read GetFetches; |
124 |
property Marks: Long read GetMarks; |
125 |
property Reads: Long read GetReads; |
126 |
property Writes: Long read GetWrites; |
127 |
property TransactionCount: Long read GetTransactionCount; |
128 |
property BackoutCount: TStringList read GetBackoutCount; |
129 |
property DeleteCount: TStringList read GetDeleteCount; |
130 |
property ExpungeCount: TStringList read GetExpungeCount; |
131 |
property InsertCount: TStringList read GetInsertCount; |
132 |
property PurgeCount: TStringList read GetPurgeCount; |
133 |
property ReadIdxCount: TStringList read GetReadIdxCount; |
134 |
property ReadSeqCount: TStringList read GetReadSeqCount; |
135 |
property UpdateCount: TStringList read GetUpdateCount; |
136 |
property DBSQLDialect : Long read GetDBSQLDialect; |
137 |
property PagesUsed: Long read GetPagesUsed; |
138 |
property PagesFree: Long read GetPagesFree; |
139 |
property ReadOnly: Long read GetReadOnly; |
140 |
published |
141 |
property Database: TIBDatabase read FDatabase write FDatabase; |
142 |
end; |
143 |
|
144 |
implementation |
145 |
|
146 |
uses |
147 |
FBMessages; |
148 |
|
149 |
{ TIBDatabaseInfo } |
150 |
|
151 |
constructor TIBDatabaseInfo.Create(AOwner: TComponent); |
152 |
begin |
153 |
inherited Create(AOwner); |
154 |
FUserNames := TStringList.Create; |
155 |
FBackoutCount := nil; |
156 |
FDeleteCount := nil; |
157 |
FExpungeCount := nil; |
158 |
FInsertCount := nil; |
159 |
FPurgeCount := nil; |
160 |
FReadIdxCount := nil; |
161 |
FReadSeqCount := nil; |
162 |
FUpdateCount := nil; |
163 |
end; |
164 |
|
165 |
destructor TIBDatabaseInfo.Destroy; |
166 |
begin |
167 |
if assigned(FUserNames) then FUserNames.Free; |
168 |
if assigned(FBackoutCount) then FBackoutCount.Free; |
169 |
if assigned(FDeleteCount) then FDeleteCount.Free; |
170 |
if assigned(FExpungeCount) then FExpungeCount.Free; |
171 |
if assigned(FInsertCount) then FInsertCount.Free; |
172 |
if assigned(FPurgeCount) then FPurgeCount.Free; |
173 |
if assigned(FReadIdxCount) then FReadIdxCount.Free; |
174 |
if assigned(FReadSeqCount) then FReadSeqCount.Free; |
175 |
if assigned(FUpdateCount) then FUpdateCount.Free; |
176 |
inherited Destroy; |
177 |
end; |
178 |
|
179 |
function TIBDatabaseInfo.GetDateDBCreated: TDateTime; |
180 |
begin |
181 |
CheckDatabase; |
182 |
with Database.Attachment.GetDBInformation([isc_info_creation_date]) do |
183 |
if (Count > 0) and (Items[0].GetItemType = isc_info_creation_date) then |
184 |
Result := Items[0].GetAsDateTime |
185 |
else |
186 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
187 |
end; |
188 |
|
189 |
function TIBDatabaseInfo.GetEncrypted: boolean; |
190 |
var ConnFlags: Long; |
191 |
begin |
192 |
Result := ODSMajorVersion >= 12; |
193 |
if Result then |
194 |
try |
195 |
ConnFlags := GetLongDatabaseInfo(fb_info_conn_flags); |
196 |
Result := (ConnFlags and fb_info_crypt_encrypted) <> 0; |
197 |
except |
198 |
Result := false; {Introduced in Firebird 3.0.3} |
199 |
end; |
200 |
end; |
201 |
|
202 |
function TIBDatabaseInfo.GetEncryptionKeyName: string; |
203 |
begin |
204 |
CheckDatabase; |
205 |
{Introduced in Firebird 3.0.3} |
206 |
with Database.Attachment.GetDBInformation([fb_info_crypt_key]) do |
207 |
if (Count > 0) and (Items[0].GetItemType = fb_info_crypt_key) then |
208 |
Result := Items[0].AsString |
209 |
else |
210 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
211 |
end; |
212 |
|
213 |
function TIBDatabaseInfo.GetPagesFree: Long; |
214 |
begin |
215 |
result := GetLongDatabaseInfo(fb_info_pages_used); |
216 |
end; |
217 |
|
218 |
function TIBDatabaseInfo.GetPagesUsed: Long; |
219 |
begin |
220 |
result := GetLongDatabaseInfo(fb_info_pages_free); |
221 |
end; |
222 |
|
223 |
function TIBDatabaseInfo.GetTransactionCount: Long; |
224 |
begin |
225 |
result := GetLongDatabaseInfo(isc_info_active_tran_count); |
226 |
end; |
227 |
|
228 |
procedure TIBDatabaseInfo.CheckDatabase; |
229 |
begin |
230 |
if Database = nil then |
231 |
IBError(ibxeDatabaseNotAssigned,[]); |
232 |
if Database.Attachment = nil then |
233 |
IBError(ibxeDatabaseClosed,[]); |
234 |
end; |
235 |
|
236 |
function TIBDatabaseInfo.GetAllocation: Long; |
237 |
begin |
238 |
result := GetLongDatabaseInfo(isc_info_allocation); |
239 |
end; |
240 |
|
241 |
function TIBDatabaseInfo.GetBaseLevel: Long; |
242 |
var Response: TByteArray; |
243 |
begin |
244 |
CheckDatabase; |
245 |
with Database.Attachment.GetDBInformation([isc_info_base_level]) do |
246 |
if (Count > 0) and (Items[0].GetItemType = isc_info_base_level) then |
247 |
begin |
248 |
Response := Items[0].GetAsBytes; |
249 |
Result := Response[1]; |
250 |
end |
251 |
else |
252 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
253 |
end; |
254 |
|
255 |
function TIBDatabaseInfo.GetDBFileName: String; |
256 |
var |
257 |
ConnectionType: integer; |
258 |
SiteName: string; |
259 |
begin |
260 |
CheckDatabase; |
261 |
with Database.Attachment.GetDBInformation([isc_info_db_id]) do |
262 |
if (Count > 0) and (Items[0].GetItemType = isc_info_db_id) then |
263 |
Items[0].DecodeIDCluster(ConnectionType,Result,SiteName) |
264 |
else |
265 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
266 |
end; |
267 |
|
268 |
function TIBDatabaseInfo.GetDBSiteName: String; |
269 |
var |
270 |
ConnectionType: integer; |
271 |
FileName: string; |
272 |
begin |
273 |
CheckDatabase; |
274 |
with Database.Attachment.GetDBInformation([isc_info_db_id]) do |
275 |
if (Count > 0) and (Items[0].GetItemType = isc_info_db_id) then |
276 |
Items[0].DecodeIDCluster(ConnectionType,FileName,Result) |
277 |
else |
278 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
279 |
end; |
280 |
|
281 |
function TIBDatabaseInfo.GetDBImplementationNo: Long; |
282 |
var Response: TByteArray; |
283 |
begin |
284 |
CheckDatabase; |
285 |
with Database.Attachment.GetDBInformation([isc_info_implementation]) do |
286 |
if (Count > 0) and (Items[0].GetItemType = isc_info_implementation) then |
287 |
begin |
288 |
Response := Items[0].GetAsBytes; |
289 |
Result := Response[1]; |
290 |
end |
291 |
else |
292 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
293 |
end; |
294 |
|
295 |
function TIBDatabaseInfo.GetDBImplementationClass: Long; |
296 |
var Response: TByteArray; |
297 |
begin |
298 |
CheckDatabase; |
299 |
with Database.Attachment.GetDBInformation([isc_info_implementation]) do |
300 |
if (Count > 0) and (Items[0].GetItemType = isc_info_implementation) then |
301 |
begin |
302 |
Response := Items[0].GetAsBytes; |
303 |
Result := Response[2]; |
304 |
end |
305 |
else |
306 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
307 |
end; |
308 |
|
309 |
function TIBDatabaseInfo.GetNoReserve: Long; |
310 |
begin |
311 |
result := GetLongDatabaseInfo(isc_info_no_reserve); |
312 |
end; |
313 |
|
314 |
function TIBDatabaseInfo.GetODSMinorVersion: Long; |
315 |
begin |
316 |
CheckDatabase; |
317 |
Result := Database.Attachment.GetODSMinorVersion; |
318 |
end; |
319 |
|
320 |
function TIBDatabaseInfo.GetODSMajorVersion: Long; |
321 |
begin |
322 |
CheckDatabase; |
323 |
Result := Database.Attachment.GetODSMajorVersion; |
324 |
end; |
325 |
|
326 |
function TIBDatabaseInfo.GetPageSize: Long; |
327 |
begin |
328 |
result := GetLongDatabaseInfo(isc_info_page_size); |
329 |
end; |
330 |
|
331 |
function TIBDatabaseInfo.GetVersion: String; |
332 |
var Version: byte; |
333 |
begin |
334 |
CheckDatabase; |
335 |
with Database.Attachment.GetDBInformation([isc_info_version]) do |
336 |
if (Count > 0) and (Items[0].GetItemType = isc_info_version) then |
337 |
Items[0].DecodeVersionString(Version,Result) |
338 |
else |
339 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
340 |
end; |
341 |
|
342 |
function TIBDatabaseInfo.GetCurrentMemory: Long; |
343 |
begin |
344 |
result := GetLongDatabaseInfo(isc_info_current_memory); |
345 |
end; |
346 |
|
347 |
function TIBDatabaseInfo.GetForcedWrites: Long; |
348 |
begin |
349 |
result := GetLongDatabaseInfo(isc_info_forced_writes); |
350 |
end; |
351 |
|
352 |
function TIBDatabaseInfo.GetMaxMemory: Long; |
353 |
begin |
354 |
result := GetLongDatabaseInfo(isc_info_max_memory); |
355 |
end; |
356 |
|
357 |
function TIBDatabaseInfo.GetNumBuffers: Long; |
358 |
begin |
359 |
result := GetLongDatabaseInfo(isc_info_num_buffers); |
360 |
end; |
361 |
|
362 |
function TIBDatabaseInfo.GetSweepInterval: Long; |
363 |
begin |
364 |
result := GetLongDatabaseInfo(isc_info_sweep_interval); |
365 |
end; |
366 |
|
367 |
function TIBDatabaseInfo.GetUserNames: TStringList; |
368 |
begin |
369 |
CheckDatabase; |
370 |
Result := FUserNames; |
371 |
FUserNames.Clear; |
372 |
with Database.Attachment.GetDBInformation([isc_info_user_names]) do |
373 |
if (Count > 0) and (Items[0].GetItemType = isc_info_user_names) then |
374 |
Items[0].DecodeUserNames(Result) |
375 |
else |
376 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
377 |
end; |
378 |
|
379 |
function TIBDatabaseInfo.GetFetches: Long; |
380 |
begin |
381 |
result := GetLongDatabaseInfo(isc_info_fetches); |
382 |
end; |
383 |
|
384 |
function TIBDatabaseInfo.GetMarks: Long; |
385 |
begin |
386 |
result := GetLongDatabaseInfo(isc_info_marks); |
387 |
end; |
388 |
|
389 |
function TIBDatabaseInfo.GetReads: Long; |
390 |
begin |
391 |
result := GetLongDatabaseInfo(isc_info_reads); |
392 |
end; |
393 |
|
394 |
function TIBDatabaseInfo.GetWrites: Long; |
395 |
begin |
396 |
result := GetLongDatabaseInfo(isc_info_writes); |
397 |
end; |
398 |
|
399 |
function TIBDatabaseInfo.GetOperationCounts(DBInfoCommand: Integer; |
400 |
var FOperation: TStringList): TStringList; |
401 |
var opCounts: TDBOperationCounts; |
402 |
i: integer; |
403 |
begin |
404 |
CheckDatabase; |
405 |
if FOperation = nil then FOperation := TStringList.Create; |
406 |
result := FOperation; |
407 |
with Database.Attachment.GetDBInformation([DBInfoCommand]) do |
408 |
if (Count > 0) and (Items[0].GetItemType = DBInfoCommand) then |
409 |
opCounts := Items[0].getOperationCounts |
410 |
else |
411 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
412 |
for i := 0 to Length(opCounts) - 1 do |
413 |
FOperation.Add(IntToStr(opCounts[i].TableID) +'='+IntToStr(opCounts[i].Count)); |
414 |
end; |
415 |
|
416 |
function TIBDatabaseInfo.GetBackoutCount: TStringList; |
417 |
begin |
418 |
result := GetOperationCounts(isc_info_backout_count,FBackoutCount); |
419 |
end; |
420 |
|
421 |
function TIBDatabaseInfo.GetDeleteCount: TStringList; |
422 |
begin |
423 |
result := GetOperationCounts(isc_info_delete_count,FDeleteCount); |
424 |
end; |
425 |
|
426 |
function TIBDatabaseInfo.GetExpungeCount: TStringList; |
427 |
begin |
428 |
result := GetOperationCounts(isc_info_expunge_count,FExpungeCount); |
429 |
end; |
430 |
|
431 |
function TIBDatabaseInfo.GetInsertCount: TStringList; |
432 |
begin |
433 |
result := GetOperationCounts(isc_info_insert_count,FInsertCount); |
434 |
end; |
435 |
|
436 |
function TIBDatabaseInfo.GetPurgeCount: TStringList; |
437 |
begin |
438 |
result := GetOperationCounts(isc_info_purge_count,FPurgeCount); |
439 |
end; |
440 |
|
441 |
function TIBDatabaseInfo.GetReadIdxCount: TStringList; |
442 |
begin |
443 |
result := GetOperationCounts(isc_info_read_idx_count,FReadIdxCount); |
444 |
end; |
445 |
|
446 |
function TIBDatabaseInfo.GetReadSeqCount: TStringList; |
447 |
begin |
448 |
result := GetOperationCounts(isc_info_read_seq_count,FReadSeqCount); |
449 |
end; |
450 |
|
451 |
function TIBDatabaseInfo.GetUpdateCount: TStringList; |
452 |
begin |
453 |
result := GetOperationCounts(isc_info_update_count,FUpdateCount); |
454 |
end; |
455 |
|
456 |
function TIBDatabaseInfo.GetReadOnly: Long; |
457 |
begin |
458 |
result := GetLongDatabaseInfo(isc_info_db_read_only); |
459 |
end; |
460 |
|
461 |
function TIBDatabaseInfo.GetLongDatabaseInfo(DatabaseInfoCommand: Integer): Long; |
462 |
begin |
463 |
CheckDatabase; |
464 |
with Database.Attachment.GetDBInformation([DatabaseInfoCommand]) do |
465 |
if (Count > 0) and (Items[0].GetItemType = DatabaseInfoCommand) then |
466 |
Result := Items[0].AsInteger |
467 |
else |
468 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
469 |
end; |
470 |
|
471 |
function TIBDatabaseInfo.GetDatabasePage(PageNo: integer): string; |
472 |
var DBRequest: IDIRB; |
473 |
begin |
474 |
DBRequest := Database.Attachment.AllocateDIRB; |
475 |
DBRequest.Add(fb_info_page_contents).AsInteger := PageNo; |
476 |
with Database.Attachment.GetDBInformation(DBRequest) do |
477 |
if (Count > 0) and (Items[0].GetItemType = fb_info_page_contents) then |
478 |
Result := Items[0].AsString |
479 |
else |
480 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
481 |
end; |
482 |
|
483 |
function TIBDatabaseInfo.GetStringDatabaseInfo(DatabaseInfoCommand: Integer): String; |
484 |
begin |
485 |
CheckDatabase; |
486 |
with Database.Attachment.GetDBInformation([DatabaseInfoCommand]) do |
487 |
if (Count > 0) and (Items[0].GetItemType = DatabaseInfoCommand) then |
488 |
Result := Items[0].AsString |
489 |
else |
490 |
IBError(ibxeUnexpectedDatabaseInfoResp,[nil]); |
491 |
end; |
492 |
|
493 |
|
494 |
function TIBDatabaseInfo.GetDBSQLDialect: Long; |
495 |
begin |
496 |
CheckDatabase; |
497 |
with Database.Attachment.GetDBInformation([isc_info_db_SQL_Dialect]) do |
498 |
if (Count > 0) and (Items[0].GetItemType = isc_info_db_SQL_Dialect) then |
499 |
Result := Items[0].AsInteger |
500 |
else |
501 |
Result := 1; |
502 |
end; |
503 |
|
504 |
|
505 |
end. |