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.cli_options module¶
servicex.app.codegen module¶
servicex.app.main module¶
- servicex.app.main.deliver(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, spec_file: str = <typer.models.ArgumentInfo object>, ignore_cache: bool | None = <typer.models.OptionInfo object>)[source]¶
Deliver a file to the ServiceX cache.
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.cancel(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id_list: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]¶
Cancel a running transform request.
- 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.delete(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id_list: ~typing.List[str] = <typer.models.ArgumentInfo object>)[source]¶
Delete a completed transform along with the result files.
- servicex.app.transforms.download(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo object>, local_dir: str = <typer.models.OptionInfo object>, concurrency: int = <typer.models.OptionInfo object>)[source]¶
Download the files that were produced by a transform.
- servicex.app.transforms.files(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo object>)[source]¶
List the files that were produced by a transform.
- servicex.app.transforms.list(backend: str | None = <typer.models.OptionInfo object>, config_path: str | None = <typer.models.OptionInfo object>, complete: bool | None = <typer.models.OptionInfo object>, running: bool | None = <typer.models.OptionInfo object>)[source]¶
List the transforms that have been run.
- servicex.app.transforms.logs(backend: str | None = <typer.models.OptionInfo object>, transform_id: str = <typer.models.ArgumentInfo 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