ViewVC Help
View File | Revision Log | Show Annotations | Download File | View Changeset | Root Listing
root/public/ibx/trunk/fbintf/changelog
(Generate patch)

Comparing ibx/trunk/fbintf/changelog (file contents):
Revision 345 by tony, Mon Aug 23 14:22:29 2021 UTC vs.
Revision 434 by tony, Wed Mar 20 11:31:00 2024 UTC

# Line 1 | Line 1
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.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines