[ViewVC] Annotation of: public/ibx/trunk/fbintf/changelog

FBINTF Change Log  version                  (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000

1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary

2. Restrict IsMultiThread check to Unix only for compatibility with
   https://bugs.freepascal.org/view.php?id=30535

3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
   named parameters and is intended to avoid problems with (e.g.) Execute Block
   and processing internal parameters as statement parameters.

4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
   or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.

5. New function added to IB.pas

   function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary

   This allows a Firebird Library to be loaded from an explicit path. use the
   IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
   the library. It is possible to load Firebird libraries from different locations
   simultaneously, each with a distinct IFirebirdAPI.

FBINTF Change Log  version               (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100

1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
   program compiled with -CR command line switch.

2. IServiceManager additions (informational):
    function getProtocol: TProtocol;
    function getPortNo: AnsiString;

3. IServiceManager improved error handling. Interfaces changed:
    function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
    function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
    function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;

4. IAttachment addition (informational)
    function GetSecurityDatabase: AnsiString;

5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
   thus now returns accumulated stats for a select statement from opening a cursor
   up to the last fetch.

6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
   the problem.

7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
   replaces deprecated "comp" type.

10. Testsuite Test10 updated to include thread synchronisation for event reporting.

11. URL Connection Strings: inet4 and inet6 now recognised.

12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.

13. IAttachment.CharSetName2CharSetID is now performed case insensitive.


FBINTF Change Log  version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000

1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.

2. IAttachment: add two new methods
     function HasDefaultCharSet: boolean;
     function GetDefaultCharSetID: integer;

   These return, respectively, true if a connection default character set was
   specified and the character set id of the connection default character set.
   The DefaultCharSetID is cached when the connection is opened and hence does not
   require a database lookup.

3. Avoid exception when a text blob is a stored procedure parameter.

4. Update test suite to include a test for a stored proc returning a text blob.

5. IAttachment: add
      function GetRemoteProtocol: AnsiString;
      function GetODSMajorVersion: integer;
      function GetODSMinorVersion: integer;
      function GetAuthenticationMethod: AnsiString;

   These results are cached when the connection is opened and hence do not
   require a database lookup.

6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
   connect string used to create/connect to the database.

7. IAttachment: Create Database using SQL statement. The username and password
   are now extracted and used to populate a DPB made available via IAttachment.getDPB.
   It is now possible to use IAttachment disconnect/connect to reconnect to
   a database for which the initial connection was established by a create
   database sql statement. Available in FPC only.

8. Update Test 1 to test 5, 6 and 7 above.

9. IBUtils code tidy up.

10. Parameter Block interfaces "find" method. As documented, this should have
   returned a nil interface when the item could not be found. Instead, an empty
   interface item was returned. "Find" now works as documented and will return
   a nil interface if the item cannot be found.

11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.

12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
    requests with additional parameters. This is to enable support for fb_info_page_contents
    (return of page contents). Response to fb_info_page_contents returned as
    a string with code page CP_NONE.

13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
    test suite updated.

14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
    a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.

15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
    An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
    default connection port to be specified.

FBINTF Change Log  version                             (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000

1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
   Scale is no longer ignored.

2. Fix issues with setting SQL Param values using SetAsString with Date values
   not in locale format but which are recognised by Firebird. Date values that
   cannot be converted to a string using Pascal library are now passed through
   to Firebird as Text Strings.

3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
   UTF8 and not UNICODE_FSS.

4. Charset ID problem. When using Firebird 3, with no default database character set
   and a column has a non-default collation specified, an incorrect character set
   id was being reported that could result in a 'division by zero' error when
   used by IBX. This has now been fixed.

5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
   CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
   the character sets supported can be updated on a per database basis. That is
   it is possible to add a (Firebird) user defined character set to a database.

6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
   set supported by Firebird with the API.

7. Add missing isc_info_db_read_only to list of decoded Database Information items
   in FBOutputBlock.pas and update test suite to include this item.

8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.

9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
   library or finding it by disk location, the PATH environment variable is now also set to
   include the FIREBIRD directory. This is to ensure that the correct dlls in the
   firebird client library dependencies are loaded.

10. Testsuite: Ensure consistent UTF-8 output on Windows console.

11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.

12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer

13. FB30Statement: A check has been added to ensure that all SQL Parameters
    have been given a value (including NULL). Previously, failing to set the
    value of an SQL Parameter could give rise to unpredictable results or
    an SQLDA error.

14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.

15. FBAttachment: Avoid string reference count error when processing an Ansistring
    parameter in an array of const passed to IAttachment.OpenCursor, etc.

16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
    of const passed to IAttachment.OpenCursor, etc.


FBINTF Change Log  version             (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000

1. Change syntax to Mode Delphi

2. Change all uses of string type to explicit AnsiString in order to ensure
   compatibility between Delphi and FPC. 

3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
   defined for each interface.

4. Generics syntax variations for Delphi added

5. PChar replaced with PByte expect where an actual string is being referenced,
   where PAnsiChar is used instead.

6. Review of type definitions in IBExternals to ensure Delphi compatibility

7. Testsuite updated for Delphi

FBINTF Change Log  version            (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000

1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
   large blobs and the FB3 API.

2. Update Event Handling algorithm to avoid looping due to recreation of the
   event block.

3. Avoid invalid XSQLDA error when the only parameter is updated to null

4. Array Handling: fix problem with text arrays with character set none. When the
   DB connection has a default character set (e.g. UTF8), an error is raised by
   Firebird if the space allocated is not enough to allow for transliteration, even
   though it is not required for character set none.

5. IBUtils: List of reserved words brought up-to-date

6. Add ISQL style performance statistics collection to IStatement

7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
   CREATE DATABASE statement.

8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
   an array dimension is not mistaken for a named parameter prefix.

9. Trim function no longer applied to result of GetAsString for SQL_TEXT
   when Character set is octets. Avoids loss of non printable characters at start of string.

10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
    statistics for the last action. Requires use of procedure IStatement.EnableStatistics
    to enable stats gathering.

11. API Version information added as constants to IB.pas

12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID

13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.

FBINTF Change Log  version                                      (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000

1. Initial Release

Revision:	263
Committed:	Thu Dec 6 15:55:01 2018 UTC (5 years, 11 months ago) by tony
File size:	10440 byte(s)
Log Message:	Release 2.3.2 committed
#	User	Rev	Content
1	tony	263	FBINTF Change Log version (1.1-3) Wed, 05 Dec 2018 14:28:10 +0000
2	tony	238
3			1. DARWIN only syntax error: fix missing semi-colon in TFBClientAPI.LoadIBLibrary
4
5	tony	263	2. Restrict IsMultiThread check to Unix only for compatibility with
6			https://bugs.freepascal.org/view.php?id=30535
7
8			3. New SQL Tokeniser added to IBUtils. This is used to pre-process SQL with
9			named parameters and is intended to avoid problems with (e.g.) Execute Block
10			and processing internal parameters as statement parameters.
11
12			4. New interface IFirebirdLibrary provides access to the underlying firebird DLL
13			or shared object. Available via a new member (GetFBLibrary) of IFirebirdAPI.
14
15			5. New function added to IB.pas
16
17			function LoadFBLibrary(aLibPathName: string): IFirebirdLibrary
18
19			This allows a Firebird Library to be loaded from an explicit path. use the
20			IFirebirdLibrary.GetFirebirdAPI member function to get the Firebird API using
21			the library. It is possible to load Firebird libraries from different locations
22			simultaneously, each with a distinct IFirebirdAPI.
23
24	tony	233	FBINTF Change Log version (1.1-2) Mon, 16 Apr 2018 09:30:32 +0100
25	tony	59
26	tony	209	1. Firebird.pas: {$OBJECTCHECKS OFF} added to file to avoid runtime error when
27			program compiled with -CR command line switch.
28
29			2. IServiceManager additions (informational):
30			function getProtocol: TProtocol;
31			function getPortNo: AnsiString;
32
33			3. IServiceManager improved error handling. Interfaces changed:
34			function Start(Request: ISRB; RaiseExceptionOnError: boolean=true): boolean;
35			function Query(SQPB: ISQPB; Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
36			function Query(Request: ISRB; RaiseExceptionOnError: boolean=true) :IServiceQueryResults; overload;
37
38			4. IAttachment addition (informational)
39			function GetSecurityDatabase: AnsiString;
40
41			5. IStatement: performance counters now updated after each Fetch. GetPerfStatistics
42			thus now returns accumulated stats for a select statement from opening a cursor
43			up to the last fetch.
44
45			6. DARWIN: uloadlibrary.inc bug fix. Many thanks to Luigi Naimi for correcting
46			the problem.
47
48			7. Type change: "TPerfCounters = array[TPerfStats] of Int64". Note "Int64"
49			replaces deprecated "comp" type.
50
51	tony	217	10. Testsuite Test10 updated to include thread synchronisation for event reporting.
52	tony	209
53	tony	231	11. URL Connection Strings: inet4 and inet6 now recognised.
54	tony	217
55	tony	231	12. IBUtils: Parse and Make Connect String now recognise URL style loopback syntax.
56
57	tony	233	13. IAttachment.CharSetName2CharSetID is now performed case insensitive.
58	tony	231
59	tony	233
60	tony	209	FBINTF Change Log version (1.1-1) Tue, 27 Feb 2018 16:51:16 +0000
61
62	tony	107	1. IBUtils.QuoteIdentifierIfNeeded: Add check for space character.
63
64	tony	109	2. IAttachment: add two new methods
65			function HasDefaultCharSet: boolean;
66			function GetDefaultCharSetID: integer;
67
68			These return, respectively, true if a connection default character set was
69	tony	117	specified and the character set id of the connection default character set.
70			The DefaultCharSetID is cached when the connection is opened and hence does not
71			require a database lookup.
72	tony	109
73	tony	110	3. Avoid exception when a text blob is a stored procedure parameter.
74	tony	109
75	tony	111	4. Update test suite to include a test for a stored proc returning a text blob.
76
77	tony	117	5. IAttachment: add
78			function GetRemoteProtocol: AnsiString;
79			function GetODSMajorVersion: integer;
80			function GetODSMinorVersion: integer;
81	tony	143	function GetAuthenticationMethod: AnsiString;
82	tony	117
83			These results are cached when the connection is opened and hence do not
84			require a database lookup.
85
86			6. IAttachment: add "function GetConnectString: AnsiString;" This returns the
87			connect string used to create/connect to the database.
88
89			7. IAttachment: Create Database using SQL statement. The username and password
90			are now extracted and used to populate a DPB made available via IAttachment.getDPB.
91			It is now possible to use IAttachment disconnect/connect to reconnect to
92			a database for which the initial connection was established by a create
93	tony	120	database sql statement. Available in FPC only.
94	tony	117
95			8. Update Test 1 to test 5, 6 and 7 above.
96
97			9. IBUtils code tidy up.
98
99	tony	143	10. Parameter Block interfaces "find" method. As documented, this should have
100			returned a nil interface when the item could not be found. Instead, an empty
101			interface item was returned. "Find" now works as documented and will return
102			a nil interface if the item cannot be found.
103
104			11. DBInformation: support added for isc_info_active_tran_count and isc_info_creation_date.
105
106			12. DBInformation: New interfaces: IDIRB and IDIRBItem added to support DB Information
107			requests with additional parameters. This is to enable support for fb_info_page_contents
108			(return of page contents). Response to fb_info_page_contents returned as
109			a string with code page CP_NONE.
110
111			13. DBInformation: Support for fb_info_pages_used and fb_info_pages_free added, plus
112			test suite updated.
113
114			14. DBInformation: Support for fb_info_crypt_key (Firebird 3.0.3 onwards) added as
115			a string type, and fb_info_conn_flags (Firebird 3.0.3 onwards) added as an integer type.
116
117			15. Service Manager: List of protocols supported expanded to include inet, wnet and xnet.
118			An overloaded version of IIFirebirdAPI.GetServiceManager also allows a non
119			default connection port to be specified.
120
121	tony	107	FBINTF Change Log version (1.1-0) Sun, 07 Jan 2018 15:20:02 +0000
122
123	tony	59	1. Fix issues with setting SQL Param values using SetAsString with Numeric types.
124			Scale is no longer ignored.
125
126			2. Fix issues with setting SQL Param values using SetAsString with Date values
127			not in locale format but which are recognised by Firebird. Date values that
128			cannot be converted to a string using Pascal library are now passed through
129			to Firebird as Text Strings.
130
131	tony	60	3. Lookup character set name by codepage amended to ensure that CP_UTF8 returns
132			UTF8 and not UNICODE_FSS.
133
134			4. Charset ID problem. When using Firebird 3, with no default database character set
135			and a column has a non-default collation specified, an incorrect character set
136			id was being reported that could result in a 'division by zero' error when
137			used by IBX. This has now been fixed.
138
139			5. Move GetCharsetName, CharSetID2CodePage, CodePage2CharSetID, CharSetName2CharSetID,
140			CharSetWidth from IFirebirdAPI to IAttachment. This is a better data model as
141			the character sets supported can be updated on a per database basis. That is
142			it is possible to add a (Firebird) user defined character set to a database.
143
144			6. Add RegisterCharSet to IAttachment. This is used to register a user defined character
145			set supported by Firebird with the API.
146
147	tony	61	7. Add missing isc_info_db_read_only to list of decoded Database Information items
148			in FBOutputBlock.pas and update test suite to include this item.
149	tony	60
150	tony	63	8. FB30Client: avoid always using "StartMultiple" when only a single database attachment.
151	tony	61
152	tony	68	9. Loading Windows fbclient.dll: when using the FIREBIRD variable to locate the client
153			library or finding it by disk location, the PATH environment variable is now also set to
154			include the FIREBIRD directory. This is to ensure that the correct dlls in the
155			firebird client library dependencies are loaded.
156	tony	63
157	tony	68	10. Testsuite: Ensure consistent UTF-8 output on Windows console.
158
159			11. Testsuite: Update Windows script to include FPC 3.0.4 in search path.
160
161			12. FB30Statement: Protect call to "Move" and avoid calling with a nil pointer
162
163			13. FB30Statement: A check has been added to ensure that all SQL Parameters
164			have been given a value (including NULL). Previously, failing to set the
165			value of an SQL Parameter could give rise to unpredictable results or
166			an SQLDA error.
167
168			14. FB30Statement/FB25Statement: Set SQLParam "modified" when string value set.
169
170	tony	70	15. FBAttachment: Avoid string reference count error when processing an Ansistring
171			parameter in an array of const passed to IAttachment.OpenCursor, etc.
172	tony	68
173	tony	70	16. FBAttachment: Allow for WideString and UnicodeString parameters in an array
174			of const passed to IAttachment.OpenCursor, etc.
175
176
177	tony	56	FBINTF Change Log version (1.0-2) Sat, 04 Mar 2017 14:43:56 +0000
178	tony	47
179	tony	56	1. Change syntax to Mode Delphi
180
181			2. Change all uses of string type to explicit AnsiString in order to ensure
182			compatibility between Delphi and FPC.
183
184			3. Various syntax changes to ensure Delphi and FPC compilation including GUIDs
185			defined for each interface.
186
187			4. Generics syntax variations for Delphi added
188
189			5. PChar replaced with PByte expect where an actual string is being referenced,
190			where PAnsiChar is used instead.
191
192			6. Review of type definitions in IBExternals to ensure Delphi compatibility
193
194			7. Testsuite updated for Delphi
195
196			FBINTF Change Log version (1.0-1) Fri, 24 Feb 2017 12:17:57 +0000
197
198	tony	47	1. Limit maximum Blob segment read/write to MaxuShort. Avoids data loss with
199			large blobs and the FB3 API.
200
201			2. Update Event Handling algorithm to avoid looping due to recreation of the
202			event block.
203
204			3. Avoid invalid XSQLDA error when the only parameter is updated to null
205
206			4. Array Handling: fix problem with text arrays with character set none. When the
207			DB connection has a default character set (e.g. UTF8), an error is raised by
208			Firebird if the space allocated is not enough to allow for transliteration, even
209			though it is not required for character set none.
210
211			5. IBUtils: List of reserved words brought up-to-date
212
213			6. Add ISQL style performance statistics collection to IStatement
214
215			7. Add IFirebirdAPI.CreateDatabase variant to allow execution of user provided
216			CREATE DATABASE statement.
217
218			8. Update SQL Statement parsing to allow for Array Dimensions. That is so that the ':' in
219			an array dimension is not mistaken for a named parameter prefix.
220
221			9. Trim function no longer applied to result of GetAsString for SQL_TEXT
222			when Character set is octets. Avoids loss of non printable characters at start of string.
223
224			10. Add function GetPerfStatistics to IStatement. This returns ISQL like performance
225			statistics for the last action. Requires use of procedure IStatement.EnableStatistics
226			to enable stats gathering.
227
228			11. API Version information added as constants to IB.pas
229
230			12. BlobMetaData character set id should now be the same as that given by IColumnMetaData.GetCharSetID
231
232			13. Firebird Character set "NONE" now interpreted as codepage CP_ACP.
233
234	tony	45	FBINTF Change Log version (1.0-0) Tue, 06 Dec 2016 10:33:47 +0000
235
236			1. Initial Release
237