DbmsConnectionInfo

class graphdatascience.session.dbms_connection_info.DbmsConnectionInfo

Represents the connection information for a Neo4j DBMS, such as an AuraDB instance. Supports both username/password as well as the authentication options provided by the Neo4j Python driver.

__init__(uri: str | None = None, username: str | None = None, password: str | None = None, database: str | None = None, auth: Auth | None = None, aura_instance_id: str | None = None, aura_database_id: str | None = None) → None
Parameters:

  • uri (str | None)

  • username (str | None)

  • password (str | None)

  • database (str | None)

  • auth (Auth | None)

  • aura_instance_id (str | None)

  • aura_database_id (str | None)

Return type:

None

static from_env() → DbmsConnectionInfo

Create a DbmsConnectionInfo instance from environment variables. The environment variables are: - NEO4J_URI - NEO4J_USERNAME - NEO4J_PASSWORD - NEO4J_DATABASE - AURA_INSTANCEID

Return type:

DbmsConnectionInfo

get_auth() → Auth | None
Returns:

A neo4j.Auth object for authentication.

Return type:

Auth | None