SQL Server Query

Query a Microsoft SQL Server database.

Properties

NameType
engineString=sqlserver:query
connectionObject
queryString
schemaObject

engine

Must be sqlserver:query.

Required
Yes

connection

The SQL connection parameters.

Required
No

Properties

NameType
hostString
databaseString
userString
passwordString
instanceString
encrypt

connection.host

The network address of SQL Server e.g. `db.example.com:1433`.

Required
Yes

connection.database

The name of the SQL Server database.

Required
Yes

connection.user

The username to authenticate to SQL Server.

Required
Yes

connection.password

The password to authenticate to SQL Server. Requires `username`.

Required
Yes

connection.instance

Connect to an instance instead of a port.

Required
No

connection.encrypt

Encrypt data sent between client and host.

Required
No
Enum
Enabled Login Only Disabled

query

The SQL query to retrieve the data.

Required
Yes

schema

Define the schema of the data, entering the field name returned by the SQL query into `Source`.

Required
Yes