Updates to change log and readme (#811)
* Updates to change log and readme * Dropped support for Ubuntu 17 * Modified as per review comments
This commit is contained in:
parent
5aa9be7e13
commit
bbfe6df4cd
35
CHANGELOG.md
35
CHANGELOG.md
|
@ -3,6 +3,41 @@ All notable changes to this project will be documented in this file.
|
||||||
|
|
||||||
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
The format is based on [Keep a Changelog](http://keepachangelog.com/)
|
||||||
|
|
||||||
|
## 5.3.0 - 2018-07-20
|
||||||
|
Updated PECL release packages. Here is the list of updates:
|
||||||
|
|
||||||
|
### Added
|
||||||
|
- Added support for Azure Key Vault for Always Encrypted for basic CRUD functionalities such that Always Encrypted feature is available to all supported Windows, Linux or macOS platforms
|
||||||
|
- Added support for macOS High Sierra (requires [MS ODBC Driver 17+](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server?view=sql-server-2017))
|
||||||
|
- Added support for Ubuntu 18.04 LTS (requires MS ODBC Driver 17.2)
|
||||||
|
- Added support for Connection Resiliency to make it available to Linux or macOS users as well (requires MS ODBC Driver 17.2)
|
||||||
|
|
||||||
|
### Fixed
|
||||||
|
- Issue [#577](https://github.com/Microsoft/msphpsql/issues/577) - Idle Connection Resiliency doesn't work with Column Encryption enabled connection
|
||||||
|
- Issue [#678](https://github.com/Microsoft/msphpsql/issues/678) - Idle Connection Resiliency doesn't work with Connection Pooling bug
|
||||||
|
- Issue [#699](https://github.com/Microsoft/msphpsql/issues/699) - Binding output parameter failed when the query in the stored procedure returned no data. The test case has been added to the test lab.
|
||||||
|
- Issue [#705](https://github.com/Microsoft/msphpsql/issues/705) - Always Encrypted - Retrieving a negative decimal value (edge case) as output parameter causes truncation
|
||||||
|
- Issue [#706](https://github.com/Microsoft/msphpsql/issues/706) - Always Encrypted - Cannot insert double with precision and scale (38, 38)
|
||||||
|
- Issue [#707](https://github.com/Microsoft/msphpsql/issues/707) - Always Encrypted - Fetching decimals / numerics as output parameters bound to PDO::PARAM_BOOL or PDO::PARAM_INT returns floats, not integers
|
||||||
|
- Issue [#735](https://github.com/Microsoft/msphpsql/issues/735) - Extended the buffer size for PDO lastInsertId such that data types other than integers can be supported
|
||||||
|
- Pull Request [#759](https://github.com/Microsoft/msphpsql/pull/759) - Removed the limitation of binding a binary as inout param as PDO::PARAM_STR with SQLSRV_ENCODING_BINARY
|
||||||
|
- Pull Request [#775](https://github.com/Microsoft/msphpsql/pull/775) - Fixed the problem for output params with SQL types specified as SQLSRV_SQLTYPE_DECIMAL or SQLSRV_SQLTYPE_NUMERIC
|
||||||
|
|
||||||
|
### Limitations
|
||||||
|
- No support for inout / output params when using sql_variant type
|
||||||
|
- In Linux and macOS, setlocale() only takes effect if it is invoked before the first connection. Attempting to set the locale after connection will not work
|
||||||
|
- Always Encrypted feature, which requires [MS ODBC Driver 17+](https://docs.microsoft.com/en-us/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server?view=sql-server-2017)
|
||||||
|
- only Windows Certificate Store and Azure Key Vault are supported
|
||||||
|
- Issue [#716](https://github.com/Microsoft/msphpsql/issues/716) - With Always Encrypted feature enabled, Named Parameters in Sub Queries are not supported
|
||||||
|
- [Always Encrypted limitations](https://docs.microsoft.com/en-us/sql/connect/php/using-always-encrypted-php-drivers?view=sql-server-2017#limitations-of-the-php-drivers-when-using-always-encrypted)
|
||||||
|
|
||||||
|
### Known Issues
|
||||||
|
- Connection pooling on Linux or macOS not recommended with [unixODBC](http://www.unixodbc.org/) < 2.3.6
|
||||||
|
- When pooling is enabled in Linux or macOS
|
||||||
|
- unixODBC <= 2.3.4 (Linux and macOS) might not return proper diagnostics information, such as error messages, warnings and informative messages
|
||||||
|
- due to this unixODBC bug, fetch large data (such as xml, binary) as streams as a workaround. See the examples [here](https://github.com/Microsoft/msphpsql/wiki/Features#pooling)
|
||||||
|
- With ColumnEncryption enabled, calling stored procedures with XML parameters does not work (Issue [#674](https://github.com/Microsoft/msphpsql/issues/674))
|
||||||
|
|
||||||
## 5.2.1-preview - 2018-06-01
|
## 5.2.1-preview - 2018-06-01
|
||||||
Updated PECL release packages. Here is the list of updates:
|
Updated PECL release packages. Here is the list of updates:
|
||||||
|
|
||||||
|
|
18
README.md
18
README.md
|
@ -47,7 +47,7 @@ For full details on the system requirements for the drivers, see the [system req
|
||||||
On the client machine:
|
On the client machine:
|
||||||
- PHP 7.0.x, 7.1.x, or 7.2.x (7.2.0 and up on Unix, 7.2.1 and up on Windows)
|
- PHP 7.0.x, 7.1.x, or 7.2.x (7.2.0 and up on Unix, 7.2.1 and up on Windows)
|
||||||
- A Web server such as Internet Information Services (IIS) is required. Your Web server must be configured to run PHP
|
- A Web server such as Internet Information Services (IIS) is required. Your Web server must be configured to run PHP
|
||||||
- [Microsoft ODBC Driver 17][odbc17], [Microsoft ODBC Driver 13][odbc13], or [Microsoft ODBC Driver 11][odbc11]
|
- [Microsoft ODBC Driver 17, Microsoft ODBC Driver 13, or Microsoft ODBC Driver 11](https://docs.microsoft.com/en-us/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-2017)
|
||||||
|
|
||||||
On the server side, Microsoft SQL Server 2008 R2 and above on Windows are supported, as are Microsoft SQL Server 2016 and above on Linux.
|
On the server side, Microsoft SQL Server 2008 R2 and above on Windows are supported, as are Microsoft SQL Server 2016 and above on Linux.
|
||||||
|
|
||||||
|
@ -86,14 +86,14 @@ The version number may have trailing pre-release version identifiers to indicate
|
||||||
- Build metadata may be denoted by a plus sign followed by 4 or 5 digits, such as `1.2.3-preview+5678` or `1.2.3+5678`. Build metadata does not figure into the precedence order.
|
- Build metadata may be denoted by a plus sign followed by 4 or 5 digits, such as `1.2.3-preview+5678` or `1.2.3+5678`. Build metadata does not figure into the precedence order.
|
||||||
|
|
||||||
## Future Plans
|
## Future Plans
|
||||||
- Expand SQL Server 2016 feature support (example: Always Encrypted)
|
- Expand SQL Server 2016 feature support (example: Azure AD)
|
||||||
- Add more verification/fundamental tests
|
- Add more verification/fundamental tests
|
||||||
- Bug fixes
|
- Bug fixes
|
||||||
|
|
||||||
## Guidelines for Reporting Issues
|
## Guidelines for Reporting Issues
|
||||||
We appreciate you taking the time to test the driver, provide feedback and report any issues. It would be extremely helpful if you:
|
We appreciate you taking the time to test the driver, provide feedback and report any issues. It would be extremely helpful if you:
|
||||||
|
|
||||||
- First check the [FAQ](https://github.com/Microsoft/msphpsql/wiki/FAQ)
|
- First check the [FAQ](https://github.com/Microsoft/msphpsql/wiki/FAQ) for common problems
|
||||||
- Report each issue as a new issue (but check first if it's already been reported)
|
- Report each issue as a new issue (but check first if it's already been reported)
|
||||||
- Please address the questions in the new issue template and provide scripts, table schema, and/or any details that may help reproduce the problem(s)
|
- Please address the questions in the new issue template and provide scripts, table schema, and/or any details that may help reproduce the problem(s)
|
||||||
|
|
||||||
|
@ -106,11 +106,11 @@ Thank you!
|
||||||
|
|
||||||
**Q:** What's next?
|
**Q:** What's next?
|
||||||
|
|
||||||
**A:** On March 23, 2018 we released the production release version 5.2.0 of our PHP Driver. We will continue working on our future plans and releasing previews of upcoming releases frequently.
|
**A:** On July 20, 2018 we released the production release version 5.3.0 of our PHP Driver. We will continue working on our future plans and releasing previews of upcoming releases.
|
||||||
|
|
||||||
**Q:** Is Microsoft taking pull requests for this project?
|
**Q:** Is Microsoft taking pull requests for this project?
|
||||||
|
|
||||||
**A:** Yes. Please submit pull requests to the **dev** branch and not the **master** branch.
|
**A:** Yes. Please submit pull requests to the **dev** branch, not the **master** branch.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
@ -138,12 +138,6 @@ This project has adopted the Microsoft Open Source Code of Conduct. For more inf
|
||||||
|
|
||||||
[phpbuild]: https://wiki.php.net/internals/windows/stepbystepbuild
|
[phpbuild]: https://wiki.php.net/internals/windows/stepbystepbuild
|
||||||
|
|
||||||
[phpdoc]: http://msdn.microsoft.com/library/dd903047%28SQL.11%29.aspx
|
[phpdoc]: https://docs.microsoft.com/en-us/sql/connect/php/microsoft-php-driver-for-sql-server?view=sql-server-2017
|
||||||
|
|
||||||
[odbc11]: https://www.microsoft.com/download/details.aspx?id=36434
|
|
||||||
|
|
||||||
[odbc13]: https://www.microsoft.com/download/details.aspx?id=50420
|
|
||||||
|
|
||||||
[odbc17]: https://www.microsoft.com/download/details.aspx?id=56567
|
|
||||||
|
|
||||||
[PHPMan]: http://php.net/manual/install.unix.php
|
[PHPMan]: http://php.net/manual/install.unix.php
|
||||||
|
|
Loading…
Reference in a new issue