gigl.src.subgraph_sampler.lib.ingestion_protocol

Classes

BaseIngestion

Users should implement this protocol for their ingestion into GraphDB.

Module Contents

class gigl.src.subgraph_sampler.lib.ingestion_protocol.BaseIngestion

Bases: Protocol

Users should implement this protocol for their ingestion into GraphDB.

clean_up()

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.

Return type:

None

ingest(gbml_config_pb_wrapper, resource_config_uri, applied_task_identifier, custom_worker_image_uri=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.

Parameters:

• gbml_config_pb_wrapper (gigl.src.common.types.pb_wrappers.gbml_config.GbmlConfigPbWrapper)

• resource_config_uri (gigl.common.Uri)

• applied_task_identifier (gigl.src.common.types.AppliedTaskIdentifier)

• custom_worker_image_uri (Optional[str])

Return type:

None