ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/branches/udr/changelog
Revision: 345
Committed: Mon Aug 23 14:22:29 2021 UTC (3 years, 3 months ago) by tony
Original Path: ibx/trunk/fbintf/changelog
File size: 21875 byte(s)
Log Message:
Merged into public release

File Contents

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