# CosmosDBCacheSync

> **Class** in `langchain_azure_cosmosdb`

📖 [View in docs](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync)

Synchronous CosmosDB implementation of LangGraph BaseCache.

Uses environment variables for connection configuration.

## Signature

```python
CosmosDBCacheSync(
    self,
    database_name: str,
    container_name: str,
    *,
    endpoint: str | None = None,
    key: str | None = None,
    serde: SerializerProtocol | None = None,
    cosmos_client_kwargs: dict[str, Any] | None = None,
)
```

## Description

**Environment Variables:**

COSMOSDB_ENDPOINT: CosmosDB endpoint URL (required).
COSMOSDB_KEY: CosmosDB access key (optional, uses
    DefaultAzureCredential if not provided).

**Example:**

>>> import os
>>> os.environ["COSMOSDB_ENDPOINT"] = (
...     "https://your-account.documents.azure.com:443/"
... )
>>> os.environ["COSMOSDB_KEY"] = "your_key"
>>>
>>> cache = CosmosDBCacheSync(
...     database_name="langgraph_db",
...     container_name="cache",
... )

## Parameters

| Name | Type | Required | Description |
|------|------|----------|-------------|
| `database_name` | `str` | Yes | Name of the CosmosDB database. |
| `container_name` | `str` | Yes | Name of the CosmosDB container. |

## Extends

- `BaseCache[ValueT]`

## Constructors

```python
__init__(
    self,
    database_name: str,
    container_name: str,
    *,
    endpoint: str | None = None,
    key: str | None = None,
    serde: SerializerProtocol | None = None,
    cosmos_client_kwargs: dict[str, Any] | None = None,
) -> None
```

| Name | Type |
|------|------|
| `database_name` | `str` |
| `container_name` | `str` |
| `endpoint` | `str \| None` |
| `key` | `str \| None` |
| `serde` | `SerializerProtocol \| None` |
| `cosmos_client_kwargs` | `dict[str, Any] \| None` |


## Properties

- `container`
- `client`
- `database`

## Methods

- [`close()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/close)
- [`from_conn_info()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/from_conn_info)
- [`get()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/get)
- [`aget()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/aget)
- [`set()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/set)
- [`aset()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/aset)
- [`clear()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/clear)
- [`aclear()`](https://reference.langchain.com/python/langchain-azure-cosmosdb/_langgraph_cache/CosmosDBCacheSync/aclear)

---

[View source on GitHub](https://github.com/langchain-ai/langchain-azure/blob/e62c2a55aaa0942fdac739b4066011953b80018e/libs/azure-cosmosdb/src/langchain_azure_cosmosdb/_langgraph_cache.py#L22)