Quickstart · 5 min read

Installation

Learn on how to install RepoDB library on your Project/Solution.

Install packages using the Package Manager Console.

Raw SQLs

For raw SQL usage only:

> Install-Package RepoDb

It supports all kinds of RDBMS data providers.

AuroraDB

Two packages are available for Amazon Aurora, depending on which engine edition your cluster uses.

PostgreSQL-compatible Edition

To work with RepoDb.AuroraDb.PostgreSql:

> Install-Package RepoDb.AuroraDb.PostgreSql

After installation, call the globalized setup method to initialize all dependencies for Aurora PostgreSQL.

GlobalConfiguration
    .Setup()
    .UseAuroraDb();

For bulk operations:

> Install-Package RepoDb.AuroraDb.PostgreSql.BulkOperations

MySQL-compatible Edition

To work with RepoDb.AuroraDb.MySqlConnector:

> Install-Package RepoDb.AuroraDb.MySqlConnector

After installation, call the globalized setup method to initialize all dependencies for Aurora MySQL.

GlobalConfiguration
    .Setup()
    .UseAuroraDb();

Both packages expose an identically-named AuroraDbConnection and GlobalConfiguration.UseAuroraDb() (in different namespaces, backed by different connectors) — only reference one of them in a given project.

ClickHouse

To work with ClickHouse:

> Install-Package RepoDb.ClickHouse

After installation, call the globalized setup method to initialize all dependencies for ClickHouse.

GlobalConfiguration
    .Setup()
    .UseClickHouse();

For bulk operations:

> Install-Package RepoDb.ClickHouse.BulkOperations

CockroachDB

To work with CockroachDB:

> Install-Package RepoDb.CockroachDb

After installation, call the globalized setup method to initialize all dependencies for CockroachDB.

GlobalConfiguration
    .Setup()
    .UseCockroachDb();

For bulk operations:

> Install-Package RepoDb.CockroachDb.BulkOperations

DB2

To work with DB2:

> Install-Package RepoDb.Db2

RepoDb.Db2 does not bundle the IBM ADO.NET driver — install the matching platform-specific Net.IBM.Data.Db2* package alongside it (e.g. Net.IBM.Data.Db2 for Windows x64, Net.IBM.Data.Db2-lnx for Linux).

After installation, call the globalized setup method to initialize all dependencies for DB2.

GlobalConfiguration
    .Setup()
    .UseDb2();

For bulk operations:

> Install-Package RepoDb.Db2.BulkOperations

DuckDB

To work with DuckDB:

> Install-Package RepoDb.DuckDb

After installation, call the globalized setup method to initialize all dependencies for DuckDB.

GlobalConfiguration
    .Setup()
    .UseDuckDb();

EnterpriseDB

To work with EnterpriseDB:

> Install-Package RepoDb.EnterpriseDb

After installation, call the globalized setup method to initialize all dependencies for EnterpriseDB.

GlobalConfiguration
    .Setup()
    .UseEnterpriseDb();

For bulk operations:

> Install-Package RepoDb.EnterpriseDb.BulkOperations

Firebird

To work with Firebird:

> Install-Package RepoDb.Firebird

After installation, call the globalized setup method to initialize all dependencies for Firebird.

GlobalConfiguration
    .Setup()
    .UseFirebird();

For bulk operations:

> Install-Package RepoDb.Firebird.BulkOperations

MariaDB

Two packages are available for MariaDB.

MariaDb (MySql.Data)

> Install-Package RepoDb.MariaDb

After installation, call the globalized setup method to initialize all dependencies for MariaDb.

GlobalConfiguration
    .Setup()
    .UseMariaDb();

For bulk operations:

> Install-Package RepoDb.MariaDb.BulkOperations

MariaDbConnector

> Install-Package RepoDb.MariaDbConnector

After installation, call the globalized setup method to initialize all dependencies for MariaDb.

GlobalConfiguration
    .Setup()
    .UseMariaDbConnector();

For bulk operations:

> Install-Package RepoDb.MariaDbConnector.BulkOperations

MySQL

Two packages are available for MySQL.

MySql.Data

To work with RepoDb.MySql:

> Install-Package RepoDb.MySql

After installation, call the globalized setup method to initialize all dependencies for MySQL.

GlobalConfiguration
	.Setup()
	.UseMySql();

MySqlConnector

To work with RepoDb.MySqlConnector:

> Install-Package RepoDb.MySqlConnector

After installation, call the globalized setup method to initialize all dependencies for MySQL.

GlobalConfiguration
	.Setup()
	.UseMySqlConnector();

Oracle

To work with Oracle:

> Install-Package RepoDb.Oracle

After installation, call the globalized setup method to initialize all dependencies for Oracle.

GlobalConfiguration
    .Setup()
    .UseOracle();

For bulk operations:

> Install-Package RepoDb.Oracle.BulkOperations

PostgreSQL

To work with PostgreSQL:

> Install-Package RepoDb.PostgreSql

After installation, call the globalized setup method to initialize all dependencies for PostgreSql.

GlobalConfiguration
	.Setup()
	.UsePostgreSql();

For bulk operations:

> Install-Package RepoDb.PostgreSql.BulkOperations

SAP HANA

To work with SAP HANA:

> Install-Package RepoDb.SapHana

After installation, call the globalized setup method to initialize all dependencies for SAP HANA.

GlobalConfiguration
    .Setup()
    .UseSapHana();

For bulk operations:

> Install-Package RepoDb.SapHana.BulkOperations

SQL Server

To work with SQL Server:

> Install-Package RepoDb.SqlServer

After installation, call the globalized setup method to initialize all dependencies for SQL Server.

GlobalConfiguration
	.Setup()
	.UseSqlServer();

For bulk operations:

> Install-Package RepoDb.SqlServer.BulkOperations

System.Data.SqlClient

When using this package, bootstrap the connection object at startup.

var dbSetting = new SqlServerDbSetting();

DbSettingMapper
	.Add<System.Data.SqlClient.SqlConnection>(dbSetting, true);
DbHelperMapper
	.Add<System.Data.SqlClient.SqlConnection>(new SqlServerDbHelper(), true);
StatementBuilderMapper
	.Add<System.Data.SqlClient.SqlConnection>(new SqlServerStatementBuilder(dbSetting), true);

Alternatively, replicate the SqlServerBootstrap class and call the initializer explicitly.

SQLite

Three packages are available for SQLite, depending on which data provider you use.

Microsoft.Data.Sqlite

To work with RepoDb.Sqlite.Microsoft:

> Install-Package RepoDb.Sqlite.Microsoft

After installation, call the globalized setup method to initialize all dependencies for SQLite.

GlobalConfiguration
	.Setup()
	.UseSqlite();

Ahtola

To work with RepoDb.Sqlite.Ahtola:

> Install-Package RepoDb.Sqlite.Ahtola

After installation, call the globalized setup method to initialize all dependencies for Ahtola.

GlobalConfiguration
	.Setup()
	.UseAhtola();

Turso

To work with RepoDb.Sqlite.Turso:

> Install-Package RepoDb.Sqlite.Turso

After installation, call the globalized setup method to initialize all dependencies for Turso.

GlobalConfiguration
	.Setup()
	.UseTurso();

Vertica

To work with Vertica:

> Install-Package RepoDb.Vertica

After installation, call the globalized setup method to initialize all dependencies for Vertica.

GlobalConfiguration
    .Setup()
    .UseVertica();

For bulk operations:

> Install-Package RepoDb.Vertica.BulkOperations

Please visit our documentation page to learn more about this library.