5.7.1-preview (#1064)

microsoft · Dec 3, 2019 · 8aaace8 · 8aaace8
1 parent bd06cf3
commit 8aaace8
Show file tree

Hide file tree

Showing 63 changed files with 3,757 additions and 199 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -20,10 +20,10 @@ env:
   - TEST_PHP_SQL_PWD=Password123
 
 before_install:
-  - docker pull mcr.microsoft.com/mssql/server:2019-CTP2.4-ubuntu
+  - docker pull mcr.microsoft.com/mssql/server:2019-GA-ubuntu-16.04
 
 install:
-  - docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=Password123' -p 1433:1433 --name=$TEST_PHP_SQL_SERVER -d mcr.microsoft.com/mssql/server:2019-CTP2.4-ubuntu
+  - docker run -e 'ACCEPT_EULA=Y' -e 'SA_PASSWORD=Password123' -p 1433:1433 --name=$TEST_PHP_SQL_SERVER -d mcr.microsoft.com/mssql/server:2019-CTP3.2-ubuntu
   - docker build --build-arg PHPSQLDIR=$PHPSQLDIR -t msphpsql-dev -f Dockerfile-msphpsql .
 
 before_script:

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,39 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 
+## 5.7.1-preview - 2019-12-03
+Updated PECL release packages. Here is the list of updates:
+
+### Added
+- Support for PHP 7.4
+- Support for Red Hat 8 and macOS Catalina (10.15)
+- Feature Request [#1018](https://github.com/microsoft/msphpsql/issues/1018) - support for [PHP extended string types](https://github.com/microsoft/msphpsql/wiki/Features#natlTypes) - Pull Request [#1043](https://github.com/microsoft/msphpsql/pull/1043)
+- [Always Encrypted with secure enclaves](https://github.com/microsoft/msphpsql/wiki/Features#alwaysencryptedV2), which requires [MS ODBC Driver 17.4+](https://docs.microsoft.com/sql/connect/odbc/download-odbc-driver-for-sql-server?view=sql-server-ver15) and [SQL Server 2019](https://www.microsoft.com/sql-server/sql-server-2019)
+
+### Removed
+- Dropped support for [PHP 7.1](https://www.php.net/supported-versions.php)
+
+### Fixed
+- Issue [#1027](https://github.com/microsoft/msphpsql/issues/1027) - Fixed how drivers handle query timeout settings
+- Pull Request [#1049](https://github.com/microsoft/msphpsql/pull/1049) - performance improvement for fetching from tables with many columns - cached the derived php types with column metadata to streamline data retrieval
+
+### Limitations
+- No support for inout / output params when using sql_variant type
+- No support for inout / output params when formatting decimal values
+- In Linux and macOS, setlocale() only takes effect if it is invoked before the first connection. Attempting to set the locale after connecting will not work
+- Always Encrypted requires [MS ODBC Driver 17+](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server)
+  - Only Windows Certificate Store and Azure Key Vault are supported. Custom Keystores are not yet supported
+  - Issue [#716](https://github.com/Microsoft/msphpsql/issues/716) - With Always Encrypted enabled, named parameters in subqueries are not supported
+  - Issue [#1050](https://github.com/microsoft/msphpsql/issues/1050) - With Always Encrypted enabled, insertion requires the column list for any tables with identity columns
+  - [Always Encrypted limitations](https://docs.microsoft.com/sql/connect/php/using-always-encrypted-php-drivers#limitations-of-the-php-drivers-when-using-always-encrypted)
+
+### Known Issues
+- Data Classification metadata retrieval requires ODBC Driver 17.4.2.1+ and [SQL Server 2019](https://www.microsoft.com/sql-server/sql-server-2019)
+- Connection pooling on Linux or macOS is not recommended with [unixODBC](http://www.unixodbc.org/) < 2.3.7
+- When pooling is enabled in Linux or macOS
+  - unixODBC <= 2.3.4 (Linux and macOS) might not return proper diagnostic 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)
+
 ## 5.7.0-preview - 2019-09-05
 Updated PECL release packages. Here is the list of updates:
 

diff --git a/Linux-mac-install.md b/Linux-mac-install.md
@@ -1,50 +1,50 @@
 # Linux and macOS Installation Tutorial for the Microsoft Drivers for PHP for SQL Server
-The following instructions assume a clean environment and show how to install PHP 7.x, the Microsoft ODBC driver, Apache, and the Microsoft Drivers for PHP for SQL Server on Ubuntu 16.04, 18.04, and 18.10, RedHat 7, Debian 8 and 9, Suse 12 and 15, and macOS 10.11, 10.12, 10.13, and 10.14. These instructions advise installing the drivers using PECL, but you can also download the prebuilt binaries from the [Microsoft Drivers for PHP for SQL Server](https://github.com/Microsoft/msphpsql/releases) Github project page and install them following the instructions in [Loading the Microsoft Drivers for PHP for SQL Server](https://docs.microsoft.com/sql/connect/php/loading-the-php-sql-driver). For an explanation of extension loading and why we do not add the extensions to php.ini, see the section on [loading the drivers](https://docs.microsoft.com/sql/connect/php/loading-the-php-sql-driver##loading-the-driver-at-php-startup).
+The following instructions assume a clean environment and show how to install PHP 7.x, the Microsoft ODBC driver, Apache, and the Microsoft Drivers for PHP for SQL Server on Ubuntu, RedHat, Debian, Suse, and macOS. These instructions advise installing the drivers using PECL, but you may also download the prebuilt binaries from the [Microsoft Drivers for PHP for SQL Server](https://github.com/Microsoft/msphpsql/releases) Github project page and install them following the instructions in [Loading the Microsoft Drivers for PHP for SQL Server](https://docs.microsoft.com/sql/connect/php/loading-the-php-sql-driver). For an explanation of extension loading and why we do not add the extensions to php.ini, see the section on [loading the drivers](https://docs.microsoft.com/sql/connect/php/loading-the-php-sql-driver##loading-the-driver-at-php-startup).
 
-These instructions install PHP 7.3 by default. Note that some supported Linux distros default to PHP 7.0 or earlier, which is not supported for the PHP drivers for SQL Server -- please see the notes at the beginning of each section to install PHP 7.1 or 7.2 instead.
+These instructions install PHP 7.4 by default. Note that some supported Linux distros default to PHP 7.1 or earlier, which the PHP drivers for SQL Server no longer support. When installing PHP 7.2 or above, please read the notes at the beginning of each section below.
 
 ## Contents of this page:
 
 - [Installing the drivers on Ubuntu 16.04, 18.04, and 19.04](#installing-the-drivers-on-ubuntu-1604-1804-and-1904)
-- [Installing the drivers on Red Hat 7](#installing-the-drivers-on-red-hat-7)
+- [Installing the drivers on Red Hat 7 and 8](#installing-the-drivers-on-red-hat-7-and-8)
 - [Installing the drivers on Debian 8, 9 and 10](#installing-the-drivers-on-debian-8-9-and-10)
 - [Installing the drivers on Suse 12 and 15](#installing-the-drivers-on-suse-12-and-15)
-- [Installing the drivers on macOS Sierra, High Sierra, and Mojave](#installing-the-drivers-on-macos-sierra-high-sierra-and-mojave)
+- [Installing the drivers on macOS Sierra, High Sierra, Mojave, and Catalina](#installing-the-drivers-on-macos-sierra-high-sierra-mojave-and-catalina)
 
 ## Installing the drivers on Ubuntu 16.04, 18.04, and 19.04
 
 > [!NOTE]
-> To install PHP 7.1 or 7.2, replace 7.3 with 7.1 or 7.2 in the following commands.
+> To install PHP 7.3 or 7.2, replace 7.4 with 7.3 or 7.2 in the following commands.
 
 ### Step 1. Install PHP
 ```
 sudo su
 add-apt-repository ppa:ondrej/php -y
 apt-get update
-apt-get install php7.3 php7.3-dev php7.3-xml -y --allow-unauthenticated
+apt-get install php7.4 php7.4-dev php7.4-xml -y --allow-unauthenticated
 ```
 ### Step 2. Install prerequisites
 Install the ODBC driver for Ubuntu by following the instructions on the [Linux and macOS installation page](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server).
 
 ### Step 3. Install the PHP drivers for Microsoft SQL Server
 ```
-sudo pecl install sqlsrv
-sudo pecl install pdo_sqlsrv
+sudo pecl install sqlsrv-5.7.1preview
+sudo pecl install pdo_sqlsrv-5.7.1preview
 sudo su
-printf "; priority=20\nextension=sqlsrv.so\n" > /etc/php/7.3/mods-available/sqlsrv.ini
-printf "; priority=30\nextension=pdo_sqlsrv.so\n" > /etc/php/7.3/mods-available/pdo_sqlsrv.ini
+printf "; priority=20\nextension=sqlsrv.so\n" > /etc/php/7.4/mods-available/sqlsrv.ini
+printf "; priority=30\nextension=pdo_sqlsrv.so\n" > /etc/php/7.4/mods-available/pdo_sqlsrv.ini
 exit
-sudo phpenmod -v 7.3 sqlsrv pdo_sqlsrv
+sudo phpenmod -v 7.4 sqlsrv pdo_sqlsrv
 ```
 If there is only one PHP version in the system then the last step can be simplified to `phpenmod sqlsrv pdo_sqlsrv`.
 
 ### Step 4. Install Apache and configure driver loading
 ```
 sudo su
-apt-get install libapache2-mod-php7.3 apache2
+apt-get install libapache2-mod-php7.4 apache2
 a2dismod mpm_event
 a2enmod mpm_prefork
-a2enmod php7.3
+a2enmod php7.4
 exit
 ```
 ### Step 5. Restart Apache and test the sample script
@@ -53,10 +53,10 @@ sudo service apache2 restart
 ```
 To test your installation, see [Testing your installation](#testing-your-installation) at the end of this document.
 
-## Installing the drivers on Red Hat 7
+## Installing the drivers on Red Hat 7 and 8
 
 > [!NOTE]
-> To install PHP 7.1 or 7.2, replace remi-php73 with remi-php71 or remi-php72 respectively in the following commands.
+> To install PHP 7.3 or 7.2, replace remi-php74 with remi-php73 or remi-php72 respectively in the following commands.
 
 ### Step 1. Install PHP
 
@@ -67,33 +67,33 @@ wget https://rpms.remirepo.net/enterprise/remi-release-7.rpm
 rpm -Uvh remi-release-7.rpm epel-release-latest-7.noarch.rpm
 subscription-manager repos --enable=rhel-7-server-optional-rpms
 yum install yum-utils
-yum-config-manager --enable remi-php73
+yum-config-manager --enable remi-php74
 yum update
 yum install php php-pdo php-xml php-pear php-devel re2c gcc-c++ gcc
 ```
 ### Step 2. Install prerequisites
-Install the ODBC driver for Red Hat 7 by following the instructions on the [Linux and macOS installation page](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server).
+Install the ODBC driver for Red Hat 7 and 8 by following the instructions on the [Linux and macOS installation page](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server).
 
-Compiling the PHP drivers with PECL with PHP 7.2 or 7.3 requires a more recent GCC than the default:
+In some versions of Red Hat 7, compiling the PHP drivers with PECL and PHP 7.2 requires a more recent GCC than the default:
 ```
 sudo yum-config-manager --enable rhel-server-rhscl-7-rpms
 sudo yum install devtoolset-7
 scl enable devtoolset-7 bash
 ```
 ### Step 3. Install the PHP drivers for Microsoft SQL Server
 ```
-sudo pecl install sqlsrv
-sudo pecl install pdo_sqlsrv
+sudo pecl install sqlsrv-5.7.1preview
+sudo pecl install pdo_sqlsrv-5.7.1preview
 sudo su
 echo extension=pdo_sqlsrv.so >> `php --ini | grep "Scan for additional .ini files" | sed -e "s|.*:\s*||"`/30-pdo_sqlsrv.ini
 echo extension=sqlsrv.so >> `php --ini | grep "Scan for additional .ini files" | sed -e "s|.*:\s*||"`/20-sqlsrv.ini
 exit
 ```
 An issue in PECL may prevent correct installation of the latest version of the drivers even if you have upgraded GCC. To install, download the packages and compile manually (similar steps for pdo_sqlsrv):
 ```
-pecl download sqlsrv
-tar xvzf sqlsrv-5.7.0.tgz
-cd sqlsrv-5.7.0/
+pecl download sqlsrv-5.7.1preview
+tar xvzf sqlsrv-5.7.1preview.tgz
+cd sqlsrv-5.7.1preview/
 phpize
 ./configure --with-php-config=/usr/bin/php-config
 make
@@ -120,7 +120,7 @@ To test your installation, see [Testing your installation](#testing-your-install
 ## Installing the drivers on Debian 8, 9 and 10
 
 > [!NOTE]
-> To install PHP 7.1 or 7.2, replace 7.3 in the following commands with 7.1 or 7.2.
+> To install PHP 7.3 or 7.2, replace 7.4 in the following commands with 7.3 or 7.2.
 
 ### Step 1. Install PHP
 ```
@@ -129,7 +129,7 @@ apt-get install curl apt-transport-https
 wget -O /etc/apt/trusted.gpg.d/php.gpg https://packages.sury.org/php/apt.gpg
 echo "deb https://packages.sury.org/php/ $(lsb_release -sc) main" > /etc/apt/sources.list.d/php.list
 apt-get update
-apt-get install -y php7.3 php7.3-dev php7.3-xml
+apt-get install -y php7.4 php7.4-dev php7.4-xml
 ```
 ### Step 2. Install prerequisites
 Install the ODBC driver for Debian by following the instructions on the [Linux and macOS installation page](https://docs.microsoft.com/sql/connect/odbc/linux-mac/installing-the-microsoft-odbc-driver-for-sql-server). 
@@ -143,23 +143,23 @@ locale-gen
 
 ### Step 3. Install the PHP drivers for Microsoft SQL Server
 ```
-sudo pecl install sqlsrv
-sudo pecl install pdo_sqlsrv
+sudo pecl install sqlsrv-5.7.1preview
+sudo pecl install pdo_sqlsrv-5.7.1preview
 sudo su
-printf "; priority=20\nextension=sqlsrv.so\n" > /etc/php/7.3/mods-available/sqlsrv.ini
-printf "; priority=30\nextension=pdo_sqlsrv.so\n" > /etc/php/7.3/mods-available/pdo_sqlsrv.ini
+printf "; priority=20\nextension=sqlsrv.so\n" > /etc/php/7.4/mods-available/sqlsrv.ini
+printf "; priority=30\nextension=pdo_sqlsrv.so\n" > /etc/php/7.4/mods-available/pdo_sqlsrv.ini
 exit
-sudo phpenmod -v 7.3 sqlsrv pdo_sqlsrv
+sudo phpenmod -v 7.4 sqlsrv pdo_sqlsrv
 ```
 If there is only one PHP version in the system then the last step can be simplified to `phpenmod sqlsrv pdo_sqlsrv`.
 
 ### Step 4. Install Apache and configure driver loading
 ```
 sudo su
-apt-get install libapache2-mod-php7.3 apache2
+apt-get install libapache2-mod-php7.4 apache2
 a2dismod mpm_event
 a2enmod mpm_prefork
-a2enmod php7.3
+a2enmod php7.4
 ```
 ### Step 5. Restart Apache and test the sample script
 ```
@@ -173,9 +173,9 @@ To test your installation, see [Testing your installation](#testing-your-install
 > In the following instructions, replace <SuseVersion> with your version of Suse - if you are using Suse Enterprise Linux 15, it will be SLE_15 or SLE_15_SP1. For Suse 12, use SLE_12_SP4 (or above if applicable). Not all versions of PHP are available for all versions of Suse Linux - please refer to `http://download.opensuse.org/repositories/devel:/languages:/php` to see which versions of Suse have the default version PHP available, or to `http://download.opensuse.org/repositories/devel:/languages:/php:/` to see which other versions of PHP are available for which versions of Suse.
 
 > [!NOTE]
-> Packages for PHP 7.3 are not available for Suse 12. 
-> To install PHP 7.1, replace the repository URL below with the following URL:
-      `https://download.opensuse.org/repositories/devel:/languages:/php:/php71/<SuseVersion>/devel:languages:php:php71.repo`.
+> Packages for PHP 7.4 are not available for Suse 12. 
+> To install PHP 7.3, replace the repository URL below with the following URL:
+      `https://download.opensuse.org/repositories/devel:/languages:/php:/php73/<SuseVersion>/devel:languages:php:php73.repo`.
 > To install PHP 7.2, replace the repository URL below with the following URL:
       `https://download.opensuse.org/repositories/devel:/languages:/php:/php72/<SuseVersion>/devel:languages:php:php72.repo`.
 
@@ -194,8 +194,8 @@ Install the ODBC driver for Suse by following the instructions on the [Linux and
 > If you get an error message saying `Connection to 'pecl.php.net:443' failed: Unable to find the socket transport "ssl"`, edit the pecl script at /usr/bin/pecl and remove the `-n` switch in the last line. This switch prevents PECL from loading ini files when PHP is called, which prevents the OpenSSL extension from loading.
 
 ```
-sudo pecl install sqlsrv
-sudo pecl install pdo_sqlsrv
+sudo pecl install sqlsrv-5.7.1preview
+sudo pecl install pdo_sqlsrv-5.7.1preview
 sudo su
 echo extension=pdo_sqlsrv.so >> `php --ini | grep "Scan for additional .ini files" | sed -e "s|.*:\s*||"`/pdo_sqlsrv.ini
 echo extension=sqlsrv.so >> `php --ini | grep "Scan for additional .ini files" | sed -e "s|.*:\s*||"`/sqlsrv.ini
@@ -216,26 +216,26 @@ sudo systemctl restart apache2
 ```
 To test your installation, see [Testing your installation](#testing-your-installation) at the end of this document.
 
-## Installing the drivers on macOS Sierra, High Sierra, and Mojave
+## Installing the drivers on macOS Sierra, High Sierra, Mojave, and Catalina
 
 If you do not already have it, install brew as follows:
 ```
 /usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 ```
 
 > [!NOTE]
-> To install PHP 7.1 or 7.2, replace php@7.3 with php@7.1 or php@7.2 respectively in the following commands.
+> To install PHP 7.3 or 7.2, replace php@7.4 with php@7.3 or php@7.2 respectively in the following commands.
 
 ### Step 1. Install PHP
 
 ```
 brew tap
 brew tap homebrew/core
-brew install php@7.3
+brew install php@7.4
 ```
 PHP should now be in your path -- run `php -v` to verify that you are running the correct version of PHP. If PHP is not in your path or it is not the correct version, run the following:
 ```
-brew link --force --overwrite php@7.3
+brew link --force --overwrite php@7.4
 ```
 
 ### Step 2. Install prerequisites
@@ -248,8 +248,8 @@ brew install autoconf automake libtool
 
 ### Step 3. Install the PHP drivers for Microsoft SQL Server
 ```
-sudo pecl install sqlsrv
-sudo pecl install pdo_sqlsrv
+sudo pecl install sqlsrv-5.7.1preview
+sudo pecl install pdo_sqlsrv-5.7.1preview
 ```
 ### Step 4. Install Apache and configure driver loading
 ```
@@ -261,7 +261,7 @@ apachectl -V | grep SERVER_CONFIG_FILE
 ``` 
 and substitute the path for `httpd.conf` in the following commands:
 ```
-echo "LoadModule php7_module /usr/local/opt/php@7.3/lib/httpd/modules/libphp7.so" >> /usr/local/etc/httpd/httpd.conf
+echo "LoadModule php7_module /usr/local/opt/php@7.4/lib/httpd/modules/libphp7.so" >> /usr/local/etc/httpd/httpd.conf
 (echo "<FilesMatch .php$>"; echo "SetHandler application/x-httpd-php"; echo "</FilesMatch>";) >> /usr/local/etc/httpd/httpd.conf
 ```
 ### Step 5. Restart Apache and test the sample script