| Name | Type | Description |
|---|---|---|
url | Optional[str] | Default: NoneThe URL of the Neo4j database server. |
username | Optional[str] | Default: NoneThe username for database authentication. |
password | Optional[str] | Default: None |
token | Optional[str] | Default: None |
database | Optional[str] | Default: None |
timeout | Optional[float] | Default: None |
sanitize | bool | Default: False |
refresh_schema | bool | Default: True |
driver_config | Optional[Dict] | Default: None |
enhanced_schema | bool | Default: False |
Neo4j database wrapper for various graph operations.
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://docs.langchain.com/oss/python/security-policy for more information.
The password for database authentication.
The authentication token for database authentication.
The name of the database to connect to. Default is 'neo4j'.
The timeout for transactions in seconds. Useful for terminating long-running queries.
By default, there is no timeout set.
A flag to indicate whether to remove lists with more than 128 elements from results. Useful for removing embedding-like properties from database responses.
A flag whether to refresh schema information at initialization.
Configuration passed to Neo4j Driver.
A flag whether to scan the database for example values and use them in the graph schema.
