SQL Server Query
Query a Microsoft SQL Server database.
Properties
Name | Type | |
---|---|---|
engine | String=sqlserver:query | |
connection | Object | |
query | String | |
schema | Object |
engine
Must be sqlserver:query
.
- Required
- Yes
connection
The SQL connection parameters.
- Required
- No
Properties
Name | Type | |
---|---|---|
host | String | |
database | String | |
user | String | |
password | String | |
instance | String | |
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