servicex.app package#

Submodules#

servicex.app.cache module#

servicex.app.cache.cache()[source]#: Sub-commands for creating and manipulating the local query cache

servicex.app.cache.clear(force: bool = <typer.models.OptionInfo object>)[source]#: Clear the local query cache

servicex.app.cache.delete(transform_id: str = <typer.models.OptionInfo object>)[source]#: Delete a cached query. Use -t to specify the transform ID

servicex.app.cache.list()[source]#: List the cached queries

servicex.app.cli_options module#

servicex.app.codegen module#

servicex.app.codegen.flush(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>)[source]#: Flush the available code generators from the cache

servicex.app.codegen.list(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>)[source]#: List the available code generators

servicex.app.main module#

servicex.app.main.main_info(version: bool | None = <typer.models.OptionInfo object>)[source]#: ServiceX Client

servicex.app.main.show_version(show: bool)[source]#: Display the installed version and quit.

servicex.app.transforms module#

class servicex.app.transforms.LogLevel(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

Level of the log messages: INFO & ERROR

error = 'ERROR'#

info = 'INFO'#

class servicex.app.transforms.TimeFrame(value, names=<not given>, *values, module=None, qualname=None, type=None, start=1, boundary=None)[source]#

Bases: str, Enum

Time Frame levels: ‘day’, ‘week’ & ‘month’

day = 'day'#

month = 'month'#

week = 'week'#

servicex.app.transforms.add_query(key, value)[source]#: Creates query string from the key and value pairs

servicex.app.transforms.create_kibana_link_parameters(log_url, transform_id=None, log_level=None, time_frame=None)[source]#: Create the _a and _g parameters for the kibana dashboard link

servicex.app.transforms.download(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.OptionInfo object>, local_dir: str = <typer.models.OptionInfo object>)[source]#: Download the files that were produced by a transform.

servicex.app.transforms.files(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.OptionInfo object>)[source]#: List the files that were produced by a transform.

servicex.app.transforms.list(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>, complete: bool | None = <typer.models.OptionInfo object>)[source]#: List the transforms that have been run.

servicex.app.transforms.logs(url: str | None = <typer.models.OptionInfo object>, backend: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.OptionInfo object>, log_level: ~servicex.app.transforms.LogLevel | None = <typer.models.OptionInfo object>, time_frame: ~servicex.app.transforms.TimeFrame | None = <typer.models.OptionInfo object>)[source]#: Open the URL to the Kibana dashboard of the logs of a tranformer

servicex.app.transforms.select_time(time_frame=TimeFrame.day)[source]#: Takes input as ‘day’,’week’,’month’ and returns the time filter

servicex.app.transforms.transforms()[source]#: Sub-commands for interacting with transforms.

Module contents#