This is the main engine of Databus. It is responsible of scheduling & invoking drivers; which are responsible of actually transporting data between systems.
Typically, your main access point to databus is the dispatcher. When you start up the dispatcher, it means that Databus is up and running. Check startup for alternative ways of starting Databus.
To start the dispatcher, you might probably need to provide a dispatcher ticket from your app to Databus. If you don't, it will start with the default options; which might be good enough for many cases!
Structure of a dispatcher ticket can be seen in databus.dispatcher.abstract_dispatcher.DispatcherTicket .
Parameters that should be left empty for the default values in most cases:
- p_database_factory: Name of the database factory module
- p_driver_factory: Name of the driver factory module
- p_passenger_factory: Name of the passenger factory module
- p_queue_factory: Name of the queue factory module
- p_puller_factory: Name of the puller factory module
- p_processor_factory: Name of the processor factory module
- p_pusher_factory: Name of the pusher factory module
- p_driver_module: Name of the driver module
Parameters which are advised to be filled are:
- p_database_module: Database engine module to be used. The default engine is JSON DB; however, you can use any supplied or custom-developed database engine here.
- p_database_arguments: Arguments of the provided database module. JSON DB doesn't need any arguments, SQL Server needs some arguments, and your custom-developed database might need some arguments.
- p_dispatcher_observer: If you have implemented a custom observer class (explained above), you can pass your observer object here.
- p_run_web_server: Obvious
- p_web_server_port: Obvious
- p_external_config_files: If you have additional local JSON configuration files, you can pass their paths here so they become editable through the web interface.
- p_system_alias: This value is displayed on top of the web interface. Useful to distinguish test - live systems.
Inspect databus.dispatcher.abstract_dispatcher for further startup options which might have been missed in the documentation.
"Observer" is a useful design pattern; which also took a place within the dispatcher.
If your app needs to be aware of significant events within the dispatcher, you can write a custom class implementing databus.dispatcher.observer.DispatcherObserver, and pass the observer object to the dispatcher ticket (as explained below).
Check databus/dispatcher/observer.py for a list of events you can be listening to.