DubUrl.Extensions
0.18.68
dotnet add package DubUrl.Extensions --version 0.18.68
NuGet\Install-Package DubUrl.Extensions -Version 0.18.68
<PackageReference Include="DubUrl.Extensions" Version="0.18.68" />
paket add DubUrl.Extensions --version 0.18.68
#r "nuget: DubUrl.Extensions, 0.18.68"
// Install DubUrl.Extensions as a Cake Addin #addin nuget:?package=DubUrl.Extensions&version=0.18.68 // Install DubUrl.Extensions as a Cake Tool #tool nuget:?package=DubUrl.Extensions&version=0.18.68
DubUrl
DubUrl provides a standard, URL style mechanism for parsing database connection strings and opening DbConnections for .NET. With DubUrl, you can parse and open URLs for popular databases such as Microsoft SQL Server, PostgreSQL, MySQL, SQLite3, Oracle Database and most of the other SQL databases. This project is inspired from the package dburl available in the GoLang ecosystem and is trying to match the aliases for portocols.
About | Overview | Quickstart | Examples | Schemes | Installing | Using
About
Continuous integration builds:
Database Connection URL Overview
Supported database connection URLs are of the form:
driver:alias://user:pass@host/dbname?opt1=a&opt2=b
Where:
Component | Description |
---|---|
alias | database type (see below) |
driver | driver/provider name (only for odbc/oleodbc) |
user | username |
pass | password |
host | host |
dbname<sup>*</sup> | database, instance, or service name/ID to connect to |
?opt1=... | additional database driver options (see respective SQL driver for available options) |
<i><sup><b>*</b></sup> for Microsoft SQL Server, /dbname
can be
/instance/dbname
, where /instance
is optional. For Oracle Database,
/dbname
is of the form /service/dbname
where /service
is the service name
or SID, and /dbname
is optional. Please see below for examples.</i>
Quickstart
Database connection URLs in the above format can be parsed to a standard connection string with the [Parse
] as such:
string connectionUrl = "mssql://{server}/{database_name}";
string connectionString = new ConnectionUrl(connectionUrl).Parse();
Additionally, a simple helper, [Open
], is provided that will parse, open, and return a standard DbConnection
.
string connectionUrl = "mssql://{server}/{database_name}";
IDbConnection connection = new ConnectionUrl(connectionUrl).Open();
If you don't want to open the connection but only return it and manage its state by yourself, use the function [Connect
]
string connectionUrl = "mssql://{server}/{database_name}";
IDbConnection connection = new ConnectionUrl(connectionUrl).Connect();
Example URLs
The following are example database connection URLs that can be handled by
[Parse
], [Connect
] and [Open
]:
mssql://user:pass@remote-host.com/instance/dbname?keepAlive=10
oledb+mssql://user:pass@localhost/dbname
postgres://user:pass@localhost/dbname
odbc+postgres://user:pass@localhost:port/dbname?option1=
mysql://user:pass@localhost/dbname
oracle://user:pass@somehost.com/sid
db2://user:pass@localhost/dbname
Protocol Schemes and Aliases
ADO.Net data providers
The following databases and their associated schemes are supported out of the box:
Database | Aliases | Provider Invariant Name |
---|---|---|
mssql, ms, sqlserver, mssqlserver | Microsoft.Data.SqlClient | |
mysql, my | MySqlConnector | |
pg, pgx, pgsql, postgres, postgresql | Npgsql | |
oracle, or, ora | Oracle.ManagedDataAccess | |
db2 | IBM.Data.Db2 | |
maria, mariadb | MySqlConnector | |
duck, duckdb | DuckDB.NET.Data | |
fb, firebird | FirebirdSql.Data.FirebirdClient | |
sq, sqlite | Microsoft.Data.Sqlite | |
td, teradata, tera | Teradata.Client | |
sf, snowflake | Snowflake.Data | |
cr, cockroach, cockroachdb, crdb, cdb | Npgsql | |
crt, crate, cratedb | Npgsql | |
sg, sgs, singlestore, single | SingleStoreConnector | |
tr, trino | NReco.PrestoAdo | |
quest, questdb | Npgsql | |
ts, timescale | Npgsql |
ODBC driver locators
The following databases and their associated schemes are supported out of the box:
Database | Aliases | Name Pattern |
---|---|---|
mssql, ms, sqlserver, mssqlserver | ^\bODBC Driver\s([0-9]{1,2}(?:.[0-9]{1,2}){0,2})\s\bfor SQL Server$ | |
mysql, my | ^\bMySQL ODBC\s([0-9]{1,2}(?:.[0-9]{1,2}){0,2})\s(ANSI|Unicode)\s\bDriver$ | |
pg, pgx, pgsql, postgres, postgresql | ^\bPostgreSQL\s(ANSI|Unicode)((x64))?$ | |
maria, mariadb | ^\bMariaDB ODBC\s([0-9]{1,2}(?:.[0-9]{1,2}){0,2})\s\bDriver$ | |
duck, duckdb | ^\bDuckDB\s\bDriver$ | |
drill | ^\bMapR Drill ODBC Driver$ | |
tr, trino | ^(Simba)\s\bTrino ODBC Driver$ | |
accdb, access, msaccess, mdb | ^\bMicrosoft Access Driver\s(*.mdb, *.accdb)$ | |
xls, xlsx, xlsb, xlsm | ^\bMicrosoft Excel Driver\s(*.xls, *.xlsx, *.xlsm, *.xlsb)$ | |
txt, csv, tsv | ^\bMicrosoft Access Text Driver\s(*.txt, *.csv)$ | |
quest, questdb | ^\bPostgreSQL\s(ANSI|Unicode)((x64))?$ | |
ts, timescale | ^\bPostgreSQL\s(ANSI|Unicode)((x64))?$ |
Extension for OLEDB provider locators
The following databases and their associated schemes are supported through the OLE DB data provider extension:
Database | Aliases | Name Pattern |
---|---|---|
mssql, ms, sqlserver, mssqlserver | ^\bMSOLEDBSQL$ | |
mysql, my | ^\bMySQL Provider$ | |
xls | ^\bMicrosoft.ACE.OLEDB.([0-9]{1,2}(?:.[0-9]{1,2}){0,2})$ | |
xlsx | ^\bMicrosoft.ACE.OLEDB.([0-9]{1,2}(?:.[0-9]{1,2}){0,2})$ | |
xlsm | ^\bMicrosoft.ACE.OLEDB.([0-9]{1,2}(?:.[0-9]{1,2}){0,2})$ | |
xlsb | ^\bMicrosoft.ACE.OLEDB.([0-9]{1,2}(?:.[0-9]{1,2}){0,2})$ | |
accdb, access, msaccess, mdb | ^\bMicrosoft.ACE.OLEDB.([0-9]{1,2}(?:.[0-9]{1,2}){0,2})$ |
Extension for ADOMD.NET data provider
The following databases and their associated schemes are supported through the ADOMD.NET data provider extension:
Database | Aliases | Provider Invariant Name |
---|---|---|
asazure, asa | Microsoft.AnalysisServices.AdomdClient | |
pbidesktop, pbix, powerbidesktop | Microsoft.AnalysisServices.AdomdClient | |
powerbi, pbi, pbiazure, pbipremium, powerbipremium | Microsoft.AnalysisServices.AdomdClient | |
ssasmultidim, ssasmdx | Microsoft.AnalysisServices.AdomdClient | |
ssastabular, ssasdax | Microsoft.AnalysisServices.AdomdClient |
Installing
Install in the usual .NET fashion:
Install-Package DubUrl
To install the extension for OLEDB provider locators
Install-Package DubUrl.OleDb
To install the extension for ADOMD.NET data provider
Install-Package DubUrl.Adomd
Using
Check the first steps guide on the website.
Please note that DubUrl
does not install actual drivers, and only provides a standard way to [Parse
] respective database connection URLs then [Connect
] or [Open
] connections.
Product | Versions Compatible and additional computed target framework versions. |
---|---|
.NET | net6.0 is compatible. net6.0-android was computed. net6.0-ios was computed. net6.0-maccatalyst was computed. net6.0-macos was computed. net6.0-tvos was computed. net6.0-windows was computed. net7.0 is compatible. net7.0-android was computed. net7.0-ios was computed. net7.0-maccatalyst was computed. net7.0-macos was computed. net7.0-tvos was computed. net7.0-windows was computed. net8.0 is compatible. net8.0-android was computed. net8.0-browser was computed. net8.0-ios was computed. net8.0-maccatalyst was computed. net8.0-macos was computed. net8.0-tvos was computed. net8.0-windows was computed. |
-
net6.0
- DubUrl (>= 0.18.68)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
-
net7.0
- DubUrl (>= 0.18.68)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
-
net8.0
- DubUrl (>= 0.18.68)
- Microsoft.Extensions.Configuration (>= 8.0.0)
- Microsoft.Extensions.Configuration.Binder (>= 8.0.2)
- Microsoft.Extensions.Configuration.EnvironmentVariables (>= 8.0.0)
- Microsoft.Extensions.Configuration.Json (>= 8.0.0)
- Microsoft.Extensions.DependencyInjection (>= 8.0.0)
- Microsoft.Extensions.Logging (>= 8.0.0)
- Microsoft.Extensions.Logging.Abstractions (>= 8.0.1)
- Microsoft.Extensions.Options (>= 8.0.2)
NuGet packages
This package is not used by any NuGet packages.
GitHub repositories
This package is not used by any popular GitHub repositories.
Version | Downloads | Last updated |
---|---|---|
0.18.68 | 74 | 9/30/2024 |
0.18.67 | 99 | 9/16/2024 |
0.18.66 | 71 | 9/15/2024 |
0.18.65 | 84 | 9/15/2024 |
0.18.64 | 87 | 9/14/2024 |
0.18.62 | 89 | 9/9/2024 |
0.18.61 | 81 | 9/9/2024 |
0.18.60 | 83 | 9/2/2024 |
0.18.59 | 64 | 9/2/2024 |
0.18.58 | 69 | 9/3/2024 |
0.18.57 | 96 | 8/26/2024 |
0.18.56 | 112 | 8/21/2024 |
0.18.55 | 99 | 8/18/2024 |
0.18.54 | 100 | 8/15/2024 |
0.18.53 | 86 | 8/11/2024 |
0.18.51 | 61 | 7/29/2024 |
0.18.50 | 91 | 7/17/2024 |
0.18.49 | 60 | 7/17/2024 |
0.18.47 | 90 | 7/17/2024 |
0.18.45 | 93 | 7/14/2024 |
0.18.44 | 80 | 7/7/2024 |
0.18.43 | 95 | 7/7/2024 |
0.18.42 | 95 | 7/6/2024 |
0.18.41 | 98 | 7/6/2024 |
0.18.39 | 86 | 7/6/2024 |
0.18.38 | 108 | 7/6/2024 |
0.18.37 | 82 | 6/25/2024 |
0.18.36 | 94 | 6/23/2024 |
0.18.33 | 100 | 5/20/2024 |
0.18.32 | 95 | 5/20/2024 |
0.18.31 | 94 | 5/19/2024 |
0.18.30 | 103 | 5/15/2024 |
0.18.29 | 92 | 5/15/2024 |
0.18.28 | 99 | 5/15/2024 |
0.18.27 | 92 | 5/14/2024 |
0.18.24 | 89 | 5/14/2024 |
0.18.22 | 116 | 4/15/2024 |
0.18.20 | 111 | 4/15/2024 |
0.18.19 | 114 | 4/1/2024 |
0.18.18 | 94 | 3/25/2024 |
0.18.17 | 93 | 3/23/2024 |
0.18.16 | 91 | 3/23/2024 |
0.18.15 | 101 | 3/23/2024 |
0.18.14 | 100 | 3/23/2024 |
0.18.13 | 91 | 3/23/2024 |
0.18.12 | 116 | 3/11/2024 |
0.18.11 | 126 | 3/10/2024 |
0.18.10 | 117 | 3/10/2024 |
0.18.9 | 99 | 2/28/2024 |
0.18.8 | 97 | 2/17/2024 |
0.18.6 | 89 | 2/17/2024 |
0.18.5 | 89 | 2/17/2024 |
0.18.4 | 90 | 2/17/2024 |
0.18.3 | 84 | 2/17/2024 |
0.18.2 | 84 | 2/17/2024 |
0.18.0 | 119 | 2/11/2024 |
0.17.6 | 111 | 2/9/2024 |
0.17.5 | 104 | 2/9/2024 |
0.17.4 | 113 | 2/7/2024 |
0.17.3 | 109 | 2/7/2024 |
0.17.2 | 115 | 2/7/2024 |
0.17.1 | 112 | 1/30/2024 |
0.17.0 | 90 | 1/28/2024 |
0.16.0 | 83 | 1/27/2024 |
0.15.0 | 98 | 1/27/2024 |
0.14.0 | 97 | 1/27/2024 |
0.13.1 | 101 | 1/27/2024 |
0.13.0 | 111 | 1/22/2024 |
0.12.1 | 95 | 1/22/2024 |
0.12.0 | 101 | 1/22/2024 |
0.11.0 | 106 | 1/20/2024 |
0.10.0 | 103 | 1/20/2024 |
0.9.11 | 105 | 1/20/2024 |
0.9.10 | 102 | 1/20/2024 |
0.9.9 | 106 | 1/19/2024 |
0.9.8 | 99 | 1/19/2024 |
0.9.7 | 104 | 1/19/2024 |
0.9.6 | 98 | 1/19/2024 |
0.9.5 | 102 | 1/18/2024 |
0.9.2 | 138 | 1/8/2024 |
0.9.1 | 119 | 1/5/2024 |
0.9.0 | 134 | 12/30/2023 |
0.8.7 | 118 | 12/30/2023 |
0.8.6 | 124 | 12/25/2023 |
0.8.5 | 113 | 12/21/2023 |
0.8.4 | 101 | 12/21/2023 |
0.8.3 | 134 | 12/11/2023 |
0.8.2 | 115 | 12/11/2023 |
0.8.1 | 131 | 12/11/2023 |
0.8.0 | 135 | 12/9/2023 |
0.7.3 | 109 | 12/6/2023 |
0.7.2 | 129 | 12/5/2023 |
0.7.1 | 129 | 11/28/2023 |
0.7.0 | 129 | 11/27/2023 |
0.6.0 | 112 | 11/26/2023 |
0.5.11 | 129 | 11/25/2023 |
0.5.9 | 120 | 11/25/2023 |
0.5.8 | 125 | 11/25/2023 |
0.5.6 | 126 | 11/25/2023 |
0.5.5 | 112 | 11/25/2023 |
0.5.1 | 125 | 11/25/2023 |
0.5.0 | 131 | 11/18/2023 |