SQLServer

From DreamFactory
Jump to: navigation, search
(Requirements)
(Added section about upserts)
 
Line 1: Line 1:
 
The SQL Server service type can connect to local or remote SQL Server, SQL Server Express, or Azure SQL Database.
 
The SQL Server service type can connect to local or remote SQL Server, SQL Server Express, or Azure SQL Database.
  
==Common Feature Exceptions==
+
== Common Feature Exceptions ==
  
==Requirements==
+
== Requirements ==
 
Check [[DreamFactory/Installation/Databases/SQLServer|here]] for installation help.
 
Check [[DreamFactory/Installation/Databases/SQLServer|here]] for installation help.
  
Line 12: Line 12:
 
* PHP extension '''pdo_dblib''' (and possibly '''mssql''' for PHP versions <7.0) are required to be installed or compiled in.
 
* PHP extension '''pdo_dblib''' (and possibly '''mssql''' for PHP versions <7.0) are required to be installed or compiled in.
  
==Configuration==
+
== Configuration ==
 
* '''host''' - String. Required. The name of the database host, i.e. localhost, 192.168.1.1, etc.
 
* '''host''' - String. Required. The name of the database host, i.e. localhost, 192.168.1.1, etc.
 
* '''port''' - Integer. Optional. The number of the database host port, internally defaults to 1433.
 
* '''port''' - Integer. Optional. The number of the database host port, internally defaults to 1433.
Line 25: Line 25:
 
* '''attributes''' - Object. Optional. A key-value array of attributes to be set after connection. For further information, see http://php.net/manual/en/pdo.setattribute.php.
 
* '''attributes''' - Object. Optional. A key-value array of attributes to be set after connection. For further information, see http://php.net/manual/en/pdo.setattribute.php.
 
* '''statements''' - Array of Strings. Optional. An array of additional SQL statements to run during connection initialization.
 
* '''statements''' - Array of Strings. Optional. An array of additional SQL statements to run during connection initialization.
 +
 +
== Features ==
 +
 +
=== Upsert ===
 +
 +
DreamFactory supports SQL Server upserts. To enable upserts, enter your SQL Server service configuration and enable the '''Allow Upsert''' checkbox.

Latest revision as of 21:25, 16 May 2018

The SQL Server service type can connect to local or remote SQL Server, SQL Server Express, or Azure SQL Database.

Common Feature Exceptions

Requirements

Check here for installation help.

On Windows OS...

  • PHP extensions sqlsrv and pdo_sqlsrv are required to be installed or compiled in.

On Linux or Mac OS...

  • PHP extensions sqlsrv and pdo_sqlsrv if Microsoft supports your OS. (see MS on Github) OR
  • PHP extension pdo_dblib (and possibly mssql for PHP versions <7.0) are required to be installed or compiled in.

Configuration

  • host - String. Required. The name of the database host, i.e. localhost, 192.168.1.1, etc.
  • port - Integer. Optional. The number of the database host port, internally defaults to 1433.
  • database - String. Required. The name of the database to connect to on the given server. This can be a lookup key.
  • username - String. Optional. The name of the database user. This can be a lookup key.
  • password - String. Optional. The password for the database user. This can be a lookup key.
  • default_schema_only - Boolean. Defaults to false. Do not include other schemas/databases on this server regardless of permissions given to the supplied credentials.
  • readonly - Boolean. Defaults to false. Defines ApplicationIntent as ReadOnly.
  • pooling - Boolean. Defaults to false. Specifies whether the connection is assigned from a connection pool.
  • appname - String. Optional. The application name used in tracing.
  • options - Object. Optional. A name-value array of driver-specific connection options.
  • attributes - Object. Optional. A key-value array of attributes to be set after connection. For further information, see http://php.net/manual/en/pdo.setattribute.php.
  • statements - Array of Strings. Optional. An array of additional SQL statements to run during connection initialization.

Features

Upsert

DreamFactory supports SQL Server upserts. To enable upserts, enter your SQL Server service configuration and enable the Allow Upsert checkbox.