Skip to content

Commit 68b99fe

Browse files
committed
Remove mention of connection string options.
MySql.Data no longer supports these options (since 8.0.24) so it's unnecessary to mention them.
1 parent 64825d5 commit 68b99fe

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

docs/content/tutorials/connect-ssh.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
lastmod: 2021-04-22
2+
lastmod: 2021-07-05
33
date: 2019-07-30
44
menu:
55
main:
@@ -11,17 +11,18 @@ weight: 15
1111

1212
# Connecting to MySQL Server with SSH from C\#
1313

14-
This tutorial demonstrates how to simulate the `SshHostName`, `SshPort`, `SshUserName`, `SshPassword`, `SshKeyFile`, and `SshPassPhrase`
15-
connection string options using MySqlConnector.
14+
This tutorial demonstrates how to use SSH.NET and MySqlConnector to connect to a MySQL database over SSH.
1615

17-
The options are defined as follows:
16+
The arguments below are defined as follows:
1817

19-
* `SshHostName`: (required) the host name or IP address of the SSH server
20-
* `SshPort`: (optional) the port of the SSH server (default 22)
21-
* `SshUserName`: (required) the user name on the SSH server
22-
* `SshPassword`: (optional) the password of the SSH user
23-
* `SshKeyFile`: (optional): the path to the private key file to use for SSH authentication; if specified, this option takes precedence over `SshPassword`
24-
* `SshPassPhrase`: (optional): the passphrase to unlock the SSH private key file specified by `SshKeyFile`
18+
* `sshHostName`: (required) the host name or IP address of the SSH server
19+
* `sshUserName`: (required) the user name on the SSH server
20+
* `sshPassword`: (optional) the password of the SSH user
21+
* `sshKeyFile`: (optional) the path to the private key file to use for SSH authentication; if specified, this option takes precedence over `sshPassword`
22+
* `sshPassPhrase`: (optional) the passphrase to unlock the SSH private key file specified by `sshKeyFile`
23+
* `sshPort`: (optional) the port of the SSH server (default `22`)
24+
* `databaseServer`: (optional) the host name or IP address of the database server (relative to the SSH server, default `localhost`)
25+
* `databasePort`: (optional) the port the MySQL server is listening on (default `3306`)
2526

2627
## Prerequisites
2728

@@ -70,10 +71,6 @@ public static (SshClient SshClient, uint Port) ConnectSsh(string sshHostName, st
7071

7172
## Example Use
7273

73-
The `ConnectSsh` method defines two extra parameters: `databaseServer` and `databasePort`. By default,
74-
it assumes that the database is running on the same machine as the SSH server, using the default port (3306).
75-
If this isn't true, use the `Server` and `Port` values from the connection string.
76-
7774
Note that these examples dispose `sshClient`, which shuts down the forwarded port. In practice, you will
7875
want to keep the `SshClient` and forwarded port alive for the lifetime of your application.
7976

0 commit comments

Comments
 (0)