Bamboost
bamboostcliindexing

bamboost.cli.indexing

Source: https://gitlab.com/cmbm-ethz/bamboost/-/blob/main/bamboost/cli/indexing.py

Attributes

  • app_index=typer.Typer(name='index', help='API for displaying and managing the collection index.', no_args_is_help=True)

Functions

list(collection_uid=None, simulation_name=None, sync_fs=typer.Option(False, '--sync', '-s', help='Sync the collection with the filesystem.'), nb_entries=typer.Option(None, '--entries', '-n', help='Number of entries to display.'))

List all collections, or all simulations in a specified collection. (alias: "ls")

Arguments:
  • collection_uid:typing.Annotated[typing.Optional[str], typer.typer.Argument(autocompletion=(bamboost.cli._completion._get_uids_from_db), help='UID of the collection to list simulations for.')]=None
  • simulation_name:typing.Annotated[typing.Optional[str], typer.typer.Argument(help='Name of the simulation to display. If not provided, the collection is listed.', autocompletion=(bamboost.cli._completion._get_simulation_names))]=None
  • sync_fs:bool=typer.Option(False, '--sync', '-s', help='Sync the collection with the filesystem.')
  • nb_entries:typing.Optional[int]=typer.Option(None, '--entries', '-n', help='Number of entries to display.')
clean()

Clean the index of any stale entries.

scan()

Scan the search paths for collections.

drop(uid=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to drop from the index.')) -> None

Drop a collection from the index by its unique ID (or an alias).

Arguments:
  • uid:str=typer.Argument(..., autocompletion=(_completion._get_uids_from_db), help='The unique ID of the collection to drop from the index.')
_assert_database_exists() -> bool

Check if the database exists.

_app_callback()

Display the database file (project path).

config

Previous Page

core

Next Page

On this page

Attributes
Functions
list
clean
scan
drop
_assert_database_exists
_app_callback