DubUrl 0.20.2

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

Social media:

Releases:

Dev. activity:

Continuous integration builds:

Status:

Database Connection URL Overview

Supported database connection URLs are of the form:

driver:alias://user:pass@host/dbname?opt1=a&opt2=b

Where:

<i>^<b>*</b> 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.