Link Search Menu Expand Document

Get Started for SAP HANA

RepoDB is a hybrid .NET ORM library for SAP HANA Database. The project is hosted at Github and is licensed with Apache 2.0.

Support ships as two packages:

Installation

Install the library via NuGet using the Package Manager Console.

> Install-Package RepoDb.SapHana

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

GlobalConfiguration
    .Setup()
    .UseSapHana();

To use bulk operations (BulkDelete, BulkDeleteByKey, BulkInsert, BulkMerge and BulkUpdate — see Operations (SAP HANA)), install the RepoDb.SapHana.BulkOperations package.

> Install-Package RepoDb.SapHana.BulkOperations

Pass new SapHanaBulkDbSetting { WriteToServerExecution = SapHanaWriteToServerExecution.AsyncOverSync } to UseSapHana() to make the bulk operations’ Async overloads use the synchronous HanaBulkCopy path instead of SapHanaCommandBatcher.

Create a Table

The examples below assume the following table exists in the database.

CREATE TABLE "Person"
(
    "Id" BIGINT GENERATED BY DEFAULT AS IDENTITY,
    "Name" NVARCHAR(128),
    "Age" INTEGER,
    "CreatedDateUtc" TIMESTAMP,
    PRIMARY KEY ("Id")
);

Create a Model

The examples below assume the following model exists in the application.

public class Person
{
    public long Id { get; set; }
    public string Name { get; set; }
    public int Age { get; set; }
    public DateTime CreatedDateUtc { get; set; }
}

Creating a Record

To insert a row, use the Insert method.

var person = new Person
{
    Name = "John Doe",
    Age = 54,
    CreatedDateUtc = DateTime.UtcNow
};
using (var connection = new HanaConnection(ConnectionString))
{
    var id = connection.Insert(person);
}

To insert multiple rows, use the InsertAll operation.

var people = GetPeople(100);
using (var connection = new HanaConnection(ConnectionString))
{
    var rowsInserted = connection.InsertAll(people);
}

SAP HANA rejects multi-statement command text, so InsertAll issues one round trip per row (a batchSize greater than 1 throws NotSupportedException) and Insert’s generated key is fetched via a separate GetScopeIdentity call.

Querying a Record

To query a row, use the Query method.

using (var connection = new HanaConnection(ConnectionString))
{
    var person = connection.Query<Person>(e => e.Id == 1);
    /* Process the result here */
}

To query all rows, use the QueryAll method.

using (var connection = new HanaConnection(ConnectionString))
{
    var people = connection.QueryAll<Person>();
    /* Process the results here */
}

SAP HANA has no table-hint syntax — passing a hints argument to any operation throws a NotSupportedException.

Merging a Record

To merge a row, use the Merge method.

var person = new Person
{
    Id = 1,
    Name = "John Doe",
    Age = 57,
    CreatedDateUtc = DateTime.UtcNow
};
using (var connection = new HanaConnection(ConnectionString))
{
    var id = connection.Merge(person);
}

To merge multiple rows, use the MergeAll method.

var people = GetPeople(100);
people
    .AsList()
    .ForEach(p => p.Name = $"{p.Name} (Merged)");
using (var connection = new HanaConnection(ConnectionString))
{
    var affectedRecords = connection.MergeAll<Person>(people);
}

Merge compiles to SAP HANA’s native UPSERT ... WITH PRIMARY KEY, so the primary key value must already be known on the entity, and MergeAll shares InsertAll’s one-round-trip-per-row limit.

Deleting a Record

To delete a row, use the Delete method.

using (var connection = new HanaConnection(ConnectionString))
{
    var deletedRows = connection.Delete<Person>(1);
}

Other columns can also be used as qualifiers.

using (var connection = new HanaConnection(ConnectionString))
{
    var deletedRows = connection.Delete<Person>(p => p.Name == "John Doe");
}

To delete all rows, use the DeleteAll method.

using (var connection = new HanaConnection(ConnectionString))
{
    var deletedRows = connection.DeleteAll<Person>();
}

Delete and DeleteAll both return the number of rows affected.

Updating a Record

To update a row, use the Update method.

var person = new Person
{
    Id = 1,
    Name = "James Doe",
    Age = 55,
    CreatedDateUtc = DateTime.UtcNow
};
using (var connection = new HanaConnection(ConnectionString))
{
    var updatedRows = connection.Update<Person>(person);
}

To update multiple rows, use the UpdateAll method.

var people = GetPeople(100);
people
    .AsList()
    .ForEach(p => p.Name = $"{p.Name} (Updated)");
using (var connection = new HanaConnection(ConnectionString))
{
    var updatedRows = connection.UpdateAll<Person>(people);
}

Update and UpdateAll both return the number of rows affected.

Executing a Query

To execute a non-query statement, use the ExecuteNonQuery method.

using (var connection = new HanaConnection(ConnectionString))
{
    var sql = "DELETE FROM \"Person\" WHERE \"Id\" = :Id";
    var affectedRecords = connection.ExecuteNonQuery(sql, new { Id = 1 });
}

To execute a query and return mapped objects, use the ExecuteQuery method.

using (var connection = new HanaConnection(ConnectionString))
{
    var sql = "SELECT * FROM \"Person\" ORDER BY \"Id\" ASC";
    var people = connection.ExecuteQuery<Person>(sql);
    /* Process the results here */
}

To execute a query and return a scalar value, use the ExecuteScalar method.

using (var connection = new HanaConnection(ConnectionString))
{
    var sql = "SELECT MAX(\"Id\") FROM \"Person\"";
    var maxId = connection.ExecuteScalar<long>(sql);
}

To execute a query and return a DbDataReader, use the ExecuteReader method.

using (var connection = new HanaConnection(ConnectionString))
{
    var sql = "SELECT * FROM \"Person\"";
    using (var reader = connection.ExecuteReader(sql))
    {
        /* Process the data reader here */
    }
}

Executing a Stored Procedure

To execute a stored procedure, use any of the execute methods above and pass CommandType.StoredProcedure to the commandType argument.

using (var connection = new HanaConnection(ConnectionString))
{
    var people = connection.ExecuteQuery<Person>("GetPeople",
        commandType: CommandType.StoredProcedure);
}

Beware of not putting a semi-colon at the end of the calls.

Alternatively, use the CALL command directly, which does not require the commandType argument.

using (var connection = new HanaConnection(ConnectionString))
{
    var people = connection.ExecuteQuery<Person>("CALL GetPeople()");
}

You can also use the types defined at the Passing of Parameters section when passing a parameter.

Typed Result Execution

Single-column result sets can be mapped to any .NET CLR type via ExecuteQuery.

using (var connection = new HanaConnection(ConnectionString))
{
    var sql = "SELECT \"Name\" FROM \"Person\"";
    var names = connection.ExecuteQuery<string>(sql);
}

Returns an IEnumerable object.