langchain_community.graphs.neptune_graph.NeptuneGraph¶

class langchain_community.graphs.neptune_graph.NeptuneGraph(host: str, port: int = 8182, use_https: bool = True, client: Any = None, credentials_profile_name: Optional[str] = None, region_name: Optional[str] = None, service: str = 'neptunedata', sign: bool = True)[source]¶

Neptune wrapper for graph operations.

Parameters

  • host (str) – endpoint for the database instance

  • port (int) – port number for the database instance, default is 8182

  • use_https (bool) – whether to use secure connection, default is True

  • client (Any) – optional boto3 Neptune client

  • credentials_profile_name (Optional[str]) – optional AWS profile name

  • region_name (Optional[str]) – optional AWS region, e.g., us-west-2

  • service (str) – optional service name, default is neptunedata

  • sign (bool) – optional, whether to sign the request payload, default is True

Example
graph = NeptuneGraph(

host=’<my-cluster>’, port=8182

)

Security note: Make sure that the database connection uses credentials

that are narrowly-scoped to only include necessary permissions. Failure to do so may result in data corruption or loss, since the calling code may attempt commands that would result in deletion, mutation of data if appropriately prompted or reading sensitive data if such data is present in the database. The best way to guard against such negative outcomes is to (as appropriate) limit the permissions granted to the credentials used with this tool.

See https://python.langchain.com/docs/security for more information.

Create a new Neptune graph wrapper instance.

Attributes

get_schema

Returns the schema of the Neptune database

Methods

__init__(host[, port, use_https, client, ...])

Create a new Neptune graph wrapper instance.

query(query[, params])

Query Neptune database.
__init__(host: str, port: int = 8182, use_https: bool = True, client: Any = None, credentials_profile_name: Optional[str] = None, region_name: Optional[str] = None, service: str = 'neptunedata', sign: bool = True) → None[source]¶

Create a new Neptune graph wrapper instance.

Parameters

  • host (str) –

  • port (int) –

  • use_https (bool) –

  • client (Any) –

  • credentials_profile_name (Optional[str]) –

  • region_name (Optional[str]) –

  • service (str) –

  • sign (bool) –

Return type

None

query(query: str, params: dict = {}) → Dict[str, Any][source]¶

Query Neptune database.

Parameters

  • query (str) –

  • params (dict) –

Return type

Dict[str, Any]

Examples using NeptuneGraph¶