GDS 会话¶
- class graphdatascience.session.gds_sessions.GdsSessions¶
用于管理 Neo4j Aura 中托管的 GDS 会话的主要 API 类。
- __init__(api_credentials: AuraAPICredentials) None¶
初始化 GdsSessions 类的新实例。
- 参数:
api_credentials (AuraAPICredentials) – 用于建立连接的 Aura API 凭据。
- available_cloud_locations() list[CloudLocation]¶
检索 Aura 中可用云位置的列表。
- 返回:
可用云位置的列表。
- 返回类型:
Set[CloudLocation]
- delete(*, session_name: str | None = None, session_id: str | None = None) bool¶
通过名称或 ID 删除 GDS 会话。参数 session_name: 要删除的会话名称 参数 session_id: 要删除的会话 ID
- 返回:
如果因本次调用而删除了会话，则返回 True。
- estimate(node_count: int, relationship_count: int, algorithm_categories: list[AlgorithmCategory] | None = None) SessionMemory¶
估算具有给定节点和关系计数的会话所需的内存。
- 参数:
node_count (int) – 节点数量。
relationship_count (int) – 关系数量。
algorithm_categories (Optional[list[AlgorithmCategory]]) – 要考虑的算法类别。
- 返回:
会话所需的估算内存。
- 返回类型:
- get_or_create(session_name: str, memory: SessionMemory, db_connection: DbmsConnectionInfo | None = None, ttl: timedelta | None = None, cloud_location: CloudLocation | None = None, timeout: int | None = None) AuraGraphDataScience¶
使用给定的会话名称和数据库连接检索现有会话，如果不存在则创建新会话。
如果会话即将过期，将发出警告。如果会话失败，将引发异常。
- 参数:
session_name (str) – 会话的名称。
memory (SessionMemory) – 由内存指定的会话大小。
db_connection (Optional[DbmsConnectionInfo]) – 数据库连接信息。
ttl – (Optional[timedelta]): 会话在不活动状态下的存活时间（秒）。
cloud_location (Optional[CloudLocation]) – 云位置。如果 GDS 会话用于自管理数据库，则为必需项。
timeout (Optional[int]) – 等待会话准备就绪时的可选超时时间（秒）。如果未设置，该方法将永远等待。如果已设置但会话未准备就绪，则将引发异常。在这种情况下，用户有责任确保资源得到清理。
- 返回:
会话。
- 返回类型:
AuraGraphDataScience
- list() list[SessionInfo]¶
检索与给定 API 凭据关联的用户可见的 GDS 会话列表。
- 返回:
表示 GDS 会话的 SessionInfo 对象列表。
- class graphdatascience.session.gds_sessions.AuraAPICredentials¶
表示访问 Aura API 所需的凭据。
- client_id¶
用于身份验证的客户端 ID。
- 类型:
str
- client_secret¶
用于身份验证的客户端密钥。
- 类型:
str
- project_id¶
用于身份验证的项目 ID。如果客户端属于多个项目，则需要。
- 类型:
Optional[str]
- __init__(client_id: str, client_secret: str, project_id: str | None = None) None¶
- class graphdatascience.session.gds_sessions.SessionInfo¶
表示会话信息。
- id¶
会话 ID。
- 类型:
str
- name¶
会话名称。
- 类型:
str
- memory¶
会话大小。
- 类型:
str
- instance_id¶
会话所附加的 AuraDB 实例 ID。
- 类型:
Optional[str]
- status¶
会话状态。
- 类型:
str
- expiry_date¶
会话过期日期。
- 类型:
Optional[datetime]
- created_at¶
会话创建日期。
- 类型:
datetime
- user_id¶
创建会话的 Aura 控制台用户 ID。
- 类型:
str
- cloud_location¶
会话所在的提供商和区域。
- 类型:
Optional[CloudLocation]
- ttl¶
会话在未使用时将被删除的时间。TTL 在每次活动时都会更新。向下舍入到最近的分钟。
- 类型:
Optional[timedelta]
- errors¶
与会话相关的错误列表。
- 类型:
list[SessionError]
- __init__(id: str, name: str, memory: SessionMemoryValue, instance_id: str | None, status: str, expiry_date: datetime | None, created_at: datetime, user_id: str, cloud_location: CloudLocation | None, ttl: timedelta | None = None, errors: list[SessionErrorData] | None = None) None¶