Connection String Options
The connection string properties are the various options that can be used to establish a connection. This section provides a complete list of the options you can configure in the connection string for this provider. Click the links for further details.
For more information on establishing a connection, see Basic Tab.
| Property | Description |
| TableDepth | Specifies how many levels of subfolders the provider scans and exposes as separate views. |
| RemoteHost | Specifies the host name or IP address of the SFTP server that you want to connect to. |
| RemotePath | Specifies the working directory on the SFTP server that the provider uses for file operations. |
| User | Specifies the authenticating user's user ID. |
| Password | Specifies the authenticating user's password. |
| RemotePort | Specifies the port number that the provider uses to connect to the SFTP server. |
| Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
| Property | Description |
| SSHAuthMode | Specifies the SSH authentication method that the provider uses when connecting to the SFTP server. |
| SSHClientCert | A certificate to be used for authenticating the SSHUser. |
| SSHClientCertPassword | The password of the SSHClientCert key if it has one. |
| SSHClientCertSubject | The subject of the SSH client certificate. |
| SSHClientCertType | The type of SSHClientCert private key. |
| SSHServerFingerprint | Specifies one or more SSH host key fingerprints that the provider accepts as valid when verifying the server identity. |
| Property | Description |
| FirewallType | Specifies the protocol the provider uses to tunnel traffic through a proxy-based firewall. |
| FirewallServer | Identifies the IP address, DNS name, or host name of a proxy used to traverse a firewall and relay user queries to network resources. |
| FirewallPort | Specifies the TCP port to be used for a proxy-based firewall. |
| FirewallUser | Identifies the user ID of the account authenticating to a proxy-based firewall. |
| FirewallPassword | Specifies the password of the user account authenticating to a proxy-based firewall. |
| Property | Description |
| LogModules | Specifies the core modules to include in the log file. Use a semicolon-separated list of module names. By default, all modules are logged. |
| Property | Description |
| Location | Specifies the location of a directory containing schema files that define tables, views, and stored procedures. Depending on your service's requirements, this may be expressed as either an absolute path or a relative path. |
| Property | Description |
| FileRetrievalDepth | Specifies the depth level of folders you want to query from the Root table. |
| IncludeHiddenFiles | Specifies whether the provider includes hidden files when listing directory contents on the SFTP server. |
| MaxRows | Specifies the maximum number of rows returned for queries that do not include either aggregation or GROUP BY. |
| Other | Specifies additional hidden properties for specific use cases., to be used only when our Support team advises it, to address specific issues. See Remarks for details. |
| Readonly | Toggles read-only access to SFTP from the provider. |
| Timeout | Specifies the maximum time, in seconds, that the provider waits for a server response before throwing a timeout error. |
| UseMLSD | Uses listings for machine processing. Used only for FTP servers. |
| UserDefinedViews | Specifies a filepath to a JSON configuration file that defines custom views. The provider automatically detects and uses the views specified in this file. |
| UseSimpleNames | Specifies whether or not simple names should be used for tables and columns. |