Bulk Analyses Dataset Census

Module: spectralbridge.bulk.analyses.dataset_census.

Fast catalog-only preflight census for a bulk collection.

API glossary · Workflow / scientific context

Signatures and documentation below are collected from the current source. Advanced objects are not newly declared stable by inclusion here.

Audience: advanced.

DatasetCensusPaths dataclass

DatasetCensusPaths(directory: Path)

Resolve compact census tables and report paths beneath a bulk analysis run.

summary_parquet property

summary_parquet: Path

summary_json property

summary_json: Path

report property

report: Path

by_site property

by_site: Path

by_year property

by_year: Path

by_sensor property

by_sensor: Path

by_schema property

by_schema: Path

by_product property

by_product: Path

missing_products property

missing_products: Path

inconsistencies property

inconsistencies: Path

by_exclusion_reason property

by_exclusion_reason: Path

Audience: public. Also exported as spectralbridge.bulk.analyses.run_dataset_census, spectralbridge.bulk.run_dataset_census.

run_dataset_census

run_dataset_census(con: DuckDBPyConnection, paths: BulkAnalysisPaths, *, analysis_run_id: str, reuse_existing: bool = True) -> dict[str, Any]

Write metadata-only census tables without scanning observation values.

Parameters:

Name	Type	Description	Default
con	DuckDBPyConnection	Open DuckDB connection prepared by the bulk workflow with the required catalog and observation views; the caller owns its lifetime.	required
paths	BulkAnalysisPaths	BulkAnalysisPaths instance selecting isolated catalog, database, analysis and report locations.	required
analysis_run_id	str	Provenance identifier written into generated tables and restart metadata for this run.	required
reuse_existing	bool	Reuse valid analysis outputs when their recorded inputs match, rather than recomputing them.	True

Returns:

Type	Description
dict[str, Any]	Status, summary counts and paths to census Parquet, JSON, missing-product table and report.

See Also

spectralbridge.pipelines.bulk.run_bulk_pipeline : Related source-derived API contract.

Explicitly exported constants and type aliases

These values describe package metadata, schemas or configuration; they are not observations from a production dataset.

Name	Source expression
REQUIRED_INPUT_TABLES	('flightlines', 'source_files')