ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/trunk/fbintf/changelog
Revision: 434
Committed: Wed Mar 20 11:31:00 2024 UTC (5 weeks, 2 days ago) by tony
File size: 37997 byte(s)
Log Message:
Fix legacy interface issues with FB4

File Contents

# Content
1 FBINTF Change Log version (1.4-2 Build 14340) Wed, 20 Mar 2024 11:13:10 +0000
2
3 1. IBUtils.FormatTimeZoneOffset A zero offset now includes a preceding '+' sign.
4
5 2. TFBStatement.DoJournaling now exits immediately if journaling is not active. The
6 motivation for this is to avoid calling the Firebird API function 'getInfo'
7 unnecesarily. This function can return an error if an incompatible parameter type was
8 applied to the statement and hence can confuse resolving the bug. Note: a
9 specific case is in (e.g.) OpenCursorAtStart method when the array of const includes a
10 TDateTime. In this case, the param is set to a floating point type rather than
11 a Firebird datetime (array of const loses the distinction).
12
13 3. TFBAttachment.SetParameters. if an attempt is made to set a parameter with a float
14 value, the metadata type is checked to see if the parameter is a Date/Time type. If so then
15 the value is assumed to be a TDateTime and the parameter is set using the AsDateTime
16 property. Otherwise, the value is assumed to be a floating point type and the AsDouble
17 property is used to set the property. This avoids the specific example given above.
18
19 4. IBHeader (legacy interface only) Definition of Start_Transaction changed to use
20 varargs - win64 compatibility issue.
21
22 5. FB25Blob: last parameter of call to isc_blob_lookup_desc is now set to nil. This
23 avoids memory corruption with Firebird 4 when using the legacy interface.
24
25 FBINTF Change Log version (1.4-1 Build 14103) Mon, 27 Nov 2023 14:26:35 +0000
26
27 1. FBSQLData: ensure that TResults.getSQLData and TResults.GetData use same error
28 checks for range checking.
29
30 2. FB25Client: In GetIBMessage, fb_interpret is now called multiple times such that
31 any additional error information is decoded.
32
33 3. FB25Statement: When changing a param type from Blob sub_type 1 to SQL_TEXT or SQL_VARYING
34 charsetid is now preserved and size is set to default blob size. Now aligns with
35 FB3 and later.
36
37 4. DDL and DML string literals are now explicitly set to the connection character
38 set rather than the default character set provided by the compiler.
39
40 5. General tidy up of transliteration functions, now centralised in IBUtils. FPC testing
41 now makes use of the RTL fpwidestring unit for support of international character
42 sets.
43
44 6. Database exception handling (see section 9.3 in user guide).
45 * For FB3 and later API: Connection Character set now applied to message returned
46 by fb_interpret and message then transliterated if necessary to the system character set.
47 * For Legacy API: The message character set is guessed as UTF8 unless invalid
48 UTF8 characters found when connection character set is assumed. Message then
49 transliterated if necessary to system character set.
50 Note: this difference of behaviour is because legacy API presents exception messages
51 "as is", while FB3 server attempts to transliterate to connection character set.
52
53 FBINTF Change Log version (1.4-0 Build 14011) Sat, 05 Aug 2023 11:09:09 +0100
54
55 1. Support package fbudr added for support of User Defined Routines (UDRs), and package
56 fbudrtestbed for client side debugging of UDR libraries.
57
58 2. Package layout changed with introduction of udr support. IB*.pas files moved from
59 root directory to "client". IBHeader moved to "Client".
60
61 3. Delphi packages: all packages now compile .dcp and .bpi files to either
62 fbintf\Win32\Debug or fbintf\Win64\Debug by default. Please remove any pre-existing
63 fbintf.dcp and fbintf.bpi files from other locations.
64
65 4. Client side journaling support added. Interface changes
66 IAttachment
67 function JournalingActive: boolean;
68 function GetJournalOptions: TJournalOptions;
69 function StartJournaling(aJournalLogFile: AnsiString): integer; overload;
70 function StartJournaling(aJournalLogFile: AnsiString; Options: TJournalOptions): integer; overload;
71 function StartJournaling(S: TStream; Options: TJournalOptions): integer; overload;
72 procedure StopJournaling(RetainJournal: boolean);
73
74 5. Transactions may now be given a local transaction name:
75 IFirebirdAPI
76 function StartTransaction(Attachments: array of IAttachment;
77 TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
78 TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit;
79 aName: AnsiString=''): ITransaction; overload;
80 function StartTransaction(Attachments: array of IAttachment;
81 TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
82 TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit;
83 aName: AnsiString=''): ITransaction; overload;
84
85 IAttachment
86 function StartTransaction(TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
87 function StartTransaction(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
88 function StartTransaction(TPB: array of byte;
89 DefaultCompletion: TTransactionCompletion=taCommit;
90 aName: AnsiString=''): ITransaction; overload;
91 function StartTransaction(TPB: ITPB;
92 DefaultCompletion: TTransactionCompletion=taCommit;
93 aName: AnsiString=''): ITransaction; overload;
94
95 ITransaction
96 function GetTransactionName: AnsiString;
97 procedure SetTransactionName(aValue: AnsiString);
98
99 6. Additional Transaction information
100 ITPB.function AsText: AnsiString; {Returns TPB as a text string}
101
102 ITransaction
103 function GetDefaultCompletion: TTransactionCompletion;
104 function GetJournalingActive(attachment: IAttachment): boolean; {attachment must be specified when multi-database transaction}
105
106 7. New IAttachment helper functions
107 function HasTable(aTableName: AnsiString): boolean;
108 function HasFunction(aFunctionName: AnsiString): boolean;
109 function HasProcedure(aProcName: AnsiString): boolean;
110 function GetAttachmentID: integer;
111 function GetCharSetID: integer;
112
113 8. IStatement: if the BatchRowLimit is set to maxint, the maximum possible buffer size
114 will be allocated for batch operations.
115
116 9. IStatement, IColumnMetaData and ISQLParam all now consistently provide:
117 function GetStatement: IStatement;
118 function GetTransaction: ITransaction;
119 function GetAttachment: IAttachment;
120
121 10. Internal: a more disciplined approach to the handling of Firebird.IReferenceCounted
122 interfaces.
123
124 11. New interface type: IFBNumeric. IFBNumeric is implemented in the unit FBNumeric
125 and concentrates all handling of Fixed Point numbers. New ISQLItem and ISQLParam
126 functions getAsNumeric and setAsNumeric allow for direct retrival and manipulation
127 of numerics without loss of precision.
128
129 12. TryStrToNumeric and NumericToDouble moved from IBUtils to FBNumeric.
130
131 13. ISQLParams new method "Clear"
132
133 14. Connection Info (e.g. ODS Version, Remote Protocol) now retrieved on first
134 request rather than on attachment connect.
135
136 15. IStatus.IBDataBaseErrorMessages now defaults to [ShowIBMessage]. This reflects the
137 fact that SQLCodes are soon to be deprecated. In the future, the other options
138 will be silently ignored if SQLCode support is not present in the Firebird
139 Client library.
140
141 16. ITransaction changes Rollback and Commit from procedures to functions:
142 function Commit(Force: boolean=false): TTrCompletionState;
143 function Rollback(Force: boolean=false): TTrCompletionState;
144
145 Specifically, this is to allow the functions to report back a failed commit or
146 rollback when Force = true. In the case, the transaction handle has been
147 released, while the transaction remains in limbo.
148
149 17. IAttachment ExecImmediate.
150 When the transaction parameters are provided as an array of const and the
151 statement fails, the transaction is rolledback (forced) before the exception
152 is raised.
153
154 18. In Firebird 3 and later API: the status vector is now a thread var, as was
155 already the case with the legacy API. Avoids problems when calling underlying
156 Firebird API in multiple threads.
157
158 19. IBUtils: TSQLXMLReader: "string" type changed to "AnsiString" for compatibility
159 reasons.
160
161 20. IDBInformation.DecodeVersionString now supported isc_info_firebird_version.
162
163 21. TSQLXMLReader: handle 'blob' as a reserved word
164
165 22. ISQLParam.SetAsVariant now accepts a vartype of varUString (UnicodeString).
166
167
168 FBINTF Change Log version (1.3-3 Build 12935) Mon, 06 Dec 2021 23:17:13 +0000
169
170 1. Fix compile error with fpc trunk (3.3.1 and later), due to type change to tzname in "unix" unit.
171
172 2. Remove constraint in IAttachment.HasScollableCursors that returned false when
173 using remote protocol. Scrollable cursors with remote database expected to
174 be support for Firebird 4.0.1 onwards. Note: Firebird 4.0.0 will return
175 a not supported error.
176
177 3. IStatement: new function;
178 TStatementFlag = (stHasCursor,stRepeatExecute,stScrollable);
179 TStatementFlags = set of TStatementFlag;
180 function GetFlags: TStatementFlags;
181
182 4. Revised behaviour for IStatement.ExecuteQuery in order to preserve backwards
183 compatibility.
184 In Firebird 5, Update..Returning may returns multiple rows and hence the statemen
185 type changes from ExecProcedure to Select. So that ExecuteQuery can continue
186 to be used with Update...Retruning statements that return a singleton row,
187 instead of raising an exception when ExecuteQuery is used with a (SELECT) statement,
188 it will open the cursor and return the first row only.
189
190 5. ITransaction: new functions:
191 function GetIsReadOnly: boolean;
192 function GetTransactionID: integer;
193 function GetTrInformation(Requests: array of byte): ITrInformation; overload;
194 function GetTrInformation(Request: byte): ITrInformation; overload;
195
196 The latter two return the Transaction Information block. The first two extract
197 information the Transaction Information block
198
199 6. New function TSQLTokeniser.ReadCharacters
200 Used internally.
201
202 7. IStatement: GetProcessedSQL bug fix. No longer raises and error if SQL contains
203 parameter placeholders instead of named parameters.
204
205 8. ITransaction (Firebird 3 and later): An exception raised when freeing an underlying
206 transaction handle is now ignored if Rollback/Commit is called with Force=true
207
208 9. Tidy up of exception handling code. Under the legacy API, fb_interpret is now
209 used to get an IBError Message instead of isc_interprete.
210
211 10. Internal tidyup. Native code now used for decoding integers and the events
212 buffer. Avoids dependencies on fbclient functions isc_portable_integer,
213 isc_event_block and isc_event_counts.
214
215 11. New IAttachment function
216 function GetAttachmentID: integer;
217
218 12. Internal changes to TFBClientAPI, TFBAttachment and TFBTransaction and TFB30
219 subclasses to enable UDR support.
220
221 FBINTF Change Log version (1.3-2 Build 12889) Sun, 24 Oct 2021 13:49:28 +0100
222
223 1. TFBClientAPI.GetProcAddr. Add check for nil reference.
224
225 2. IStatement: new methods:
226 procedure SetStaleReferenceChecks(Enable:boolean); {default true}
227 function GetStaleReferenceChecks: boolean;
228
229 In previous versions, stale reference checks were always enabled. This allows the
230 user to disable them on a per statement basis. Note this can risk out-of-date
231 statement BLR. See User Guide.
232
233 3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
234 stored procedure and hence avoids replacing named parameters within a containing
235 BEGIN..END block.
236
237 4. ISQLParam: using a string value to set an integer field with a scale factor of
238 zero is now treated as a special case to avoid the risk of floating point
239 rounding errors affecting pure integers.
240
241 5. ISQLParam: Review and tidy-up of SetAsString for numeric types.
242
243 6. ISQLParam is now subclassed from IParamMetaData, which provides access to the mutable
244 SQL Parameter metadata (methods moved from ISQLParam).
245
246 7. ISQLParam: new method
247 function getColMetadata: IParamMetaData;
248 This instance of IParamMetaData returns the original column metadata which is unmutable.
249 Note: ISQLParam metadata can change after a parameter value has been set e.g when
250 setting a VARCHAR column to an integer value.
251
252 8. IStatement: can now set cursor name when opening a cursor. New overloaded method:
253 procedure Prepare(CursorName: AnsiString; aTransaction: ITransaction=nil); overload;
254 also IAttachment:
255 function Prepare(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; CursorName: AnsiString=''): IStatement; overload;
256 function Prepare(transaction: ITransaction; sql: AnsiString; CursorName: AnsiString=''): IStatement; overload;
257 function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
258 aSQLDialect: integer; GenerateParamNames: boolean=false;
259 CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
260 function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
261 GenerateParamNames: boolean=false;
262 CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
263
264 9. Support for scrollable cursors added. New/updated methods:
265 IAttachment:
266 function HasScollableCursors: boolean;
267 function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
268 Scrollable: boolean=false): IResultSet; overload;
269 function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
270 function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
271 params: array of const): IResultSet; overload;
272 function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false;
273 params: array of const): IResultSet; overload;
274 function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
275 params: array of const): IResultSet; overload;
276 function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
277 Scrollable: boolean=false): IResultSet; overload;
278 function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
279 function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean;
280 params: array of const): IResultSet; overload;
281 function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
282 function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean;
283 params: array of const): IResultSet; overload;
284 IStatement:
285 function OpenCursor(Scrollable: boolean; CursorName: AnsiString =''; aTransaction: ITransaction=nil): IResultSet; overload;
286 IResultSet:
287 function FetchPrior: boolean; {fetch previous record}
288 function FetchFirst:boolean; {fetch first record}
289 function FetchLast: boolean; {fetch last record}
290 function FetchAbsolute(position: Integer): boolean; {fetch record by its absolute position in result set}
291 function FetchRelative(offset: Integer): boolean; {fetch record by position relative to current}
292 function IsBof: boolean;
293
294 10. IArray: tidyup of SetAsString method to ensure correct handling of fixed point numbers.
295
296 11. IBUtils: TSQLTokeniser. CRLF now combined by low level parser into sqltEOL token. This
297 may be noticeable when a line separator occurs inside quoted text. The quoted text
298 output by the tokeniser will now use the platform specific lineEnding regardless
299 of whether the input uses the CRLF or LF as a line separator.
300
301 12. IStatement, IResultsSet: Support for scrollable cursors added (note: local databases only)
302
303
304 FBINTF Change Log version (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100
305
306 1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.
307
308 2. Support for inline blob encoding. Blob values pass using the "SetAsString" method
309 will now be encoded inline (i.e. as part of the parameter buffer) if they are
310 shorter than a pre-set limit. Longer values continue to be saved as blobs as a
311 separate server interaction. This is intended as a performance optimisation.
312
313 The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new
314 IAttachment interface functions:
315
316 function GetInlineBlobLimit: integer;
317 procedure SetInlineBlobLimit(limit: integer);
318
319 3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API
320 user as the functionality is embedded in the implementation of the IStatement
321 interface. Three new functions are defined:
322
323 procedure AddToBatch;
324 function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion;
325 procedure CancelBatch;
326 function GetBatchCompletion: IBatchCompletion;
327 function GetBatchRowLimit: integer;
328 procedure SetBatchRowLimit(aLimit: integer);
329
330 Also
331
332 function IsInBatchMode: boolean; {true after call to execute(eaDefer)}
333 function HasBatchMode: boolean; {true if and only if IBatch Supported}
334
335 For more information see the User Guide.
336
337 4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages
338 provided with the EIBInterBaseError now include all three parts.
339
340 5. Firebird.pas and include files updated to Firebird 4.0.0
341
342 6. New IStatement method: function GetSQLStatementTypeName: AnsiString;
343 Returns SQL Statement type as a text string;
344
345 7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to
346 an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger.
347
348 FBINTF Change Log version (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100
349
350 1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a
351 typo in FB30Statement.pas that caused an unknown parameter error.
352
353 FBINTF Change Log version (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000
354
355 1. Imported (Firebird) constants updated for Firebird 4.
356
357 2. Firebird.pas from Firebird 4 integrated into source code tree.
358
359 3. Added Support for TIMETAMP WITH TIME ZONE and TIME WITH TIME ZONE data types.
360
361 4. Added Support for SQL_DEC16, SQL_DEC34 and extended NUMERIC precision.
362
363 5. New unit 'FBClientLib.pas' added and provides new interface IFBIMasterProvider.
364 QueryInterface may be used to coerce this interface from IFirebirdAPI. The
365 interface provides a single method "function GetIMasterIntf: IMaster". This provides
366 type safe access to the Firebird IMaster interface and avoids the need to turn
367 off object checks when coercing "function GetIMaster: TObject" to IMaster.
368
369 6. New IFirebirdAPI Calls:
370 function HasLocalTZDB: boolean;
371 function HasTimeZoneSupport: boolean;
372 function HasExtendedTZSupport: boolean;
373 procedure SQLDecFloatEncode(aValue: tBCD; SQLType: cardinal; bufptr: PByte);
374 function SQLDecFloatDecode(SQLType: cardinal; scale: integer; bufptr: PByte): tBCD;
375
376 7. New IAttachment Calls:
377 function HasDecFloatSupport: boolean;
378 function GetTimeZoneServices: ITimeZoneServices;
379 function HasTimeZoneSupport: boolean;
380
381 8. New Interface ITimeZoneServices.
382
383 9. New ISQLData API Calls:
384 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
385 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
386 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
387 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
388 function GetAsUTCDateTime: TDateTime;
389 function GetAsBCD: tBCD;
390
391 10. New ISQLParam API Calls
392 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
393 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
394 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
395 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
396 function GetAsUTCDateTime: TDateTime;
397 function GetAsBCD: tBCD;
398 function GetStatement: IStatement;
399 function GetTransaction: ITransaction;
400 procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
401 procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
402 procedure SetAsDateTime(aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
403 procedure SetAsDateTime(aValue: TDateTime; aTimeZone: AnsiString); overload;
404 procedure SetAsUTCDateTime(aUTCTime: TDateTime);
405 procedure SetAsBcd(aValue: tBCD);
406
407 11. New IArray API Calls
408 procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
409 procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
410 procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
411 procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
412 function GetAsUTCDateTime(index: array of integer): TDateTime;
413 procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
414 procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZone: AnsiString); overload;
415 procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
416 procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
417
418 12. Utility functions in IBUtils
419 function ParseDateTimeTZString(aDateTimeStr: Ansistring; var aDateTime: TDateTime;
420 var aTimezone: AnsiString; aFormatSettings: TFormatSettings; TimeOnly: boolean=false): boolean;
421 procedure FBDecodeTime(aTime: TDateTime; var Hour, Minute, Second: word; var DeciMillisecond: cardinal);
422 function FBEncodeTime(Hour, Minute, Second, DeciMillisecond: cardinal): TDateTime;
423 function FBFormatDateTime(fmt: AnsiString; aDateTime: TDateTime): AnsiString;
424 function FormatTimeZoneOffset(EffectiveTimeOffsetMins: integer): AnsiString;
425 function DecodeTimeZoneOffset(TZOffset: AnsiString; var dstOffset: integer): boolean;
426
427 13. IDPB, ITPB and ISPB: new interface method
428 function AddByTypeName(ParamTypeName: AnsiString): IDPBItem/ITPBItem/ISPBItem;
429 This is used to add a parameter block item by the string equivalent of its
430 symbolic type name. e.g. DPB.AddByTypeName('isc_dpb_user_name').AsString := '...'
431
432 14. IDPBItem/ITPBItem/ISPBItem: new interface method:
433 function getParamTypeName: AnsiString;
434
435 15. fb_shutdown now called before unloading Firebird library. This can avoid a
436 SIGEVENT error when a programme using the embeded server is unloaded.
437
438 FBINTF Change Log version (1.1-6 Build 12237) Tue, 21 Jul 2020 08:54:21 +0100
439
440 1. GetImplementationVersion now correctly returns '3.0' for Firebird 3 API
441 with a Firebrid 3 client library.
442
443 2. Linux Only: FIREBIRD environment variable is now checked when loading the client library.
444 If a client library path is not explicitly provided and the FIREBIRD environment
445 variable is set then the directory given by this variable and any 'lib' subdirectory
446 are searched for the Firebird client library. Only if none is found, is the default
447 client library used.
448
449 3. IUtil.FormatStatus now used to format error messages when using new API
450
451 4. Fixed Array SDL: array_desc_scale now correctly encoded as a signed integer.
452
453 5. SQL_TEXT handling changed. When the value of an SQL_TEXT (i.e. fixed width string) column is
454 returned using GetAsString and the string codepage is UTF8, the string is truncated so
455 that the byte length corresponds to the number of characters specified for the column.
456 SQL_TEXT strings are no longer automatically trimmed to remove all trailing white space. This is
457 correct behaviour but may affect some implementations that relied upon automatic
458 trimming of trailing white space.
459
460 6. New IFirebirdAPI Calls:
461 function GetClientMajor: integer;
462 function GetClientMinor: integer;
463
464 7. IColumnMetaData and IArrayMetaData: new method
465 function GetCharSetWidth: integer;
466
467 FBINTF Change Log version (1.1-5 Build 12022) Fri, 17 Apr 2020 10:35:55 +0100
468
469 1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are
470 case sensitive
471
472 2. Single line SQL comments starting with '--' are now recognised by SQL Parser.
473
474 3. New API Calls:
475 IColumnMetaData.GetStatement
476 IColumnMetaData.GetTransaction
477 ISQLData.GetStrDataLength
478 IResults.GetStatement
479 IAttachment.OpenBlob (using Blob metadata)
480 IAttachment.OpenArray (using array metadata)
481
482 4. FBMessages: removal of unused messages
483
484 5. TFBArray.Create (2nd case): ensure that FFirebirdClientAPI is correctly set.
485
486 6. TIBSQLStatementType: SQLSavePoint added to end of enumeration.
487
488 FBINTF Change Log version (1.1-4 Build 11515) Fri, 28 Dec 2018 10:04:19 +0000
489
490 1. Fix a problem with the SQL parameter parser that failed to recognise parameters
491 where the second character of the parameter name is a numeric.
492
493 2. New method for IAttachment: procedure getFBVersion(version: TStrings);
494 This returns the isc_version connection information as one or more lines.
495 This is the same information as returned by isql with the -z option.
496
497 3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API
498 is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a
499 compiler option then the Firebird 3 API is no longer compiled in.
500
501 4. IColumnMetaData: new method.
502
503 TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP}
504 dfDateTime, {SQL DATETIME}
505 dfTime);
506
507 function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer;
508
509 This returns the max. number of characters returned by the "AsString" method
510 when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME.
511
512 5. Additional argument for IAttachment.PrepareWithNamedParameters -
513 CaseSensitiveParams: boolean = false
514
515 If this argument is set to true then SQL parameter names are assumed to be case
516 sensitive and must be referenced (using ISQLParams.ByName) using the case
517 sensitive name.
518
519 6. Bug fix: when setting a query parameter, it is now possible, when the parameter
520 is of type VarChar or Char to set the parameter to a numeric value (e.g. using
521 .AsCurrency) and then subsequently to update the value to a non-numeric string
522 using .AsString.
523
524
525
526 FBINTF Change Log version (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000
527
528 1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary
529
530 2. Restrict IsMultiThread check to Unix only for compatibility with
531 https://bugs.freepascal.org/view.php?id=30535
532
533 3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
534 named parameters and is intended to avoid problems with (e.g.) Execute Block
535 and processing internal parameters as statement parameters.
536
537 4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
538 or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.
539
540 5. New function added to IB.pas
541
542 function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary
543
544 This allows a Firebird Library to be loaded from an explicit path. use the
545 IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
546 the library. It is possible to load Firebird libraries from different locations
547 simultaneously, each with a distinct IFirebirdAPI.
548
549 FBINTF Change Log version (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100
550
551 1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
552 program compiled with -CR command line switch.
553
554 2. IServiceManager additions (informational):
555 function getProtocol: TProtocol;
556 function getPortNo: AnsiString;
557
558 3. IServiceManager improved error handling. Interfaces changed:
559 function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
560 function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
561 function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
562
563 4. IAttachment addition (informational)
564 function GetSecurityDatabase: AnsiString;
565
566 5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
567 thus now returns accumulated stats for a select statement from opening a cursor
568 up to the last fetch.
569
570 6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
571 the problem.
572
573 7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
574 replaces deprecated "comp" type.
575
576 10. Testsuite Test10 updated to include thread synchronisation for event reporting.
577
578 11. URL Connection Strings: inet4 and inet6 now recognised.
579
580 12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.
581
582 13. IAttachment.CharSetName2CharSetID is now performed case insensitive.
583
584
585 FBINTF Change Log version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000
586
587 1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.
588
589 2. IAttachment: add two new methods
590 function HasDefaultCharSet: boolean;
591 function GetDefaultCharSetID: integer;
592
593 These return, respectively, true if a connection default character set was
594 specified and the character set id of the connection default character set.
595 The DefaultCharSetID is cached when the connection is opened and hence does not
596 require a database lookup.
597
598 3. Avoid exception when a text blob is a stored procedure parameter.
599
600 4. Update test suite to include a test for a stored proc returning a text blob.
601
602 5. IAttachment: add
603 function GetRemoteProtocol: AnsiString;
604 function GetODSMajorVersion: integer;
605 function GetODSMinorVersion: integer;
606 function GetAuthenticationMethod: AnsiString;
607
608 These results are cached when the connection is opened and hence do not
609 require a database lookup.
610
611 6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
612 connect string used to create/connect to the database.
613
614 7. IAttachment: Create Database using SQL statement. The username and password
615 are now extracted and used to populate a DPB made available via IAttachment.getDPB.
616 It is now possible to use IAttachment disconnect/connect to reconnect to
617 a database for which the initial connection was established by a create
618 database sql statement. Available in FPC only.
619
620 8. Update Test 1 to test 5, 6 and 7 above.
621
622 9. IBUtils code tidy up.
623
624 10. Parameter Block interfaces "find" method. As documented, this should have
625 returned a nil interface when the item could not be found. Instead, an empty
626 interface item was returned. "Find" now works as documented and will return
627 a nil interface if the item cannot be found.
628
629 11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.
630
631 12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
632 requests with additional parameters. This is to enable support for fb_info_page_contents
633 (return of page contents). Response to fb_info_page_contents returned as
634 a string with code page CP_NONE.
635
636 13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
637 test suite updated.
638
639 14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
640 a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.
641
642 15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
643 An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
644 default connection port to be specified.
645
646 FBINTF Change Log version (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000
647
648 1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
649 Scale is no longer ignored.
650
651 2. Fix issues with setting SQL Param values using SetAsString with Date values
652 not in locale format but which are recognised by Firebird. Date values that
653 cannot be converted to a string using Pascal library are now passed through
654 to Firebird as Text Strings.
655
656 3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
657 UTF8 and not UNICODE_FSS.
658
659 4. Charset ID problem. When using Firebird 3, with no default database character set
660 and a column has a non-default collation specified, an incorrect character set
661 id was being reported that could result in a 'division by zero' error when
662 used by IBX. This has now been fixed.
663
664 5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
665 CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
666 the character sets supported can be updated on a per database basis. That is
667 it is possible to add a (Firebird) user defined character set to a database.
668
669 6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
670 set supported by Firebird with the API.
671
672 7. Add missing isc_info_db_read_only to list of decoded Database Information items
673 in FBOutputBlock.pas and update test suite to include this item.
674
675 8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.
676
677 9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
678 library or finding it by disk location, the PATH environment variable is now also set to
679 include the FIREBIRD directory. This is to ensure that the correct dlls in the
680 firebird client library dependencies are loaded.
681
682 10. Testsuite: Ensure consistent UTF-8 output on Windows console.
683
684 11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.
685
686 12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer
687
688 13. FB30Statement: A check has been added to ensure that all SQL Parameters
689 have been given a value (including NULL). Previously, failing to set the
690 value of an SQL Parameter could give rise to unpredictable results or
691 an SQLDA error.
692
693 14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.
694
695 15. FBAttachment: Avoid string reference count error when processing an Ansistring
696 parameter in an array of const passed to IAttachment.OpenCursor, etc.
697
698 16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
699 of const passed to IAttachment.OpenCursor, etc.
700
701
702 FBINTF Change Log version (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000
703
704 1. Change syntax to Mode Delphi
705
706 2. Change all uses of string type to explicit AnsiString in order to ensure
707 compatibility between Delphi and FPC.
708
709 3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
710 defined for each interface.
711
712 4. Generics syntax variations for Delphi added
713
714 5. PChar replaced with PByte expect where an actual string is being referenced,
715 where PAnsiChar is used instead.
716
717 6. Review of type definitions in IBExternals to ensure Delphi compatibility
718
719 7. Testsuite updated for Delphi
720
721 FBINTF Change Log version (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000
722
723 1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
724 large blobs and the FB3 API.
725
726 2. Update Event Handling algorithm to avoid looping due to recreation of the
727 event block.
728
729 3. Avoid invalid XSQLDA error when the only parameter is updated to null
730
731 4. Array Handling: fix problem with text arrays with character set none. When the
732 DB connection has a default character set (e.g. UTF8), an error is raised by
733 Firebird if the space allocated is not enough to allow for transliteration, even
734 though it is not required for character set none.
735
736 5. IBUtils: List of reserved words brought up-to-date
737
738 6. Add ISQL style performance statistics collection to IStatement
739
740 7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
741 CREATE DATABASE statement.
742
743 8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
744 an array dimension is not mistaken for a named parameter prefix.
745
746 9. Trim function no longer applied to result of GetAsString for SQL_TEXT
747 when Character set is octets. Avoids loss of non printable characters at start of string.
748
749 10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
750 statistics for the last action. Requires use of procedure IStatement.EnableStatistics
751 to enable stats gathering.
752
753 11. API Version information added as constants to IB.pas
754
755 12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID
756
757 13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.
758
759 FBINTF Change Log version (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000
760
761 1. Initial Release
762