pytimber.LoggingDB

class pytimber.LoggingDB(appid: str = 'PYTIMBER4', clientid: str = 'PYTIMBER3', source: str = 'nxcals', loglevel: Optional[Union[str, int]] = None, sparkconf: Optional[str] = None, sparkprops: Optional[Mapping[str, str]] = None, kerberosprincipal: Optional[str] = None, kerberoskeytab: Optional[str] = None, data_location: str = 'pro', spark_session: Optional[SparkSession] = None, service_url: str = 'https://cs-ccr-nxcals6.cern.ch:19093,https://cs-ccr-nxcals7.cern.ch:19093,https://cs-ccr-nxcals8.cern.ch:19093')

Methods

LoggingDB.__init__([appid, clientid, ...])

Initializes a new instance of the PyTimber client.

LoggingDB.get(pattern_or_list, t1[, t2, ...])

Query for a list of variables or for variables whose name matches a pattern (string) in a time window from t1 to t2 and return corresponding variable(s) data.

LoggingDB.getAligned(pattern_or_list, t1, t2)

Use get aligned instead

LoggingDB.getChildrenForHierarchies(...[, ...])

Use get_children_for_hierarchies instead

LoggingDB.getDataUsingSnapshots(pattern_or_list)

Use get_data_using_snapshots instead

LoggingDB.getDescription(pattern)

Use get_variable_description instead

LoggingDB.getFundamentals(t1, t2, fundamental)

Use get_fundamentals instead

LoggingDB.getHierarchiesForVariables(...)

Use get_hierarchies_for_variables instead

LoggingDB.getIntervalsByLHCModes(t1, t2, ...)

Use get_interval_by_lhc_modes instead

LoggingDB.getLHCFillData([fill_number, unixtime])

Use get_lhc_fill_data instead

LoggingDB.getLHCFillsByTime(t1, t2[, ...])

Use get_lhc_fills_by_time instead

LoggingDB.getMetaData(pattern_or_list)

Use get_meta_data instead

LoggingDB.getScaled(pattern_or_list, t1, t2)

Use get_scaled instead

LoggingDB.getSnapshotNames(pattern_or_list)

Use get_snapshot_names instead

LoggingDB.getStats(pattern_or_list, t1, t2)

Use get_variable_stats instead

LoggingDB.getUnit(pattern)

Use get_variable_unit instead

LoggingDB.getVariable(variable, t1[, t2, ...])

Use get_variable instead

LoggingDB.getVariablesForHierarchies(...[, ...])

Use get_variables_for_hierarchies instead

LoggingDB.getVariablesForSnapshots(...[, ...])

Use get_variables_for_snapshots instead

LoggingDB.getVariablesOrigin(pattern_or_list)

Use get_variable_origin instead

LoggingDB.get_aligned(pattern, t1, t2[, ...])

Retrieves the aligned data for the given pattern of variables within the specified time range [t1, t2], based on the fundamental and master variable.

LoggingDB.get_children_for_hierarchies(...)

Get a list of children hierarchy paths for given parent hierarchy paths.

LoggingDB.get_data_using_snapshots(...[, ...])

Get data for variables attached to snapshots which are selected by provided list of strings or pattern in a time window defined in the snapshot configuration

LoggingDB.get_fundamentals(t1, t2, pattern)

Gets list of FundamentalVariable objects between two timestamps for a given pattern.

LoggingDB.get_hierarchies_for_variables(...)

Get a list of hierarchy paths for variables (in which given variables are defined).

LoggingDB.get_interval_by_lhc_modes(t1, t2, ...)

Returns a list of FillInterval objects for the given time window and two LHC beam modes

LoggingDB.get_lhc_fill_data([fill_number])

Gets times and beam modes for a particular LHC fill.

LoggingDB.get_lhc_fills_by_time(from_time, ...)

Returns a list of LHC fills data that occurred within the specified time range.

LoggingDB.get_meta_data(pattern)

Retrieves metadata for vector variables (so called vector contexts) matching a pattern.

LoggingDB.get_scaled(pattern, t1, t2[, ...])

Retrieves the scaled data for the given pattern of variables in a time window from t1 to t2.

LoggingDB.get_snapshot_names(pattern_or_list)

Get a list of snapshots names based on a list of strings or a pattern, filtered by owner pattern and description pattern.

LoggingDB.get_variable(variable, t1[, t2, ...])

Query for a specific variable within a time window and with the option to filter by fundamentals and return corresponding variable data.

LoggingDB.get_variable_description(pattern)

Gets description(s) for the given variable pattern.

LoggingDB.get_variable_origin(pattern)

Gets the system origin(s) for the given variable pattern.

LoggingDB.get_variable_stats(pattern, ...[, ...])

Gets variable statistics for the specified time range.

LoggingDB.get_variable_unit(pattern)

Gets unit(s) for the given variable pattern.

LoggingDB.get_variables_for_hierarchies(...)

Get a list of variables attached to hierarchies.

LoggingDB.get_variables_for_snapshots(...[, ...])

Get variables attached to snapshots.

LoggingDB.search(pattern)

Use search_variables instead

LoggingDB.searchFundamental(fundamental, t1)

Use search_fundamentals instead

LoggingDB.search_fundamentals(fundamental, t1)

Searches for fundamental variables names that match the specified pattern within the specified time range.

LoggingDB.search_variables(pattern)

Searches for variable names that match the given pattern.