Client

The client package contains functionality for user authentication and logging requests.

Auth

Service Account authentication class for Firebolt Database.

Gets authentication token using provided credentials and updates it when it expires.

param client_id:

Client ID

type client_id:

str

param client_secret:

Client secret

type client_secret:

str

param use_token_cache:

True if token should be cached in filesystem; False otherwise

type use_token_cache:

bool

firebolt.client.auth.client_credentials.ClientCredentials.client_id

Client ID

Type:

str

firebolt.client.auth.client_credentials.ClientCredentials.client_secret

Client secret

Type:

str

Client

class firebolt.client.client.AsyncClient(*args: Any, **kwargs: Any)

Bases: FireboltClientMixin, AsyncClient

abstract property account_id: str

class firebolt.client.client.AsyncClientV1(*args: Any, auth: Auth, account_name: str | None = None, api_endpoint: str = 'api.app.firebolt.io', **kwargs: Any)

Bases: AsyncClient

An HTTP client, based on httpx.Client.

Handles the authentication for Firebolt database. Authentication can be passed through auth keyword as a tuple or as a FireboltAuth instance

property account_id: str

User account ID.

If account_name was provided during Client construction, returns its ID; gets default account otherwise.

Returns:

Account ID

Return type:

str

Raises:

AccountNotFoundError – No account found with provided name

class firebolt.client.client.AsyncClientV2(*args: Any, auth: Auth, account_name: str, api_endpoint: str = 'api.app.firebolt.io', **kwargs: Any)

Bases: AsyncClient

An HTTP client, based on httpx.Client.

Handles the authentication for Firebolt database. Authentication can be passed through auth keyword as a tuple or as a FireboltAuth instance

property account_id: str

User account ID.

If account_name was provided during Client construction, returns its ID; gets default account otherwise.

Returns:

Account ID

Return type:

str

Raises:

AccountNotFoundError – No account found with provided name

class firebolt.client.client.Client(*args: Any, **kwargs: Any)

Bases: FireboltClientMixin, Client

abstract property account_id: str

class firebolt.client.client.ClientV1(*args: Any, auth: Auth, account_name: str | None = None, api_endpoint: str = 'api.app.firebolt.io', **kwargs: Any)

Bases: Client

An HTTP client, based on httpx.Client.

Handles the authentication for Firebolt database. Authentication can be passed through auth keyword as a tuple or as a FireboltAuth instance

property account_id: str

User account ID.

If account_name was provided during Client construction, returns its ID; gets default account otherwise.

Returns:

Account ID

Return type:

str

Raises:

AccountNotFoundError – No account found with provided name

class firebolt.client.client.ClientV2(*args: Any, auth: Auth, account_name: str, api_endpoint: str = 'api.app.firebolt.io', **kwargs: Any)

Bases: Client

An HTTP client, based on httpx.Client.

Handles the authentication for Firebolt database. Authentication can be passed through auth keyword as a tuple or as a FireboltAuth instance

property account_id: str

User account ID.

If account_name was provided during Client construction, returns its ID; gets default account otherwise.

Returns:

Account ID

Return type:

str

Raises:

AccountNotFoundError – No account found with provided name