Articles in this section

See more

 How to install 'sqlsrv' extension for Plesk PHP handlers?

Avatar
Taras Ermoshin
Updated
Follow
kb: how-to Plesk for Linux

Applicable to:

  • Plesk for Linux

Question

It is required to connect to Microsoft SQL Server (MS SQL) databases via PHP script on a Plesk for Linux server.

What extension should be installed and how it can be done?

Answer

PHP extensions sqlsrv and pdo_sqlsrv should be installed and enabled for PHP handlers:

Warning: These extensions were not properly tested with Plesk and are not officially supported. Perform all operations at your own risk.

Warning: These extensions do not yet support operating systems AlmaLinux/RHEL 9, Debian 12, Ubuntu 24.04.

Note: These extensions are only for PHP 7.x and 8.x.
Instructions cover only operating systems supported both by Plesk and PHP extensions sqlsrv and pdo_sqlsrv:
-CentOS/RHEL/CloudLinux 7.x
-AlmaLinux/RHEL/CloudLinux/Rocky Linux 8.x
-Debian 10, 11
-Ubuntu 18.04, 20.04, 22.04

  1. Connect to the server using SSH.

  2. Install necessary packages:

    • on CentOS/AlmaLinux/RHEL/CloudLinux/Rocky Linux:

      # yum install unixODBC-devel make gcc-c++ gcc autoconf automake libtool-ltdl.x86_64 libtool-ltdl-devel.x86_64 plesk-phpXX-devel

      Note: "XX" in plesk-phpXX-devel should be replaced with the PHP version. For example, "74" for PHP 7.4, or "82" for PHP 8.2.

    • on Ubuntu and Debian:

      # apt install apt-transport-https make gcc g++ unixodbc unixodbc-dev plesk-phpXX-dev

      Note: "XX" in plesk-phpXX-dev should be replaced with the PHP version. For example, "74" for PHP 7.4, or "82" for PHP 8.2.

  3. Install Microsoft ODBC driver for SQL Server on which PHP extensions sqlsrv and pdo_sqlsrv rely on to handle the low-level communication with SQL Server:

    • on CentOS/AlmaLinux/RHEL/CloudLinux/Rocky Linux:

      # curl https://packages.microsoft.com/config/rhel/X/prod.repo > /etc/yum.repos.d/mssql-release.repo
      # yum remove unixODBC-utf16 unixODBC-utf16-devel
      # ACCEPT_EULA=Y yum install msodbcsql18

      Note: replace "X" in the curl command with "7" or "8" depending on the major version of used operating system.

    • on Ubuntu and Debian:

      Note: The below example is for Ubuntu 22.04. If another Ubuntu or Debian version is used, replace the highlighted URL part accordingly, with, for example, "ubuntu/20.04" for Ubuntu 20.04, or "debian/10" for Debian 10.

      # curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
      # curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
      # apt update
      # ACCEPT_EULA=Y apt install msodbcsql18

  4. Install PHP extensions sqlsrv and pdo_sqlsrv:

    • for PHP versions 7.3 and later in Plesk Obsidian 18.0.49 and later: in the Plesk interface by following instructions from the article How to install PECL packages in Plesk?

      Note: Extensions can be installed using only their names sqlsrv and pdo_sqlsrv only for PHP 8.1-8.3.
      For PHP versions 7.3-8.0, specific versions of the extensions must be specified in a dialog window which appears after clicking Install package:
      sqlsrv-5.9.0 for PHP 7.3
      sqlsrv-5.10.1 for PHP 7.4
      sqlsrv-5.11.1 for PHP 8.0
      sqlsrv-5.11.1 on Ubuntu 18.04 and with PHP 8.1-8.3.

      Note: Plesk PHP handler 7.3 is available only on CentOS/RHEL/CloudLinux 7.x, AlmaLinux/RHEL/CloudLinux/Rocky Linux 8.x, Ubuntu 18.04, 20.04, and Debian 10.

    • for PHP versions 7.0-7.2:

      # /opt/plesk/php/7.X/bin/pecl install pdo_sqlsrv-5.X.X
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/7.X/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/7.X/bin/pecl install sqlsrv-5.X.X
      # echo "extension=sqlsrv.so" > /opt/plesk/php/7.X/etc/php.d/sqlsrv.ini

      Note: "7.X" should be replaced with the used PHP version.
      "5.X.X" should be replaced with correct PHP extensions versions:
      "5.3.0" for PHP 7.0
      "5.6.1" for PHP 7.1
      "5.8.1" for PHP 7.2

      Note: Plesk PHP handlers 7.0-7.2 are available only on specific operating systems:
      PHP 7.0 - on CentOS/RHEL/CloudLinux 7.x and Ubuntu 18.04;
      PHP 7.1 and 7.2 - on CentOS/RHEL/CloudLinux 7.x, AlmaLinux/RHEL/CloudLinux/Rocky Linux 8.x, Ubuntu 18.04, 20.04, and Debian 10;

  5. (Only for CLI installation) Reread PHP handlers:

    # plesk bin php_handler --reread

  6. (Only for CLI installation) Reread the components properties to make installed extensions visible in the Plesk interface:

    # plesk sbin packagemng -sdf

  7. Check that the required modules are enabled:

    # /opt/plesk/php/X.X/bin/php -m | grep sqlsrv
    pdo_sqlsrv
    sqlsrv

    Note: "7.X" is to be replaced with the PHP version. For example, "7.4" for PHP 7.4, or "8.2" for PHP 8.2.

  8. Restart the PHP-FPM master process to apply changes to domains which use PHP-FPM.

