ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/branches/journaling/fbintf/changelog
Revision: 348
Committed: Wed Oct 6 09:38:14 2021 UTC (2 years, 5 months ago) by tony
Original Path: ibx/trunk/fbintf/changelog
File size: 22560 byte(s)
Log Message:
Fixes Merged

File Contents

# Content
1 FBINTF Change Log version (1.3-2 Build 12806) Wed, 06 Oct 2021 09:07:03 +0100
2
3 1. TFBClientAPI.GetProcAddr. Add check for nil reference.
4
5 2. IStatement: new methods:
6 procedure SetStaleReferenceChecks(Enable:boolean); {default true}
7 function GetStaleReferenceChecks: boolean;
8
9 In previous versions, stale reference checks were always enabled. This allows the
10 user to disable them on a per statement basis. Note this can risk out-of-date
11 statement BLR. See User Guide.
12
13 3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
14 stored procedure and hence avoids replacing named parameters within a containing
15 BEGIN..END block.
16
17 FBINTF Change Log version (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100
18
19 1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.
20
21 2. Support for inline blob encoding. Blob values pass using the "SetAsString" method
22 will now be encoded inline (i.e. as part of the parameter buffer) if they are
23 shorter than a pre-set limit. Longer values continue to be saved as blobs as a
24 separate server interaction. This is intended as a performance optimisation.
25
26 The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new
27 IAttachment interface functions:
28
29 function GetInlineBlobLimit: integer;
30 procedure SetInlineBlobLimit(limit: integer);
31
32 3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API
33 user as the functionality is embedded in the implementation of the IStatement
34 interface. Three new functions are defined:
35
36 procedure AddToBatch;
37 function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion;
38 procedure CancelBatch;
39 function GetBatchCompletion: IBatchCompletion;
40 function GetBatchRowLimit: integer;
41 procedure SetBatchRowLimit(aLimit: integer);
42
43 Also
44
45 function IsInBatchMode: boolean; {true after call to execute(eaDefer)}
46 function HasBatchMode: boolean; {true if and only if IBatch Supported}
47
48 For more information see the User Guide.
49
50 4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages
51 provided with the EIBInterBaseError now include all three parts.
52
53 5. Firebird.pas and include files updated to Firebird 4.0.0
54
55 6. New IStatement method: function GetSQLStatementTypeName: AnsiString;
56 Returns SQL Statement type as a text string;
57
58 7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to
59 an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger.
60
61 FBINTF Change Log version (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100
62
63 1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a
64 typo in FB30Statement.pas that caused an unknown parameter error.
65
66 FBINTF Change Log version (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000
67
68 1. Imported (Firebird) constants updated for Firebird 4.
69
70 2. Firebird.pas from Firebird 4 integrated into source code tree.
71
72 3. Added Support for TIMETAMP WITH TIME ZONE and TIME WITH TIME ZONE data types.
73
74 4. Added Support for SQL_DEC16, SQL_DEC34 and extended NUMERIC precision.
75
76 5. New unit 'FBClientLib.pas' added and provides new interface IFBIMasterProvider.
77 QueryInterface may be used to coerce this interface from IFirebirdAPI. The
78 interface provides a single method "function GetIMasterIntf: IMaster". This provides
79 type safe access to the Firebird IMaster interface and avoids the need to turn
80 off object checks when coercing "function GetIMaster: TObject" to IMaster.
81
82 6. New IFirebirdAPI Calls:
83 function HasLocalTZDB: boolean;
84 function HasTimeZoneSupport: boolean;
85 function HasExtendedTZSupport: boolean;
86 procedure SQLDecFloatEncode(aValue: tBCD; SQLType: cardinal; bufptr: PByte);
87 function SQLDecFloatDecode(SQLType: cardinal; scale: integer; bufptr: PByte): tBCD;
88
89 7. New IAttachment Calls:
90 function HasDecFloatSupport: boolean;
91 function GetTimeZoneServices: ITimeZoneServices;
92 function HasTimeZoneSupport: boolean;
93
94 8. New Interface ITimeZoneServices.
95
96 9. New ISQLData API Calls:
97 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
98 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
99 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
100 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
101 function GetAsUTCDateTime: TDateTime;
102 function GetAsBCD: tBCD;
103
104 10. New ISQLParam API Calls
105 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
106 procedure GetAsDateTime(var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
107 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
108 procedure GetAsTime(var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
109 function GetAsUTCDateTime: TDateTime;
110 function GetAsBCD: tBCD;
111 function GetStatement: IStatement;
112 function GetTransaction: ITransaction;
113 procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
114 procedure SetAsTime(aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
115 procedure SetAsDateTime(aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
116 procedure SetAsDateTime(aValue: TDateTime; aTimeZone: AnsiString); overload;
117 procedure SetAsUTCDateTime(aUTCTime: TDateTime);
118 procedure SetAsBcd(aValue: tBCD);
119
120 11. New IArray API Calls
121 procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID); overload;
122 procedure GetAsDateTime(index: array of integer; var aDateTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString); overload;
123 procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezoneID: TFBTimeZoneID; OnDate: TDateTime); overload;
124 procedure GetAsTime(index: array of integer; var aTime: TDateTime; var dstOffset: smallint; var aTimezone: AnsiString; OnDate: TDateTime); overload;
125 function GetAsUTCDateTime(index: array of integer): TDateTime;
126 procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
127 procedure SetAsDateTime(index: array of integer; aValue: TDateTime; aTimeZone: AnsiString); overload;
128 procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZoneID: TFBTimeZoneID); overload;
129 procedure SetAsTime(index: array of integer; aValue: TDateTime; OnDate: TDateTime; aTimeZone: AnsiString); overload;
130
131 12. Utility functions in IBUtils
132 function ParseDateTimeTZString(aDateTimeStr: Ansistring; var aDateTime: TDateTime;
133 var aTimezone: AnsiString; aFormatSettings: TFormatSettings; TimeOnly: boolean=false): boolean;
134 procedure FBDecodeTime(aTime: TDateTime; var Hour, Minute, Second: word; var DeciMillisecond: cardinal);
135 function FBEncodeTime(Hour, Minute, Second, DeciMillisecond: cardinal): TDateTime;
136 function FBFormatDateTime(fmt: AnsiString; aDateTime: TDateTime): AnsiString;
137 function FormatTimeZoneOffset(EffectiveTimeOffsetMins: integer): AnsiString;
138 function DecodeTimeZoneOffset(TZOffset: AnsiString; var dstOffset: integer): boolean;
139
140 13. IDPB, ITPB and ISPB: new interface method
141 function AddByTypeName(ParamTypeName: AnsiString): IDPBItem/ITPBItem/ISPBItem;
142 This is used to add a parameter block item by the string equivalent of its
143 symbolic type name. e.g. DPB.AddByTypeName('isc_dpb_user_name').AsString := '...'
144
145 14. IDPBItem/ITPBItem/ISPBItem: new interface method:
146 function getParamTypeName: AnsiString;
147
148 15. fb_shutdown now called before unloading Firebird library. This can avoid a
149 SIGEVENT error when a programme using the embeded server is unloaded.
150
151 FBINTF Change Log version (1.1-6 Build 12237) Tue, 21 Jul 2020 08:54:21 +0100
152
153 1. GetImplementationVersion now correctly returns '3.0' for Firebird 3 API
154 with a Firebrid 3 client library.
155
156 2. Linux Only: FIREBIRD environment variable is now checked when loading the client library.
157 If a client library path is not explicitly provided and the FIREBIRD environment
158 variable is set then the directory given by this variable and any 'lib' subdirectory
159 are searched for the Firebird client library. Only if none is found, is the default
160 client library used.
161
162 3. IUtil.FormatStatus now used to format error messages when using new API
163
164 4. Fixed Array SDL: array_desc_scale now correctly encoded as a signed integer.
165
166 5. SQL_TEXT handling changed. When the value of an SQL_TEXT (i.e. fixed width string) column is
167 returned using GetAsString and the string codepage is UTF8, the string is truncated so
168 that the byte length corresponds to the number of characters specified for the column.
169 SQL_TEXT strings are no longer automatically trimmed to remove all trailing white space. This is
170 correct behaviour but may affect some implementations that relied upon automatic
171 trimming of trailing white space.
172
173 6. New IFirebirdAPI Calls:
174 function GetClientMajor: integer;
175 function GetClientMinor: integer;
176
177 7. IColumnMetaData and IArrayMetaData: new method
178 function GetCharSetWidth: integer;
179
180 FBINTF Change Log version (1.1-5 Build 12022) Fri, 17 Apr 2020 10:35:55 +0100
181
182 1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are
183 case sensitive
184
185 2. Single line SQL comments starting with '--' are now recognised by SQL Parser.
186
187 3. New API Calls:
188 IColumnMetaData.GetStatement
189 IColumnMetaData.GetTransaction
190 ISQLData.GetStrDataLength
191 IResults.GetStatement
192 IAttachment.OpenBlob (using Blob metadata)
193 IAttachment.OpenArray (using array metadata)
194
195 4. FBMessages: removal of unused messages
196
197 5. TFBArray.Create (2nd case): ensure that FFirebirdClientAPI is correctly set.
198
199 6. TIBSQLStatementType: SQLSavePoint added to end of enumeration.
200
201 FBINTF Change Log version (1.1-4 Build 11515) Fri, 28 Dec 2018 10:04:19 +0000
202
203 1. Fix a problem with the SQL parameter parser that failed to recognise parameters
204 where the second character of the parameter name is a numeric.
205
206 2. New method for IAttachment: procedure getFBVersion(version: TStrings);
207 This returns the isc_version connection information as one or more lines.
208 This is the same information as returned by isql with the -z option.
209
210 3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API
211 is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a
212 compiler option then the Firebird 3 API is no longer compiled in.
213
214 4. IColumnMetaData: new method.
215
216 TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP}
217 dfDateTime, {SQL DATETIME}
218 dfTime);
219
220 function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer;
221
222 This returns the max. number of characters returned by the "AsString" method
223 when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME.
224
225 5. Additional argument for IAttachment.PrepareWithNamedParameters -
226 CaseSensitiveParams: boolean = false
227
228 If this argument is set to true then SQL parameter names are assumed to be case
229 sensitive and must be referenced (using ISQLParams.ByName) using the case
230 sensitive name.
231
232 6. Bug fix: when setting a query parameter, it is now possible, when the parameter
233 is of type VarChar or Char to set the parameter to a numeric value (e.g. using
234 .AsCurrency) and then subsequently to update the value to a non-numeric string
235 using .AsString.
236
237
238
239 FBINTF Change Log version (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000
240
241 1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary
242
243 2. Restrict IsMultiThread check to Unix only for compatibility with
244 https://bugs.freepascal.org/view.php?id=30535
245
246 3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
247 named parameters and is intended to avoid problems with (e.g.) Execute Block
248 and processing internal parameters as statement parameters.
249
250 4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
251 or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.
252
253 5. New function added to IB.pas
254
255 function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary
256
257 This allows a Firebird Library to be loaded from an explicit path. use the
258 IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
259 the library. It is possible to load Firebird libraries from different locations
260 simultaneously, each with a distinct IFirebirdAPI.
261
262 FBINTF Change Log version (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100
263
264 1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
265 program compiled with -CR command line switch.
266
267 2. IServiceManager additions (informational):
268 function getProtocol: TProtocol;
269 function getPortNo: AnsiString;
270
271 3. IServiceManager improved error handling. Interfaces changed:
272 function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
273 function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
274 function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
275
276 4. IAttachment addition (informational)
277 function GetSecurityDatabase: AnsiString;
278
279 5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
280 thus now returns accumulated stats for a select statement from opening a cursor
281 up to the last fetch.
282
283 6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
284 the problem.
285
286 7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
287 replaces deprecated "comp" type.
288
289 10. Testsuite Test10 updated to include thread synchronisation for event reporting.
290
291 11. URL Connection Strings: inet4 and inet6 now recognised.
292
293 12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.
294
295 13. IAttachment.CharSetName2CharSetID is now performed case insensitive.
296
297
298 FBINTF Change Log version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000
299
300 1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.
301
302 2. IAttachment: add two new methods
303 function HasDefaultCharSet: boolean;
304 function GetDefaultCharSetID: integer;
305
306 These return, respectively, true if a connection default character set was
307 specified and the character set id of the connection default character set.
308 The DefaultCharSetID is cached when the connection is opened and hence does not
309 require a database lookup.
310
311 3. Avoid exception when a text blob is a stored procedure parameter.
312
313 4. Update test suite to include a test for a stored proc returning a text blob.
314
315 5. IAttachment: add
316 function GetRemoteProtocol: AnsiString;
317 function GetODSMajorVersion: integer;
318 function GetODSMinorVersion: integer;
319 function GetAuthenticationMethod: AnsiString;
320
321 These results are cached when the connection is opened and hence do not
322 require a database lookup.
323
324 6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
325 connect string used to create/connect to the database.
326
327 7. IAttachment: Create Database using SQL statement. The username and password
328 are now extracted and used to populate a DPB made available via IAttachment.getDPB.
329 It is now possible to use IAttachment disconnect/connect to reconnect to
330 a database for which the initial connection was established by a create
331 database sql statement. Available in FPC only.
332
333 8. Update Test 1 to test 5, 6 and 7 above.
334
335 9. IBUtils code tidy up.
336
337 10. Parameter Block interfaces "find" method. As documented, this should have
338 returned a nil interface when the item could not be found. Instead, an empty
339 interface item was returned. "Find" now works as documented and will return
340 a nil interface if the item cannot be found.
341
342 11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.
343
344 12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
345 requests with additional parameters. This is to enable support for fb_info_page_contents
346 (return of page contents). Response to fb_info_page_contents returned as
347 a string with code page CP_NONE.
348
349 13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
350 test suite updated.
351
352 14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
353 a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.
354
355 15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
356 An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
357 default connection port to be specified.
358
359 FBINTF Change Log version (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000
360
361 1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
362 Scale is no longer ignored.
363
364 2. Fix issues with setting SQL Param values using SetAsString with Date values
365 not in locale format but which are recognised by Firebird. Date values that
366 cannot be converted to a string using Pascal library are now passed through
367 to Firebird as Text Strings.
368
369 3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
370 UTF8 and not UNICODE_FSS.
371
372 4. Charset ID problem. When using Firebird 3, with no default database character set
373 and a column has a non-default collation specified, an incorrect character set
374 id was being reported that could result in a 'division by zero' error when
375 used by IBX. This has now been fixed.
376
377 5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
378 CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
379 the character sets supported can be updated on a per database basis. That is
380 it is possible to add a (Firebird) user defined character set to a database.
381
382 6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
383 set supported by Firebird with the API.
384
385 7. Add missing isc_info_db_read_only to list of decoded Database Information items
386 in FBOutputBlock.pas and update test suite to include this item.
387
388 8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.
389
390 9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
391 library or finding it by disk location, the PATH environment variable is now also set to
392 include the FIREBIRD directory. This is to ensure that the correct dlls in the
393 firebird client library dependencies are loaded.
394
395 10. Testsuite: Ensure consistent UTF-8 output on Windows console.
396
397 11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.
398
399 12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer
400
401 13. FB30Statement: A check has been added to ensure that all SQL Parameters
402 have been given a value (including NULL). Previously, failing to set the
403 value of an SQL Parameter could give rise to unpredictable results or
404 an SQLDA error.
405
406 14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.
407
408 15. FBAttachment: Avoid string reference count error when processing an Ansistring
409 parameter in an array of const passed to IAttachment.OpenCursor, etc.
410
411 16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
412 of const passed to IAttachment.OpenCursor, etc.
413
414
415 FBINTF Change Log version (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000
416
417 1. Change syntax to Mode Delphi
418
419 2. Change all uses of string type to explicit AnsiString in order to ensure
420 compatibility between Delphi and FPC.
421
422 3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
423 defined for each interface.
424
425 4. Generics syntax variations for Delphi added
426
427 5. PChar replaced with PByte expect where an actual string is being referenced,
428 where PAnsiChar is used instead.
429
430 6. Review of type definitions in IBExternals to ensure Delphi compatibility
431
432 7. Testsuite updated for Delphi
433
434 FBINTF Change Log version (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000
435
436 1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
437 large blobs and the FB3 API.
438
439 2. Update Event Handling algorithm to avoid looping due to recreation of the
440 event block.
441
442 3. Avoid invalid XSQLDA error when the only parameter is updated to null
443
444 4. Array Handling: fix problem with text arrays with character set none. When the
445 DB connection has a default character set (e.g. UTF8), an error is raised by
446 Firebird if the space allocated is not enough to allow for transliteration, even
447 though it is not required for character set none.
448
449 5. IBUtils: List of reserved words brought up-to-date
450
451 6. Add ISQL style performance statistics collection to IStatement
452
453 7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
454 CREATE DATABASE statement.
455
456 8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
457 an array dimension is not mistaken for a named parameter prefix.
458
459 9. Trim function no longer applied to result of GetAsString for SQL_TEXT
460 when Character set is octets. Avoids loss of non printable characters at start of string.
461
462 10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
463 statistics for the last action. Requires use of procedure IStatement.EnableStatistics
464 to enable stats gathering.
465
466 11. API Version information added as constants to IB.pas
467
468 12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID
469
470 13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.
471
472 FBINTF Change Log version (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000
473
474 1. Initial Release
475