SQL Server Connection
Use this connection to access data in SQL Server.
Configuration
Property | Macro Enabled? | Description |
|---|---|---|
Name | No | Required. Name of the connection. Connection names must be unique in a namespace. Connection names can only include letters, numbers, underscores, and hyphens. |
Description | No | Optional. Description of the connection. |
JDBC Driver Name | No | Required. Select the JDBC driver name to use. |
Host | Yes | Required. Host name or IP address of the database server to connect to. Default is localhost. |
Port | Yes | Required. Port number of the database server to connect to. Default is 1433. |
Authentication Type | No | Optional. Indicates which authentication method will be used for the connection. Use ‘SQL Login’. to connect to a SQL Server using username and password properties. Use ‘Active Directory Password’ to connect to an Azure SQL Database/Data Warehouse using an Azure AD principal name and password. |
Username | Yes | User identity for connecting to the specified database. Required for databases that need authentication. Optional for databases that do not require authentication. |
Password | Yes | Password to use to connect to the specified database. |
Connection Arguments | Yes | Optional. A list of arbitrary string tag/value pairs as connection arguments. These arguments will be passed to the JDBC driver, as connection arguments, for JDBC drivers that may need additional configurations. This is a semicolon-separated list of key-value pairs, where each pair is separated by a equals ‘=’ and specifies the key and value for the argument. For example, ‘key1=value1;key2=value’ specifies that the connection will be given arguments ‘key1’ mapped to ‘value1’ and the argument ‘key2’ mapped to ‘value2’. |
Path of the connection
To browse, get a sample from, or get the specification for this connection through Pipeline Microservices, the path property is required in the request body. It can be in the following form:
/{database}/{schema}/{table}This path indicates a table. A table is the only one that can be sampled. Browse on this path to return the specified table./{database}/{schema}This path indicates a schema. A schema cannot be sampled. Browse on this path to get all the tables under this schema./{database}This path indicates a database. A database cannot be sampled. Browse on this path to get all the schemas under this database./This path indicates the root. A root cannot be sampled. Browse on this path to get all the databases visible through this connection.
Created in 2020 by Google Inc.