Additional information

Instructions are based on the official Microsoft documentation and adapted for Plesk PHP handlers:

Linux and macOS Installation Tutorial for the Microsoft Drivers for PHP for SQL Server
Install the Microsoft ODBC driver for SQL Server (Linux)

It is also possible to use an older system version of PHP. For example, in order to connect to MSSQL on CentOS 7 with system PHP version 5.4, the following command needed to be executed:

# yum install epel-release
# yum install php-mssql

Ubuntu 18.04/20.04 with Plesk PHP 8.0/7.3/7.4

  1. Connect to the server via SSH.

  2. Install necessary packages:

    # apt-get install apt-transport-https make gcc g++ unixodbc unixodbc-dev plesk-php7X-dev

    Note: "7X" is to be replaced with the PHP version. For example, "74" for PHP 7.4

  3. Install the msodbcsql package:

    Note: This step is unique for each OS. The following example is for Ubuntu 18.04. If Debian is used, replaced the URL accordingly (for ie: "/debian/10/" or "/ubuntu/20.04/")

    # curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
    # curl https://packages.microsoft.com/config/ubuntu/18.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
    # apt-get update
    # ACCEPT_EULA=Y apt-get install msodbcsql18

  4. Add the pdo_sqlsrv and sqlsrv-5.8.1 modules:

    • For PHP 8.0 provided by Plesk:

      # /opt/plesk/php/8.0/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/8.0/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/sqlsrv.ini

    • For PHP 7.3/7.4 provided by Plesk:

      # /opt/plesk/php/7.X/bin/pecl install pdo_sqlsrv-5.9.0
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/7.X/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/7.X/bin/pecl install sqlsrv-5.9.0
      # echo "extension=sqlsrv.so" > /opt/plesk/php/7.X/etc/php.d/sqlsrv.ini

  5. Reread PHP handlers:

    # plesk bin php_handler --reread

  6. Reread the components properties to make modules visible in GUI:

    # plesk sbin packagemng -sdf

  7. Make sure that the required modules are enabled:

    # /opt/plesk/php/7.X/bin/php -m | grep sqlsrv
    pdo_sqlsrv
    sqlsrv

    Note: "7X" is to be replaced with the PHP version. For example, "74" for PHP 7.4

  8. Restart the PHP-FPM master process to apply changes to FPM sites

