> ## Documentation Index
> Fetch the complete documentation index at: https://cubed3-pavel-claude-modest-planck-ceg4c0.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# `cube` package

> The cube Python package provides tools for setting configuration options and the Jinja template context for YAML data models.

`cube` package contains tools for setting [configuration
options][ref-config-options] and providing the Jinja template context for
the data model in [YAML][ref-model-syntax].

* `cube` package is available out of the box, it doesn't need to be installed explicitly
* Submit issues to [`cube`][link-cube-repo-issues] on GitHub

## Reference

### `config` object

This object is used to set configuration options in the `cube.py` file.

You can set properties of this object, named after supported [configuration
options][ref-ref-config-options], to values or functions that would be used
as these configuration options.

```python theme={null}
from cube import config

config.base_path = '/cube-api'

config.context_to_app_id = lambda ctx: ctx['securityContext']['tenant_id']

def rewrite(query, ctx):
  query['measures'].append('orders.count')
  return query

config.query_rewrite = rewrite
```

Alternatively, this object can be used as a decorator with a single
`name` argument. In that case, the decorated function will be set as the
configuration option under that `name`.

```python theme={null}
from cube import config

@config('context_to_app_id')
def app_id(ctx):
  return ctx['securityContext']['tenant_id']

@config('query_rewrite')
def rewrite(query, ctx):
  query['measures'].append('orders.count')
  return query
```

### `TemplateContext` class

Instances of this class are used for registering variables, functions, and
filters so that they are accessible from Jinja templates when defining the
data model in YAML.

```python theme={null}
from cube import TemplateContext

template = TemplateContext()
```

#### `add_variable`

The `add_variable` method registers a variable so that it's available in
a Jinja template. Should be called with two arguments, a `name` and a `value`
of the variable.

```python theme={null}
from cube import TemplateContext

template = TemplateContext()

# Accessible from Jinja as 'my_var'
template.add_variable('my_var', 123)
```

#### `add_function` and `function`

The `add_function` method registers a function so that it's callable from
a Jinja template as a Python function. Should be called with two arguments,
a `name` and a function that will be registered under that `name`:

```python theme={null}
from cube import TemplateContext

template = TemplateContext()

# Accessible from Jinja as 'get_data()'
def get_data_1():
  return 1
template.add_function('get_data', get_data_1)
```

Also, you can use the `template.function` decorator with a single `name`
argument; the decorated function will be registered under that `name`:

```python theme={null}
from cube import TemplateContext

template = TemplateContext()

# Accessible from Jinja as 'get_more_data()'
@template.function('get_more_data')
def get_data_2():
  return 2
```

#### `add_filter` and `filter`

The `add_filter` method registers a function so that it's callable from
a Jinja template as a [Jinja filter][link-jinja-filters]. Should be called
with two arguments, a `name` and a function that will be registered as a filter
under that `name`:

```python theme={null}
from cube import TemplateContext

template = TemplateContext()

# Accessible from Jinja as 'data | wrap'
def wrap_1(data):
  return f"< {data} >"
template.add_filter('wrap', wrap_1)
```

Also, you can use the `template.filter` decorator with a single `name`
argument; the decorated function will be registered as a filter under that
`name`:

```python theme={null}
from cube import TemplateContext

template = TemplateContext()

# Accessible from Jinja as 'data | wrap_more'
@template.filter('wrap_more')
def wrap_2(data):
  return f"<<< {data} >>>"
```

### `memo` decorator

The `memo` decorator calls a function once per set of arguments during a data
model compilation, then returns the stored result, or raises the stored
exception, on every later call from any template. It works with sync and async
functions. Arguments match when they are equal and of the same type: hashable
values (e.g. numbers, strings, dates or frozen dataclasses), lists, tuples,
dicts and sets. Other objects, e.g. a regular dataclass or `self` of a method,
match only themselves. Apply it below `template.function`. Calls made while a
template function runs, including calls between your own Python functions and to
memoized functions imported from other modules, are cached per compilation.
Other calls, e.g., while `globals.py` loads or to methods of objects a template
function returned, aren't cached:

```python theme={null}
from cube import TemplateContext, memo

template = TemplateContext()

# Fetched once per compilation, however many templates call it
@template.function('load_tables')
@memo
def load_tables(schema):
  return MyApiClient().tables(schema)
```

[link-cube-repo-issues]: https://github.com/cube-js/cube/issues

[link-jinja-filters]: https://jinja.palletsprojects.com/en/3.1.x/templates/#filters

[ref-config-options]: /admin/connect-to-data#configuration-options

[ref-ref-config-options]: /reference/configuration/config

[ref-model-syntax]: /docs/data-modeling/concepts/syntax#model-syntax


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.