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

FBINTF Change Log  version          (1.1-5 Build 11664) Thu, 11 Apr 2019 09:43:40 +0100

1. ISQLParams.GetHasCaseSensitiveParams added. Returns true if param names are
   case sensitive

2. Single line SQL comments starting with '--' are now recognised by SQL Parser.

FBINTF Change Log  version          (1.1-4 Build 11515)  Fri, 28 Dec 2018 10:04:19 +0000

1. Fix a problem with the SQL parameter parser that failed to recognise parameters
   where the second character of the parameter name is a numeric.

2. New method for IAttachment: procedure getFBVersion(version: TStrings);
   This returns the isc_version connection information as one or more lines.
   This is the same information as returned by isql with the -z option.

3. If -dFIREBIRD3APIONLY is used as a compiler option then the legacy Firebird API
   is no longer compiled in. Likewise, if -dLEGACYFIREBIRDAPIONLY is used as a
   compiler option then the Firebird 3 API is no longer compiled in.

4. IColumnMetaData: new method.

   TIBDateTimeFormats = (dfTimestamp, {SQL TIMESTAMP}
                        dfDateTime,   {SQL DATETIME}
                        dfTime);

   function GetDateTimeStrLength(DateTimeFormat: TIBDateTimeFormats): integer;

   This returns the max. number of characters returned by the "AsString" method
   when the SQL type of the column is respectively TIMESTAMP, DATETIME or TIME.

5. Additional argument for IAttachment.PrepareWithNamedParameters -
     CaseSensitiveParams: boolean = false

   If this argument is set to true then SQL parameter names are assumed to be case
   sensitive and must be referenced (using ISQLParams.ByName) using the case
   sensitive name.

6. Bug fix: when setting a query parameter, it is now possible, when the parameter
   is of type VarChar or Char to set the parameter to a numeric value (e.g. using
   .AsCurrency) and then subsequently to update the value to a non-numeric string
   using .AsString.


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