> For the complete documentation index, see [llms.txt](https://docs.umbcheckout.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbcheckout.net/v17/core-services/addons/database-service.md).

# Database Service

A service which handles storing of the Basket in the database

{% hint style="info" %}
This feature requires a paid license. On an unlicensed site the service reads and writes nothing.
{% endhint %}

The database service is what handles the retrieval, insertion, updating, and clearing of the UmbCheckout Basket within the database. A Basket is stored only when **Store Basket In The Database** is on in the [configuration](/v17/configuration/configuration-options.md), and there is one row per session, site root culture and currency.

You can access the database service by injecting `IDatabaseService` which can be found within the namespace `UmbCheckout.Core.Addons.Interfaces`

Every method takes an optional `CancellationToken` as its last parameter.

#### GetBasketAsync

Gets the stored Basket for one site root culture and currency

| Name            | Detail                                                                                  |
| --------------- | --------------------------------------------------------------------------------------- |
| sessionId       | The session to retrieve the [Basket](/v17/core-services/object-reference/basket.md) for |
| siteRootCulture | The culture of the site root                                                            |
| currencyCode    | The 3-letter ISO currency code                                                          |

```csharp
Task<Basket?> GetBasketAsync(string sessionId, string? siteRootCulture, string? currencyCode, CancellationToken cancellationToken = default);
```

#### GetBasketsAsync

Gets every stored Basket for a session (one per site root culture and currency)

```csharp
Task<IEnumerable<Basket>> GetBasketsAsync(string sessionId, CancellationToken cancellationToken = default);
```

#### UpdateBasketAsync

Updates the stored Basket. Nothing is written when the Basket hasn't changed, so reading a Basket doesn't extend its expiry.

| Name      | Detail                                                                               |
| --------- | ------------------------------------------------------------------------------------ |
| sessionId | The session to store the [Basket](/v17/core-services/object-reference/basket.md) for |
| basket    | The [Basket](/v17/core-services/object-reference/basket.md) to be stored             |

```csharp
Task<Basket?> UpdateBasketAsync(string sessionId, Basket basket, CancellationToken cancellationToken = default);
```

#### DeleteBasketAsync

Deletes the stored Basket for one site root culture and currency

```csharp
Task DeleteBasketAsync(string sessionId, string? siteRootCulture, string? currencyCode, CancellationToken cancellationToken = default);
```

#### DeleteBasketsAsync

Deletes every stored Basket last updated before the date (UTC), and returns how many were deleted

| Name      | Detail                          |
| --------- | ------------------------------- |
| expiryUtc | The date to delete from, in UTC |

```csharp
Task<int> DeleteBasketsAsync(DateTime expiryUtc, CancellationToken cancellationToken = default);
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.umbcheckout.net/v17/core-services/addons/database-service.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
