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 319 by tony, Thu Feb 25 12:05:40 2021 UTC vs.
Revision 421 by tony, Sat Oct 21 14:22:28 2023 UTC

# Line 1 | Line 1
1 + FBINTF Change Log  version          (1.4-1 Build 14083) Fri, 20 Oct 2023 11:41:24 +0100
2 +
3 + 1. FBSQLData: ensure that TResults.getSQLData and TResults.GetData use same error
4 +   checks for range checking.
5 +
6 + 2. FB25Client: In GetIBMessage, fb_interpret is now called multiple times such that
7 +   any additional error information is decoded.
8 +
9 + 3. FB25Statement: When changing a param type from Blob sub_type 1 to SQL_TEXT or SQL_VARYING
10 +   charsetid is now preserved and size is set to default blob size. Now aligns with
11 +   FB3 and later.
12 +
13 + 4. DDL and DML string literals are now explicitly set to the connection character
14 +   set rather than the default character set provided by the compiler.
15 +
16 + 5. General tidy up of transliteration functions, now centralised in IBUtils. FPC testing
17 +   now makes use of the RTL fpwidestring unit for support of international character
18 +   sets.
19 +
20 + 6. Database exception handling (see section 9.3 in user guide).
21 +    * For FB3 and later API: Connection Character set now applied to message returned
22 +      by fb_interpret and message then transliterated if necessary to the system character set.
23 +    * For Legacy API: The message character set is guessed as UTF8 unless invalid
24 +      UTF8 characters found when connection character set is assumed. Message then
25 +      transliterated if necessary to system character set.
26 +      Note: this difference of behaviour is because legacy API presents exception messages
27 +      "as is", while FB3 server attempts to transliterate to connection character set.
28 +
29 + FBINTF Change Log  version          (1.4-0 Build 14011) Sat, 05 Aug 2023 11:09:09 +0100
30 +
31 + 1. Support package fbudr added for support of User Defined Routines (UDRs), and package
32 +   fbudrtestbed for client side debugging of UDR libraries.
33 +
34 + 2. Package layout changed with introduction of udr support. IB*.pas files moved from
35 +    root directory to "client". IBHeader moved to "Client".
36 +
37 + 3. Delphi packages: all packages now compile .dcp and .bpi files to either
38 +   fbintf\Win32\Debug or fbintf\Win64\Debug by default. Please remove any pre-existing
39 +   fbintf.dcp and fbintf.bpi files from other locations.
40 +
41 + 4. Client side journaling support added. Interface changes
42 +   IAttachment
43 +    function JournalingActive: boolean;
44 +    function GetJournalOptions: TJournalOptions;
45 +    function StartJournaling(aJournalLogFile: AnsiString): integer; overload;
46 +    function StartJournaling(aJournalLogFile: AnsiString; Options: TJournalOptions): integer; overload;
47 +    function StartJournaling(S: TStream; Options: TJournalOptions): integer; overload;
48 +    procedure StopJournaling(RetainJournal: boolean);
49 +
50 + 5. Transactions may now be given a local transaction name:
51 +   IFirebirdAPI
52 +     function StartTransaction(Attachments: array of IAttachment;
53 +             TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
54 +             TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit;
55 +             aName: AnsiString=''): ITransaction; overload;
56 +     function StartTransaction(Attachments: array of IAttachment;
57 +             TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
58 +             TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit;
59 +             aName: AnsiString=''): ITransaction; overload;
60 +
61 +   IAttachment
62 +    function StartTransaction(TPB: array of byte; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
63 +    function StartTransaction(TPB: ITPB; DefaultCompletion: TTransactionCompletion=taCommit): ITransaction; overload;
64 +    function StartTransaction(TPB: array of byte;
65 +                              DefaultCompletion: TTransactionCompletion=taCommit;
66 +                              aName: AnsiString=''): ITransaction; overload;
67 +    function StartTransaction(TPB: ITPB;
68 +                              DefaultCompletion: TTransactionCompletion=taCommit;
69 +                              aName: AnsiString=''): ITransaction; overload;
70 +
71 +  ITransaction
72 +    function GetTransactionName: AnsiString;
73 +    procedure SetTransactionName(aValue: AnsiString);
74 +
75 + 6. Additional Transaction information
76 +     ITPB.function AsText: AnsiString; {Returns TPB as a text string}
77 +
78 +   ITransaction
79 +     function GetDefaultCompletion: TTransactionCompletion;
80 +     function GetJournalingActive(attachment: IAttachment): boolean; {attachment must be specified when multi-database transaction}
81 +
82 + 7. New IAttachment helper functions
83 +     function HasTable(aTableName: AnsiString): boolean;
84 +     function HasFunction(aFunctionName: AnsiString): boolean;
85 +     function HasProcedure(aProcName: AnsiString): boolean;
86 +     function GetAttachmentID: integer;
87 +     function GetCharSetID: integer;
88 +
89 + 8. IStatement: if the BatchRowLimit is set to maxint, the maximum possible buffer size
90 +   will be allocated for batch operations.
91 +
92 + 9. IStatement, IColumnMetaData and ISQLParam all now consistently provide:
93 +    function GetStatement: IStatement;
94 +    function GetTransaction: ITransaction;
95 +    function GetAttachment: IAttachment;
96 +
97 + 10. Internal: a more disciplined approach to the handling of Firebird.IReferenceCounted
98 +    interfaces.
99 +
100 + 11. New interface type: IFBNumeric. IFBNumeric is implemented in the unit FBNumeric
101 +    and concentrates all handling of Fixed Point numbers. New ISQLItem and ISQLParam
102 +    functions getAsNumeric and setAsNumeric allow for direct retrival and manipulation
103 +    of numerics without loss of precision.
104 +
105 + 12. TryStrToNumeric and NumericToDouble moved from IBUtils to FBNumeric.
106 +
107 + 13. ISQLParams new method "Clear"
108 +
109 + 14. Connection Info (e.g. ODS Version, Remote Protocol) now retrieved on first
110 +    request rather than on attachment connect.
111 +
112 + 15. IStatus.IBDataBaseErrorMessages now defaults to [ShowIBMessage]. This reflects the
113 +    fact that SQLCodes are soon to be deprecated. In the future, the other options
114 +    will be silently ignored if SQLCode support is not present in the Firebird
115 +    Client library.
116 +
117 + 16. ITransaction changes Rollback and Commit from procedures to functions:
118 +      function Commit(Force: boolean=false): TTrCompletionState;
119 +      function Rollback(Force: boolean=false): TTrCompletionState;
120 +
121 +    Specifically, this is to allow the functions to report back a failed commit or
122 +    rollback when Force = true. In the case, the transaction handle has been
123 +    released, while the transaction remains in limbo.
124 +
125 + 17. IAttachment ExecImmediate.
126 +    When the transaction parameters are provided as an array of const and the
127 +    statement fails, the transaction is rolledback (forced) before the exception
128 +    is raised.
129 +
130 + 18. In Firebird 3 and later API: the status vector is now a thread var, as was
131 +    already the case with the legacy API. Avoids problems when calling underlying
132 +    Firebird API in multiple threads.
133 +
134 + 19. IBUtils: TSQLXMLReader: "string" type changed to "AnsiString" for compatibility
135 +    reasons.
136 +
137 + 20. IDBInformation.DecodeVersionString now supported isc_info_firebird_version.
138 +
139 + 21. TSQLXMLReader: handle 'blob' as a reserved word
140 +
141 + 22. ISQLParam.SetAsVariant now accepts a vartype of varUString (UnicodeString).
142 +
143 +
144 + FBINTF Change Log  version          (1.3-3 Build 12935) Mon, 06 Dec 2021 23:17:13 +0000
145 +
146 + 1. Fix compile error with fpc trunk (3.3.1 and later), due to type change to tzname in "unix" unit.
147 +
148 + 2. Remove constraint in IAttachment.HasScollableCursors that returned false when
149 +   using remote protocol. Scrollable cursors with remote database expected to
150 +   be support for Firebird 4.0.1 onwards. Note: Firebird 4.0.0 will return
151 +   a not supported error.
152 +
153 + 3. IStatement: new function;
154 +    TStatementFlag = (stHasCursor,stRepeatExecute,stScrollable);
155 +    TStatementFlags = set of TStatementFlag;
156 +    function GetFlags: TStatementFlags;
157 +
158 + 4. Revised behaviour for IStatement.ExecuteQuery in order to preserve backwards
159 +   compatibility.
160 +   In Firebird 5, Update..Returning may returns multiple rows and hence the statemen
161 +   type changes from ExecProcedure to Select. So that ExecuteQuery can continue
162 +   to be used with Update...Retruning statements that return a singleton row,
163 +   instead of raising an exception when ExecuteQuery is used with a (SELECT) statement,
164 +   it will open the cursor and return the first row only.
165 +
166 + 5. ITransaction: new functions:
167 +    function GetIsReadOnly: boolean;
168 +    function GetTransactionID: integer;
169 +    function GetTrInformation(Requests: array of byte): ITrInformation; overload;
170 +    function GetTrInformation(Request: byte): ITrInformation; overload;
171 +
172 +   The latter two return the Transaction Information block. The first two extract
173 +   information the Transaction Information block
174 +
175 + 6. New function TSQLTokeniser.ReadCharacters
176 +   Used internally.
177 +
178 + 7. IStatement: GetProcessedSQL bug fix. No longer raises and error if SQL contains
179 +   parameter placeholders instead of named parameters.
180 +
181 + 8. ITransaction (Firebird 3 and later): An exception raised when freeing an underlying
182 +   transaction handle is now ignored if Rollback/Commit is called with Force=true
183 +
184 + 9. Tidy up of exception handling code. Under the legacy API, fb_interpret is now
185 +   used to get an IBError Message instead of isc_interprete.
186 +
187 + 10. Internal tidyup. Native code now used for decoding integers and the events
188 +    buffer. Avoids dependencies on fbclient functions isc_portable_integer,
189 +    isc_event_block and isc_event_counts.
190 +
191 + 11. New IAttachment function
192 +     function GetAttachmentID: integer;
193 +
194 + 12. Internal changes to TFBClientAPI, TFBAttachment and TFBTransaction and TFB30
195 +    subclasses to enable UDR support.
196 +
197 + FBINTF Change Log  version          (1.3-2 Build 12889) Sun, 24 Oct 2021 13:49:28 +0100
198 +
199 + 1. TFBClientAPI.GetProcAddr. Add check for nil reference.
200 +
201 + 2. IStatement: new methods:
202 +    procedure SetStaleReferenceChecks(Enable:boolean); {default true}
203 +    function GetStaleReferenceChecks: boolean;
204 +
205 +   In previous versions, stale reference checks were always enabled. This allows the
206 +   user to disable them on a per statement basis. Note this can risk out-of-date
207 +   statement BLR. See User Guide.
208 +
209 + 3. IBUtils: TSQLwithNamedParamsTokeniser now recognises a CASE...END block within a
210 +   stored procedure and hence avoids replacing named parameters within a containing
211 +   BEGIN..END block.
212 +
213 + 4. ISQLParam: using a string value to set an integer field with a scale factor of
214 +   zero is now treated as a special case to avoid the risk of floating point
215 +   rounding errors affecting pure integers.
216 +
217 + 5. ISQLParam:  Review and tidy-up of SetAsString for numeric types.
218 +
219 + 6. ISQLParam is now subclassed from IParamMetaData, which provides access to the mutable
220 +   SQL Parameter metadata (methods moved from ISQLParam).
221 +
222 + 7. ISQLParam: new method
223 +     function getColMetadata: IParamMetaData;
224 +   This instance of IParamMetaData returns the original column metadata which is unmutable.
225 +   Note: ISQLParam metadata can change after a parameter value has been set e.g when
226 +   setting a VARCHAR column to an integer value.
227 +
228 + 8. IStatement: can now set cursor name when opening a cursor. New overloaded method:
229 +    procedure Prepare(CursorName: AnsiString; aTransaction: ITransaction=nil); overload;
230 +   also IAttachment:
231 +    function Prepare(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; CursorName: AnsiString=''): IStatement; overload;
232 +    function Prepare(transaction: ITransaction; sql: AnsiString; CursorName: AnsiString=''): IStatement; overload;
233 +    function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
234 +                       aSQLDialect: integer; GenerateParamNames: boolean=false;
235 +                       CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
236 +    function PrepareWithNamedParameters(transaction: ITransaction; sql: AnsiString;
237 +                       GenerateParamNames: boolean=false;
238 +                       CaseSensitiveParams: boolean = false; CursorName: AnsiString=''): IStatement; overload;
239 +
240 + 9. Support for scrollable cursors added. New/updated methods:
241 +   IAttachment:
242 +    function HasScollableCursors: boolean;
243 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
244 +                             Scrollable: boolean=false): IResultSet; overload;
245 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
246 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
247 +                             params: array of const): IResultSet; overload;
248 +    function OpenCursor(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false;
249 +                             params: array of const): IResultSet; overload;
250 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer; Scrollable: boolean;
251 +                             params: array of const): IResultSet; overload;
252 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; aSQLDialect: integer;
253 +                             Scrollable: boolean=false): IResultSet; overload;
254 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
255 +    function OpenCursorAtStart(transaction: ITransaction; sql: AnsiString; Scrollable: boolean;
256 +                             params: array of const): IResultSet; overload;
257 +    function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean=false): IResultSet; overload;
258 +    function OpenCursorAtStart(sql: AnsiString; Scrollable: boolean;
259 +                             params: array of const): IResultSet; overload;
260 +   IStatement:
261 +     function OpenCursor(Scrollable: boolean; CursorName: AnsiString =''; aTransaction: ITransaction=nil): IResultSet; overload;
262 +   IResultSet:
263 +    function FetchPrior: boolean; {fetch previous record}
264 +    function FetchFirst:boolean; {fetch first record}
265 +    function FetchLast: boolean; {fetch last record}
266 +    function FetchAbsolute(position: Integer): boolean; {fetch record by its absolute position in result set}
267 +    function FetchRelative(offset: Integer): boolean; {fetch record by position relative to current}
268 +    function IsBof: boolean;
269 +
270 + 10. IArray: tidyup of SetAsString method to ensure correct handling of fixed point numbers.
271 +
272 + 11. IBUtils: TSQLTokeniser. CRLF now combined by low level parser into sqltEOL token. This
273 +    may be noticeable when a line separator occurs inside quoted text. The quoted text
274 +    output by the tokeniser will now use the platform specific lineEnding regardless
275 +    of whether the input uses the CRLF or LF as a line separator.
276 +
277 + 12. IStatement, IResultsSet: Support for scrollable cursors added (note: local databases only)
278 +
279 +
280 + FBINTF Change Log  version          (1.3-1 Build 12776) Mon, 23 Aug 2021 11:09:33 +0100
281 +
282 + 1. Integer decodes in information blocks (e.g. IDBInfoItem) widened from 32 bit to 64-bit integers.
283 +
284 + 2. Support for inline blob encoding. Blob values pass using the "SetAsString" method
285 +   will now be encoded inline (i.e. as part of the parameter buffer) if they are
286 +   shorter than a pre-set limit. Longer values continue to be saved as blobs as a
287 +   separate server interaction. This is intended as a performance optimisation.
288 +
289 +   The pre-set limit defaults to 8192 bytes and can be inspected/modified using the new
290 +   IAttachment interface functions:
291 +
292 +    function GetInlineBlobLimit: integer;
293 +    procedure SetInlineBlobLimit(limit: integer);
294 +
295 + 3. Support for Firebird 4 IBatch interface added. This is largely transparent to the API
296 +   user as the functionality is embedded in the implementation of the IStatement
297 +   interface. Three new functions are defined:
298 +
299 +    procedure AddToBatch;
300 +    function ExecuteBatch(aTransaction: ITransaction=nil): IBatchCompletion;
301 +    procedure CancelBatch;
302 +    function GetBatchCompletion: IBatchCompletion;
303 +    function GetBatchRowLimit: integer;
304 +    procedure SetBatchRowLimit(aLimit: integer);
305 +
306 +   Also
307 +
308 +    function IsInBatchMode: boolean;        {true after call to execute(eaDefer)}
309 +    function HasBatchMode: boolean;         {true if and only if IBatch Supported}
310 +
311 +   For more information see the User Guide.
312 +
313 + 4. Default error message contents. Now aligned with User Guide section 10.2 i.e. error messages
314 +   provided with the EIBInterBaseError now include all three parts.
315 +
316 + 5. Firebird.pas and include files updated to Firebird 4.0.0
317 +
318 + 6. New IStatement method: function GetSQLStatementTypeName: AnsiString;
319 +   Returns SQL Statement type as a text string;
320 +
321 + 7. ISQLData.AsInteger and AsInt64 now use "Round" to convert a float field to
322 +   an integer instead of "trunc". This is for compatibility with TFloatField.AsInteger.
323 +
324 + FBINTF Change Log  version          (1.2-1 Build 12552) Wed, 09 Jun 2021 13:05:40 +0100
325 +
326 + 1. Big fix for Firebird 4.0. A internal change in Firebird 4.0.0 from RC1 flushed out a
327 +   typo in FB30Statement.pas that caused an unknown parameter error.
328 +
329   FBINTF Change Log  version          (1.2-0 Build 12520) Fri, 19 Feb 2021 13:27:23 +0000
330  
331   1. Imported (Firebird) constants updated for Firebird 4.

Diff Legend

Removed lines
+ Added lines
< Changed lines
> Changed lines