API Reference¶
This section provides comprehensive API documentation for all BSPump modules.
- bspump
BSPumpApplicationBSPumpServicePipelinePumpBuilderSourceTriggerSourceSinkProcessorGeneratorConnectionAnalyzerProcessingErrorLookupMappingLookupDictionaryLookupload_json_file()MatrixPersistentMatrixNamedMatrixModelPersistentNamedMatrixAnomaly- BSPumpApplication
- BSPumpService
- Pipeline
- PumpBuilder
- Source
- TriggerSource
- Processor
- Generator
- Sink
- Connection
- Lookup
- DictionaryLookup
- MappingLookup
- ProcessingError
- Analyzer
- Matrix
- bspump.abc
- bspump.common
BytesToStringParserStringToBytesParserFlattenDictProcessorHexlifyProcessorIteratorGeneratorIteratorSourceStdDictToJsonParserStdJsonToDictParserMappingKeysGeneratorMappingValuesGeneratorMappingItemsGeneratorMappingKeysProcessorMappingValuesProcessorMappingItemsProcessorNullSinkPrintSinkPPrintSinkPrintProcessorPPrintProcessorPrintContextProcessorPPrintContextProcessorInternalSourceRouterProcessorRouterSinkTeeProcessorTeeSourceTimeZoneNormalizerMappingTransformatorDirectSourceAggregationStrategyAggregatorListAggregationStrategyListEventAggregationStrategyStringAggregationStrategyDictToJsonBytesParser- Sinks
- Processors
- Utility Functions
- bspump.kafka
- bspump.http
- bspump.postgresql
- bspump.mongodb
- bspump.elasticsearch
- bspump.mqtt
- bspump.file
- bspump.trigger
- bspump.lookup
- bspump.analyzer
- bspump.matrix
SessionMatrixExportCSVGeneratorTimeWindowMatrixExportCSVGeneratorMatrixSourceMatrixPersistentMatrixNamedMatrixPersistentTimeWindowMatrixSessionMatrixPersistentSessionMatrixGeoMatrixPersistentGeoMatrix- Matrix
- PersistentMatrix
- NamedMatrix
- PersistentNamedMatrix
- Using in Analyzers
- Matrix Operations
- Configuration
- Best Practices
- bspump.jupyter
deploy()init_bitswan_jupyter()sample_events()register_app_post_init()register_connection()retrieve_sample_events()register_lookup()new_pipeline()end_pipeline()register_source()register_processor()register_generator()register_sink()step()async_step()Appauto_pipeline()add_test_probe()SkipEventFinalizeEvent- Core Functions
- Decorators
- Pipeline Building
- Testing
- Sampling
- Deployment
- Application Access
- Cell Processing
Core Modules¶
Module |
Description |
|---|---|
Main module with Application, Pipeline, Service |
|
Abstract base classes: Source, Processor, Sink, Connection |
|
Common utilities and processors |
|
Triggers: CronTrigger, PubSubTrigger, etc. |
|
Lookup tables for data enrichment |
|
Analyzers for aggregation and statistics |
|
Matrix data structures |
|
Jupyter notebook integration |
Integration Modules¶
Module |
Description |
|---|---|
Apache Kafka integration |
|
HTTP webhook and client |
|
PostgreSQL database |
|
MongoDB database |
|
Elasticsearch |
|
MQTT messaging |
|
File-based sources and sinks |
Additional Modules¶
BSPump also includes these modules (see source code for details):
bspump.amqp- AMQP/RabbitMQ integrationbspump.influxdb- InfluxDB time-series databasebspump.mysql- MySQL databasebspump.odbc- ODBC database connectionsbspump.ftp- FTP file transferbspump.ssh- SSH/SFTP connectionsbspump.slack- Slack integrationbspump.googledrive- Google Drive integrationbspump.ldap- LDAP directory servicesbspump.zookeeper- Apache ZooKeeperbspump.crypto- Cryptographic processorsbspump.declarative- Declarative expressionsbspump.aggregation- Aggregation utilitiesbspump.anomaly- Anomaly detectionbspump.cache- Caching utilitiesbspump.filter- Filtering processorsbspump.integrity- Data integrity checksbspump.random- Random data generationbspump.socket- Socket-based communicationbspump.subprocess- Subprocess managementbspump.timeseries- Time-series utilitiesbspump.parquet- Parquet file supportbspump.avro- Avro serialization