themaster1970sf/TShock
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

docs: Add example links for SQLite, MySQL, & Postgres connection strings

Browse source 
Provides links to example connection string formats for SQLite, MySQL, and Postgres to assist users in configuring database connections more effectively.
This commit is contained in:
Sakura Akeno Isayeki 2025-05-23 15:07:11 +02:00
parent 2fa07303f7
commit d0e5c84a79
No known key found for this signature in database
GPG key ID: BAB781B71FD2E7E6
1 changed files with 5 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

5
TShockAPI/Configuration/TShockConfig.cs
View file

@ -536,6 +536,7 @@ namespace TShockAPI.Configuration
/// The connection string to use when connecting to a SQLite database. /// The connection string to use when connecting to a SQLite database.
/// </summary> /// </summary>
/// <remarks>This property will override the <see cref="SqliteDBPath"/> property, if used.</remarks> /// <remarks>This property will override the <see cref="SqliteDBPath"/> property, if used.</remarks>
/// <seealso href="https://www.connectionstrings.com/sqlite-net-provider/">Example SQLite connection strings (connectionstrings.com)</seealso>
[Description("The connection string to use when connecting to a SQLite database. This property will override the SqliteDBPath property, if used.")] [Description("The connection string to use when connecting to a SQLite database. This property will override the SqliteDBPath property, if used.")]
public string SqliteConnectionString = ""; public string SqliteConnectionString = "";
@ -553,6 +554,9 @@ namespace TShockAPI.Configuration
/// <see cref="MySqlUsername"/>, /// <see cref="MySqlUsername"/>,
/// and <see cref="MySqlPassword"/> properties, if used. /// and <see cref="MySqlPassword"/> properties, if used.
/// </remarks> /// </remarks>
/// <seealso href="https://www.connectionstrings.com/mysql-connector-net-mysqlconnection/">
/// Example MySQL connection strings (connectionstrings.com)
/// </seealso>
[Description("The connection string to use when connecting to a MySQL database. " + [Description("The connection string to use when connecting to a MySQL database. " +
"This property will override the MySqlHost, MySqlDbName, MySqlUsername and MySqlPassword properties, if used.")] "This property will override the MySqlHost, MySqlDbName, MySqlUsername and MySqlPassword properties, if used.")]
public string MySqlConnectionString = ""; public string MySqlConnectionString = "";
@ -583,6 +587,7 @@ namespace TShockAPI.Configuration
/// <see cref="PostgresUsername"/>, /// <see cref="PostgresUsername"/>,
/// and <see cref="PostgresPassword"/> properties, if used. /// and <see cref="PostgresPassword"/> properties, if used.
/// </remarks> /// </remarks>
/// <seealso href="https://www.connectionstrings.com/npgsql/">Example Npgsql connection strings (connectionstrings.com)</seealso>
[Description("The connection string to use when connecting to a Postgres database. " + [Description("The connection string to use when connecting to a Postgres database. " +
"This property will override the PostgresHost, PostgresDbName, PostgresUsername and PostgresPassword properties, if used.")] "This property will override the PostgresHost, PostgresDbName, PostgresUsername and PostgresPassword properties, if used.")]
public string PostgresConnectionString = ""; public string PostgresConnectionString = "";