atoti_query.QuerySession#

class atoti_query.QuerySession#

Used to query a remote Atoti session.

Note

The cube and table structure of a query session is expected to be immutable.

__init__(url, *, auth=None, certificate_authority=None, client_certificate=None, **kwargs)#

Create a query session.

Parameters:
  • url (str) – The base URL of the session. The endpoint f"{url}/versions/rest" is expected to exist.

  • auth (Callable[[str], Mapping[str, str]] | None) – The authentication to use to access the session.

  • certificate_authority (str | Path | None) – Path to the custom certificate authority file to use to verify the HTTPS connection. Required when the session has been configured with a certificate that is not signed by some trusted public certificate authority.

  • client_certificate (ClientCertificate | None) – The client certificate to authenticate against the session.

cubes

Cubes of the session.

link

Display a link to this session.

query_mdx

Execute an MDX query and return its result as a pandas DataFrame.

url

URL of the session.

widget

Display an Atoti widget to explore the session interactively.