会话

会话接口

class gs_interactive.client.session.Session

DefaultSession 类

class gs_interactive.client.session.DefaultSession(admin_uri: str, stored_proc_uri: str | None = None)

Interactive SDK的默认会话实现。 它提供了所有服务API的实现。

__init__(admin_uri: str, stored_proc_uri: str | None = None)

使用指定的admin_uri和stored_proc_uri构建一个新的会话。

Parameters:

• admin_uri (str) – 管理服务的URI地址。

• stored_proc_uri (str, optional) – 存储过程服务的URI地址。 如果未提供，将从服务状态中读取该URI。

add_edge(graph_id: str[str], edge_request: List[EdgeRequest]) → 结果[str]

向指定图添加一条边。

add_vertex(graph_id: str[str], vertex_edge_request: VertexEdgeRequest) → 结果[str[str]]

向指定图添加一个顶点。

bulk_loading(graph_id: str[str], schema_mapping: SchemaMapping) → 结果[JobResponse]

向指定图提交批量加载任务。

call_procedure(graph_id: str[str], params: QueryRequest) → 结果[CollectiveResults]

在指定图中调用一个过程。

call_procedure_current(params: QueryRequest) → 结果[CollectiveResults]

在当前图中调用一个过程。

call_procedure_current_raw(params: bytes) → 结果[str]

在当前图中调用一个使用原始字节的过程。

call_procedure_raw(graph_id: str[str], params: bytes) → 结果[str]

在指定图中调用一个原始字节的过程。

cancel_job(job_id: str[str]) → 结果[str]

取消指定作业ID的任务。

create_graph(graph: CreateGraphRequest) → 结果[CreateGraphResponse]

使用指定的图请求创建一个新图。

create_procedure(graph_id: str[str], procedure: CreateProcedureRequest) → 结果[CreateProcedureResponse]

在指定图中创建一个新的存储过程。

delete_graph(graph_id: str[str]) → 结果[str]

删除指定ID的图。

delete_procedure(graph_id: str[str], procedure_id: str[str]) → 结果[str]

删除指定图中的存储过程。

ensure_param_str(param_name: str, param)

确保参数是字符串类型，否则抛出异常

get_edge(graph_id: str[str], edge_label: str[str], src_label: str[str], src_primary_key_value: Any[Any], dst_label: str[str], dst_primary_key_value: Any[Any]) → 结果[None | EdgeRequest]

从指定图中获取具有主键值的边。

get_graph_meta(graph_id: str[str]) → 结果[GetGraphResponse]

获取指定图表的元信息。

get_graph_schema(graph_id: str[str]) → 结果[GetGraphSchemaResponse]

获取指定图的结构模式。

Parameters:

graph_id (str) – 要获取其schema的图的ID。

Returns:

包含以下内容的结果

指定图的模式结构。

Return type:

Result[GetGraphSchemaResponse]

get_graph_statistics(graph_id: str[str]) → 结果[GetGraphStatisticsResponse]

获取指定图表的统计信息。

get_job(job_id: str[str]) → 结果[JobStatus]

获取指定作业ID的作业状态。

get_procedure(graph_id: str[str], procedure_id: str[str]) → 结果[GetProcedureResponse]

获取指定图中的存储过程。

get_service_status() → 结果[ServiceStatus]

获取服务的状态。

get_vertex(graph_id: str[str], label: str[str], primary_key_value: Any[Any]) → 结果[VertexData]

从指定图中根据主键值获取一个顶点。

list_graphs() → 结果[List[GetGraphResponse]]

列出所有图。

list_jobs() → 结果[List[JobResponse]]

列出所有作业。

list_procedures(graph_id: str[str]) → 结果[List[GetProcedureResponse]]

列出指定图中的所有存储过程。

restart_service() → 结果[str]

重启服务。

start_service(start_service_request: StartServiceRequest | None[StartServiceRequest | None] | None = None) → 结果[str]

在指定图上启动服务。

stop_service(graph_id: str | None = None) → 结果[str]

停止服务。

try_upload_files(schema_mapping: SchemaMapping) → 结果[SchemaMapping]

如果输入文件在schema_mapping中以@开头指定，请尝试上传这些输入文件。将上传文件的路径替换为服务器返回的路径。

可以在schema_mapping.loading_config中的data_source.location开头添加@符号，或者在vertex_mappings和edge_mappings中的每个文件前添加@符号。

1. location: @/path/to/dir

   inputs:

   • @/path/to/file1

   • @/path/to/file2

2. location: /path/to/dir

   inputs:

   • @/path/to/file1

   • @/path/to/file2

3. location: @/path/to/dir

   inputs:

   • /path/to/file1

   • /path/to/file2

4. location: /path/to/dir

   inputs:

   • /path/to/file1

   • /path/to/file2

4. location: None

   inputs:

   • @/path/to/file1

   • @/path/to/file2

在上述4种情况中，只有第1、3、5种情况是有效的，对于第2、4种情况文件将不会被上传

update_edge(graph_id: str[str], edge_request: EdgeRequest) → 结果[str]

更新指定图中的一条边。

update_procedure(graph_id: str[str], proc_id: str[str], procedure: UpdateProcedureRequest) → 结果[str]

在指定图中更新一个存储过程。

update_vertex(graph_id: str[str], vertex_request: VertexRequest) → 结果[str]

更新指定图中的顶点。

upload_and_replace_input_inplace(schema_mapping: SchemaMapping) → 结果[SchemaMapping]

对于schema_mapping中的每个输入文件，如果文件以@开头，则将该文件上传至服务器，并用服务器返回的路径替换原路径。

upload_file(filestorage: bytes[bytes] | str[str] | None) → 结果[UploadFileResponse]

上传文件到服务器。