Ubuntu 22.04 with Plesk PHP 8.1/8.0

  1. Connect to the server via SSH.

  2. Install necessary packages:

    # apt-get install apt-transport-https make gcc g++ unixodbc unixodbc-dev plesk-php8X-dev

    Note: "8X" is to be replaced with the PHP version. For example, "81" for PHP 8.1

  3. Install the msodbcsql package:

    # curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
    # curl https://packages.microsoft.com/config/ubuntu/22.04/prod.list > /etc/apt/sources.list.d/mssql-release.list
    # apt-get update
    # ACCEPT_EULA=Y apt-get install msodbcsql18

  4. Add the pdo_sqlsrv and sqlsrv-5.8.1 modules:

    • For PHP 8.1 provided by Plesk:

      # /opt/plesk/php/8.1/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/8.1/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/8.1/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/8.1/etc/php.d/sqlsrv.ini

    • For PHP 8.0 provided by Plesk:

      # /opt/plesk/php/8.0/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/8.0/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/sqlsrv.ini

  5. Reread PHP handlers:

    # plesk bin php_handler --reread

  6. Reread the components properties to make modules visible in GUI:

    # plesk sbin packagemng -sdf

  7. Make sure that the required modules are enabled:

    # /opt/plesk/php/8.X/bin/php -m | grep sqlsrv
    pdo_sqlsrv
    sqlsrv

    Note: "8X" is to be replaced with the PHP version. For example, "81" for PHP 8.1

  8. Restart the PHP-FPM master process to apply changes to FPM sites

Debian 10/11 with Plesk PHP 8.1/8.0

  1. Connect to the server via SSH.

  2. Install necessary packages:

    # apt-get install apt-transport-https make gcc g++ unixodbc unixodbc-dev plesk-php8X-dev

    Note: "8X" is to be replaced with the PHP version. For example, "81" for PHP 8.1

  3. Install the msodbcsql package:

    # curl https://packages.microsoft.com/keys/microsoft.asc | apt-key add -
    # curl https://packages.microsoft.com/config/debian/11/prod.list > /etc/apt/sources.list.d/mssql-release.list
    # apt-get update
    # ACCEPT_EULA=Y apt-get install msodbcsql18

  4. Add the pdo_sqlsrv and sqlsrv-5.8.1 modules:

    • For PHP 8.1 provided by Plesk:

      # /opt/plesk/php/8.1/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/8.1/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/8.1/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/8.1/etc/php.d/sqlsrv.ini

    • For PHP 8.0 provided by Plesk:

      # /opt/plesk/php/8.0/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/8.0/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/8.0/etc/php.d/sqlsrv.ini

  5. Reread PHP handlers:

    # plesk bin php_handler --reread

  6. Reread the components properties to make modules visible in GUI:

    # plesk sbin packagemng -sdf

  7. Make sure that the required modules are enabled:

    # /opt/plesk/php/8.X/bin/php -m | grep sqlsrv
    pdo_sqlsrv
    sqlsrv

    Note: "8X" is to be replaced with the PHP version. For example, "81" for PHP 8.1

  8. Restart the PHP-FPM master process to apply changes to FPM sites

CentOS 7/Centos 8/Almalinux 8 with Plesk PHP 8.0/7.3/7.4

  1. Connect to the server via SSH.

  2. Install the msodbcsql package:

    # curl https://packages.microsoft.com/config/rhel/7/prod.repo > /etc/yum.repos.d/mssql-release.repo
    # yum remove unixODBC-utf16 unixODBC-utf16-devel
    # ACCEPT_EULA=Y yum install msodbcsql18

  3. Install necessary packages:

    # yum install unixODBC-devel make gcc-c++ gcc autoconf automake plesk-phpXX-devel libtool-ltdl.x86_64 libtool-ltdl-devel.x86_64

    Note: "XX" is to be replaced with the PHP version. For example, "74" for PHP 7.4 or "80" for PHP 8.0

  4. Add the pdo_sqlsrv and sqlsrv-5.8.1 modules:

    • For PHP 7.2 provided by Plesk:

      # /opt/plesk/php/7.2/bin/pecl install pdo_sqlsrv-5.8.1
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/7.2/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/7.2/bin/pecl install sqlsrv-5.8.1
      # echo "extension=sqlsrv.so" > /opt/plesk/php/7.2/etc/php.d/sqlsrv.ini

    • For later PHP 7.X and PHP 8.X versions provided by Plesk:

      # /opt/plesk/php/7.X/bin/pecl install pdo_sqlsrv
      # echo "extension=pdo_sqlsrv.so" > /opt/plesk/php/X.X/etc/php.d/pdo_sqlsrv.ini
      # /opt/plesk/php/X.X/bin/pecl install sqlsrv
      # echo "extension=sqlsrv.so" > /opt/plesk/php/X.X/etc/php.d/sqlsrv.ini

      Note: "X.X" is to be replaced with the PHP version. For example, "7.4" for PHP 7.4 or "8.0" for PHP 8.0

  5. Reread PHP handlers:

    # plesk bin php_handler --reread

  6. Reread the components properties to make modules visible in GUI:

    # plesk sbin packagemng -sdf

  7. Make sure that the required modules are enabled:

    # /opt/plesk/php/X.X/bin/php -m | grep sqlsrv
    pdo_sqlsrv
    sqlsrv

    Note: "X.X" is to be replaced with the PHP version. For example, "7.4" for PHP 7.4 or "8.0" for PHP 8.0

  8. Restart the PHP-FPM master process to apply changes to FPM sites

