gigl.src.subgraph_sampler.lib.BaseIngestion

class gigl.src.subgraph_sampler.lib.ingestion_protocol.BaseIngestion(*args, **kwargs)

Bases: Protocol

Users should implement this protocol for their ingestion into GraphDB.

Methods

__init__
clean_up	This function runs after the ingestion process.
ingest	This function runs the ingestion process.

__init__(*args, **kwargs)

classmethod __init_subclass__(*args, **kwargs)

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__subclasshook__()

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

__weakref__

list of weak references to the object (if defined)

clean_up() → None

This function runs after the ingestion process. It can be used to perform any operation needed such as closing connections, cleaning up temporary files, etc.

ingest(gbml_config_pb_wrapper: GbmlConfigPbWrapper, resource_config_uri: Uri, applied_task_identifier: AppliedTaskIdentifier, custom_worker_image_uri: str | None = None) → None

This function runs the ingestion process. Should perform the operations needed to ingest all data into GraphDB in preperation for running subgraph sampler queries.