kaskada.api.session

Module Contents

Classes

Session
LocalSession	An extension of a kaskada.api.Session that is executed locally. The local session is kept alive by using the LocalSessionKeepAlive.
Builder	Helper class that provides a standard way to create an ABC using
LocalBuilder	Helper class that provides a standard way to create an ABC using

Attributes

logger
KASKADA_PATH_ENV
KASKADA_PATH_DEFAULT
KASKADA_LOG_PATH_DEFAULT
KASKADA_LOG_PATH_ENV
KASKADA_BIN_PATH_DEFAULT
KASKADA_BIN_PATH_ENV
KASKADA_MANAGER_BIN_NAME_DEFAULT
KASKADA_ENGINE_BIN_NAME_DEFAULT
KASKADA_DISABLE_DOWNLOAD_ENV
KASKADA_SESSION

logger

KASKADA_PATH_ENV = 'KASKADA_PATH'

KASKADA_PATH_DEFAULT = '~/.cache/kaskada'

KASKADA_LOG_PATH_DEFAULT = 'logs'

KASKADA_LOG_PATH_ENV = 'KASKADA_LOG_PATH'

KASKADA_BIN_PATH_DEFAULT = 'bin'

KASKADA_BIN_PATH_ENV = 'KASKADA_BIN_PATH'

KASKADA_MANAGER_BIN_NAME_DEFAULT = 'kaskada-manager'

KASKADA_ENGINE_BIN_NAME_DEFAULT = 'kaskada-engine'

KASKADA_DISABLE_DOWNLOAD_ENV = 'KASKADA_DISABLE_DOWNLOAD'

class Session(endpoint, is_secure, client_id=None, client_factory=None)

Parameters:

• endpoint (str) –

• is_secure (bool) –

• client_id (Optional[str]) –

• client_factory (Optional[kaskada.client.ClientFactory]) –

stop()

connect(should_check_health=True)

Parameters:

should_check_health (bool) –

Return type:

kaskada.client.Client

class LocalSession(endpoint, is_secure, manager_service, engine_service, client_id=None, should_keep_alive=True)

Bases: Session

An extension of a kaskada.api.Session that is executed locally. The local session is kept alive by using the LocalSessionKeepAlive.

Parameters:

• endpoint (str) –

• is_secure (bool) –

• manager_service (kaskada.api.local_session.local_service.KaskadaLocalService) –

• engine_service (kaskada.api.local_session.local_service.KaskadaLocalService) –

• client_id (Optional[str]) –

• should_keep_alive (bool) –

keep_alive_watcher: Optional[kaskada.api.local_session.local_session_keep_alive.LocalSessionKeepAlive]

start()

Starts the local session by calling start on all services and connect on the client.

stop()

Stops the local session by calling stop on all services and stops the keep alive watcher.

KASKADA_SESSION: Optional[LocalSession]

class Builder(endpoint=None, is_secure=None, name=None, client_id=None)

Bases: abc.ABC

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

• endpoint (Optional[str]) –

• is_secure (Optional[bool]) –

• name (Optional[str]) –

• client_id (Optional[str]) –

endpoint(endpoint, is_secure)

Parameters:

• endpoint (str) –

• is_secure (bool) –

name(name)

Parameters:

name (str) –

client_id(client_id)

Parameters:

client_id (str) –

class LocalBuilder(endpoint=kaskada.client.KASKADA_DEFAULT_ENDPOINT, is_secure=kaskada.client.KASKADA_IS_SECURE, engine_version='engine@v0.11.0')

Bases: Builder

Helper class that provides a standard way to create an ABC using inheritance.

Parameters:

• endpoint (str) –

• is_secure (bool) –

• engine_version (Optional[str]) –

manager_configs: Dict[str, Any]

engine_configs: Dict[str, Any]

_engine_version: Optional[str]

path(path)

Parameters:

path (str) –

log_path(path)

Parameters:

path (str) –

bin_path(path)

Parameters:

path (str) –

download(download)

Parameters:

download (bool) –

keep_alive(keep_alive)

Parameters:

keep_alive (bool) –

in_memory(in_memory)

Parameters:

in_memory (bool) –

database_path(path)

Parameters:

path (str) –

with_manager_args(configs)

Configure the Manager to run with a list of arguments. The arguments must be prefixed with a “-” and boolean values are represented as “1” or “0”.

For example: ``` from kaskada.api.session import LocalBuilder

session = LocalBuilder().with_manager_configs([

(“-object-store-type”, “local”), (“-object-store-path”, “/Users/kevin.nguyen/Github/kaskada/examples3”), (“-db-in-memory”, “1”), (“-rest-port”, 12345)

]).build()

```

Parameters:

configs (List[Tuple[str, Any]]) – Manager arguments

manager_rest_port(port)

Parameters:

port (int) –

manager_grpc_port(port)

Parameters:

port (int) –

engine_version(version)

Set a specific version of the engine to download. The version must be in the format engine@v<semantic-version>.

Parameters:

version (str) – The git tag for a release on the kaskada repo

Raises:

ValueError – When an invalid version if provided. Note this does not check to the version’s existence on Github.

Returns:

Updated instance of LocalBuilder with the engine version set.

Return type:

LocalBuilder

__get_log_path(file_name)

Parameters:

file_name (str) –

Return type:

pathlib.Path

__get_std_paths(service_name)

Parameters:

service_name (str) –

Return type:

Tuple[pathlib.Path, pathlib.Path]

__get_binary_path()

Return type:

pathlib.Path

__get_local_services()

Return type:

Tuple[kaskada.api.local_session.local_service.KaskadaLocalService, kaskada.api.local_session.local_service.KaskadaLocalService]

__download_release(engine_version=None)

Downloads a kaskada release version to the binary path.

Parameters:

engine_version (Optional[str]) – The engine version to download, e.g., engine@v<semantic-version>. Defaults to None for latest release.

build()

Builds the local session. Starts by downloading the latest release and starting the local binaries.

Returns:

The local session object

Return type:

LocalSession