Comments

6 comments

Sort by Date Votes
  • Avatar
    Systems Galileu

    Hello!
    I try to install php-mssql on a older php version (5.4), but it not woks. The extensio msssql not apear in Settings for 5.4.45 FPM application

    After run 
    # yum install php-mssql
    it shows 
    Package php-mssql-5.4.16-9.el17.x86_64 already installed and latest version

    I don't know the next step.
    Can anyone help me to solve this?
    Thanks

    Marc

    1
    Comment actions Permalink
  • Avatar
    Systems Galileu

    Hello again!
    I just try also install sqlsrv extension for the Plesk on centos 7 for php 7.2. I follow all steps and I can see de modules are available but when I try to connecte to remote SQL Server it returns this error:

     [SQLSTATE] => IMSSP
 [code] => -49
 [message] => This extension requires the Microsoft ODBC Driver for SQL Server. Access the following URL to download the ODBC Driver for SQL Server for x64: https://go.microsoft.com/fwlink/?LinkId=163712C

    Can anyone help and explain me the next step? What I need to install now?
    Thanks

    1
    Comment actions Permalink
  • Avatar
    Butch Tribbiani (Edited )

    Systems Galileu any luck? I am in the same spot...

    I have checked I have the ODBC driver in latest version:

    Package unixODBC-2.3.11-1.rh.x86_64 already installed and latest version

    1
    Comment actions Permalink
  • Avatar
    Butch Tribbiani

    I checked and have ini files for php7.2 in /opt/plesk/php/7.2/etc/php.d: odbc.ini

    from console (php cli) also says that I have ODBC Driver 18 for SQL Server]

    unixODBC 2.3.11
    DRIVERS............: /etc/odbcinst.ini
    SYSTEM DATA SOURCES: /etc/odbc.ini
    FILE DATA SOURCES..: /etc/ODBCDataSources
    USER DATA SOURCES..: /root/.odbc.ini

    but when trying to connect it says 

    This extension requires the Microsoft ODBC Driver for SQL Server. Ac

    Why is that ? Am i missing something?

     

    1
    Comment actions Permalink
  • Avatar
    Butch Tribbiani (Edited )

    I got it work.

    And this answer is confusing- in example it is sugessted to install Microsoft ODBC 18 (msodbcsql18) and sqlsrv-5.8.1 for PHP 7.2 - and that will not work together.

    Double check versions of drivers to be sure that they can work together. As it turned out - it is very important.

    Check here if you use good version of ODBC Drivers to work with PHP sqlsrv.

    For sqlsrv-5.8.1 you need to use Microsoft ODBC 17

    Further info how to install it is on MS docs site here

    So in step 2 should be added:

    For PHP 7.2 and pdo_sqlsrv-5.8.1 install msodbcsql17 : 

    # curl https://packages.microsoft.com/config/rhel/7/prod.repo | sudo tee /etc/yum.repos.d/mssql-release.repo

# sudo yum remove unixODBC-utf16 unixODBC-utf16-devel #to avoid conflicts
# sudo ACCEPT_EULA=Y yum install -y msodbcsql17

# sudo ACCEPT_EULA=Y yum install -y mssql-tools
# echo 'export PATH="$PATH:/opt/mssql-tools/bin"' >> ~/.bashrc
# source ~/.bashrc

# sudo yum install -y unixODBC-devel
    1
    Comment actions Permalink
  • Avatar
    Miha Gregors

    Hello,

    I notice that for Almalinux 8 is CentOS 7 repo used? Is this ok? I mean this section "CentOS 7/Centos 8/Almalinux 8 with Plesk PHP 8.0/7.3/7.4"
    And there is only this repo for all https://packages.microsoft.com/config/rhel/7/prod.repo

    Regards,

    0
    Comment actions Permalink

Please sign in to leave a comment.

Have more questions? Submit a request

Related articles