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