Job Handles

class graphdatascience.procedure_surface.api.job_handle.JobHandle
__init__(arrow_client: AuthenticatedArrowClient, write_protocol: WriteProtocol | None, job_id: str, graph: Graph | str, show_progress: bool, endpoint: str)
Parameters:
cancel() → None
Return type:

None

done() → bool
Return type:

bool

job_id() → str
Return type:

str

mutate(*, mutate_property: str | None = None, mutate_relationship_type: str | None = None, mutate_property_overwrites: OrderedDict[str, str] | None = None, wait: bool = True, termination_flag: TerminationFlag | None = None) → dict[str, Any]
Parameters:
Return type:

dict[str, Any]

status() → JobStatus
Return type:

JobStatus

stream(*, wait: bool = True, termination_flag: TerminationFlag | None = None) → DataFrame
Parameters:
Return type:

DataFrame

summary(*, wait: bool = True, termination_flag: TerminationFlag | None = None) → dict[str, Any]
Parameters:
Return type:

dict[str, Any]

wait(*, termination_flag: TerminationFlag | None = None) → None
Parameters:

termination_flag (TerminationFlag | None)

Return type:

None

write(*, write_properties: str | dict[str, str] | None = None, write_relationship_types: str | None = None, concurrency: int | None = None) → WriteJobHandle
Parameters:

  • write_properties (str | dict[str, str] | None)

  • write_relationship_types (str | None)

  • concurrency (int | None)

Return type:

WriteJobHandle

class graphdatascience.procedure_surface.api.projection_job_handle.ProjectionJobHandle
__init__(arrow_client: AuthenticatedArrowClient, graph_name: str, job_id: str, termination_flag: TerminationFlag)
Parameters:
done() → bool
Return type:

bool

job_id() → str
Return type:

str

result(*, wait: bool = True) → Tuple[Graph, dict[str, Any]]
Parameters:

wait (bool)

Return type:

Tuple[Graph, dict[str, Any]]

status() → JobStatus
Return type:

JobStatus

wait(log_progress: bool = True) → None
Parameters:

log_progress (bool)

Return type:

None

class graphdatascience.procedure_surface.api.write_job_handle.WriteJobHandle
__init__(write_protocol: WriteProtocol, graph_name: str, job_id: str, started_at: float, termination_flag: TerminationFlag, log_progress: bool = True)
Parameters:
static create(write_protocol: WriteProtocol, graph_name: str, job_id: str, termination_flag: TerminationFlag, concurrency: int | None = None, property_overwrites: str | dict[str, str] | None = None, relationship_type_overwrite: str | None = None, log_progress: bool = True) → WriteJobHandle
Parameters:

  • write_protocol (WriteProtocol)

  • graph_name (str)

  • job_id (str)

  • termination_flag (TerminationFlag)

  • concurrency (int | None)

  • property_overwrites (str | dict[str, str] | None)

  • relationship_type_overwrite (str | None)

  • log_progress (bool)

Return type:

WriteJobHandle

done() → bool
Return type:

bool

job_id() → str
Return type:

str

result(*, wait: bool = True) → WriteBackResult
Parameters:

wait (bool)

Return type:

WriteBackResult

status() → JobStatus
Return type:

JobStatus

wait(log_progress: bool | None = None) → None
Parameters:

log_progress (bool | None)

Return type:

None

class graphdatascience.procedure_surface.api.write_job_handle.WriteBackResult
__init__(**data: Any) → None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Parameters:

data (Any)

Return type:

None

__new__(**kwargs)
class graphdatascience.procedure_surface.api.write_protocol.JobStatus

Protocol-agnostic snapshot of a write-back job’s state.

__init__(done: bool, status: str, progress: float, written_node_properties: int, written_node_labels: int, written_relationships: int) → None
Parameters:

  • done (bool)

  • status (str)

  • progress (float)

  • written_node_properties (int)

  • written_node_labels (int)

  • written_relationships (int)

Return type:

None

__new__(**kwargs)