Common
The common package contains settings parameters and error exceptions.
Settings
- class firebolt.common.settings.Settings(_env_file: Optional[Union[str, PathLike]] = '<object object>', _env_file_encoding: Optional[str] = None, _env_nested_delimiter: Optional[str] = None, _secrets_dir: Optional[Union[str, PathLike]] = None, *, auth: Auth = None, user: str = None, password: SecretStr = None, access_token: str = None, account_name: str = None, server: str, default_region: str, use_token_cache: bool = True)
Bases:
BaseSettings
Settings for Firebolt SDK.
- user
User name
- Type
Optional[str]
- password
User password
- Type
Optional[str]
- access_token
Access token to use for authentication Mutually exclusive with user and password
- Type
Optional[str]
- account_name
Account name Default user account is used if none provided
- Type
Optional[str]
- server
Environment api endpoint (Advanced) Default api endpoint is used if none provided
- Type
Optional[str]
- default_region
Default region for provisioning
- Type
str
Exception
- exception firebolt.utils.exception.AccountNotFoundError(account_name: str)
Bases:
FireboltError
Account with provided name doesn’t exist.
- Parameters
account_name (str) – Name of account that wasn’t found
- account_name
Name of account that wasn’t found
- Type
str
- exception firebolt.utils.exception.AlreadyBoundError
Bases:
FireboltEngineError
Engine is already bound to a database.
Bases:
ProgrammingError
If use_standard_sql is specified the query status endpoint returns a JSON object with empty values instead of a proper status object. In that case, it is not possible to retrieve the results of an asynchronous query.
- exception firebolt.utils.exception.AttachedEngineInUseError(method_name: str)
Bases:
FireboltDatabaseError
Engine unavailable because it’s starting/stopping.
- Parameters
method_name (str) – Method that caused the error
- method_name
Method that caused the error
- Type
str
- exception firebolt.utils.exception.AuthenticationError(cause: str)
Bases:
FireboltError
Firebolt authentication error.
Stores error cause and authentication endpoint.
- Parameters
api_endpoint (str) – Environment api endpoint used for authentication
cause (str) – Reason for authentication failure
- api_endpoint
Environment api endpoint used for authentication
- Type
str
- cause
Reason for authentication failure
- Type
str
- exception firebolt.utils.exception.AuthorizationError(cause: str)
Bases:
FireboltError
Firebolt authentication error.
- Parameters
cause (str) – Reason for authorization failure
- cause
Reason for authorization failure
- Type
str
- exception firebolt.utils.exception.ConfigurationError
Bases:
InterfaceError
Invalid configuration error.
- exception firebolt.utils.exception.ConnectionClosedError
Bases:
ConnectionError
Connection operations are unavailable since it’s closed.
- exception firebolt.utils.exception.ConnectionError
Bases:
FireboltError
Base class for connection related errors.
- exception firebolt.utils.exception.CursorClosedError(method_name: str)
Bases:
CursorError
Cursor operations are unavailable since it’s closed.
- Parameters
method_name (str) – Method that caused the error
- method_name
Method that caused the error
- Type
str
- exception firebolt.utils.exception.CursorError
Bases:
FireboltError
Base class for cursor related errors.
- exception firebolt.utils.exception.DataError
Bases:
DatabaseError
Data processing error.
Exception raised for errors that are due to problems with the processed data, like division by zero, numeric value out of range, etc.
- exception firebolt.utils.exception.DatabaseError
Bases:
FireboltError
Exception raised for errors that are related to the database.
- exception firebolt.utils.exception.EngineNotRunningError
Bases:
FireboltEngineError
Engine that’s being queried is not running.
- firebolt.utils.exception.Error
alias of
FireboltError
- exception firebolt.utils.exception.FireboltDatabaseError
Bases:
FireboltError
Base class for database related errors.
- exception firebolt.utils.exception.FireboltEngineError
Bases:
FireboltError
Base class for engine related errors.
- exception firebolt.utils.exception.FireboltError
Bases:
Exception
Base class for all Firebolt errors.
- exception firebolt.utils.exception.IntegrityError
Bases:
DatabaseError
Database data integrity error.
Exception raised when the relational integrity of the database is affected, e.g., a foreign key check fails.
- exception firebolt.utils.exception.InterfaceError
Bases:
FireboltError
Database interface related error.
Exception raised for errors that are related to the database interface rather than the database itself.
- exception firebolt.utils.exception.InternalError
Bases:
DatabaseError
Database internal error.
Exception raised when the database encounters an internal error, e.g., the cursor is not valid anymore, the transaction is out of sync, etc.
- exception firebolt.utils.exception.NoAttachedDatabaseError(method_name: str)
Bases:
FireboltEngineError
Engine that’s being accessed is not running.
- Parameters
method_name (str) – Method that caused the error
- method_name
Method that caused the error
- Type
str
- exception firebolt.utils.exception.NotSupportedError
Bases:
DatabaseError
Operation not supported.
Exception raised in case a method or database API was used which is not supported by the database, e.g., requesting a .rollback() on a connection that does not support transaction or has transactions turned off.
- exception firebolt.utils.exception.OperationalError
Bases:
DatabaseError
Database operating error.
Exception raised for errors that are related to the database’s operation and not necessarily under the control of the programmer, e.g., an unexpected disconnect occurs, the data source name is not found, a transaction could not be processed, a memory allocation error occurred during processing, etc.
- exception firebolt.utils.exception.ProgrammingError
Bases:
DatabaseError
Database programming error.
Exception raised for programming errors, e.g., table not found or already exists, syntax error in the SQL statement, wrong number of parameters specified, etc.
- exception firebolt.utils.exception.QueryNotRunError(method_name: str)
Bases:
CursorError
Some cursor methods are unavailable before a query is run.
- Parameters
method_name (str) – Method that caused the error
- method_name
Method that caused the error
- Type
str
- exception firebolt.utils.exception.Warning
Bases:
Exception
Base class for warning exceptions.
Exception raised for important warnings, like data truncations while inserting, etc.