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 | The depth level to display subfolders as views. |
RemoteHost | Set this to the host name or address of the server. |
RemotePath | The current path in the SFTP server. |
User | The SFTP user account used to authenticate. |
Password | The password used to authenticate the user. |
RemotePort | The port the SFTP server is running on. |
Passive | Controls whether to direct the server into passive mode. Recommended if behind a firewall. |
Property | Description |
SSHAuthMode | The authentication method to be used to log on to an SFTP server. |
SSHClientCert | A private key to be used for authenticating the user. |
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 | The SSH server fingerprint. |
Property | Description |
FirewallType | The protocol used by a proxy-based firewall. |
FirewallServer | The name or IP address of a proxy-based firewall. |
FirewallPort | The TCP port for a proxy-based firewall. |
FirewallUser | The user name to use to authenticate with a proxy-based firewall. |
FirewallPassword | A password used to authenticate to a proxy-based firewall. |
Property | Description |
LogModules | Core modules to be included in the log file. |
Property | Description |
Location | A path to the directory that contains the schema files defining tables, views, and stored procedures. |
Property | Description |
FileRetrievalDepth | Specify the depth level of folders you want to query from the Root table. |
MaxRows | Limits the number of rows returned rows when no aggregation or group by is used in the query. This helps avoid performance issues at design time. |
Other | These hidden properties are used only in specific use cases. |
Readonly | You can use this property to enforce read-only access to SFTP from the provider. |
Timeout | The value in seconds until the timeout error is thrown, canceling the operation. |
UseMLSD | Uses listings for machine processing. Used only for FTP servers. |
UserDefinedViews | A filepath pointing to the JSON configuration file containing your custom views. |
UseSimpleNames | Boolean determining if simple names should be used for tables and columns. |