Home Reference Source

Typedef

Static Public Summary
public	BookmarkManagerConfig: Object	since 5.0
public	KeyFileObject: object Represents KeyFile represented as file.
public	NotificationCategory: 'HINT' \| 'UNRECOGNIZED' \| 'UNSUPPORTED' \| 'PERFORMANCE' \| 'TOPOLOGY' \| 'SECURITY' \| 'DEPRECATION' \| 'GENERIC' \| 'UNKNOWN'
public	NotificationFilterDisabledCategory: 'HINT' \| 'UNRECOGNIZED' \| 'UNSUPPORTED' \| 'PERFORMANCE' \| 'TOPOLOGY' \| 'SECURITY' \| 'DEPRECATION' \| 'GENERIC'
public	NotificationFilterMinimumSeverityLevel: 'WARNING' \| 'INFORMATION' \| 'OFF'
public	NotificationSeverityLevel: 'WARNING' \| 'INFORMATION' \| 'UNKNOWN'
public	ResultTransformer: function<T>(result:Result):Promise<T> Protocol for transforming Result.
public	RoutingControl: 'WRITE' \| 'READ'
public	TransactionConfig: Object Configuration object containing settings for explicit and auto-commit transactions.

Static Public

public BookmarkManagerConfig: Object since 5.0 source

Properties:

Name	Type	Attribute	Description
initialBookmarks	Iterable<string>	optional	Defines the initial set of bookmarks. The key is the database name and the values are the bookmarks.
bookmarksSupplier	function(): Promise<Iterable<string>>	optional	Called for supplying extra bookmarks to the BookmarkManager
bookmarksConsumer	function(bookmarks: Iterable<string>): Promise<void>	optional	Called when the set of bookmarks get updated

public KeyFileObject: object source

Represents KeyFile represented as file.

Properties:

Name	Type	Attribute	Description
path	string		The path of the file
password	string \| undefined		the password of the key. If none, the password defined at ClientCertificate will be used.

public NotificationCategory: 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' | 'UNKNOWN' source

public NotificationFilterDisabledCategory: 'HINT' | 'UNRECOGNIZED' | 'UNSUPPORTED' | 'PERFORMANCE' | 'TOPOLOGY' | 'SECURITY' | 'DEPRECATION' | 'GENERIC' source

public NotificationFilterMinimumSeverityLevel: 'WARNING' | 'INFORMATION' | 'OFF' source

public NotificationSeverityLevel: 'WARNING' | 'INFORMATION' | 'UNKNOWN' source

public ResultTransformer: function<T>(result:Result):Promise<T> source

Protocol for transforming Result.

See:

resultTransformers for provided implementations.
Driver#executeQuery for usage.

public RoutingControl: 'WRITE' | 'READ' source

public TransactionConfig: Object source

Configuration object containing settings for explicit and auto-commit transactions.

Configuration is supported for:

queries executed in auto-commit transactions using Session#run and RxSession#run
transactions started by transaction functions using Session#readTransaction, RxSession#readTransaction, Session#writeTransaction and RxSession#writeTransaction
explicit transactions using Session#beginTransaction and RxSession#beginTransaction

Properties:

Name	Type	Attribute	Description
timeout	number		the transaction timeout in milliseconds. Transactions that execute longer than the configured timeout will be terminated by the database. This functionality allows user code to limit query/transaction execution time. The specified timeout overrides the default timeout configured in the database using the `db.transaction.timeout` setting (`dbms.transaction.timeout` before Neo4j 5.0). Values higher than `db.transaction.timeout` will be ignored and will fall back to the default for server versions between 4.2 and 5.2 (inclusive). The value should not represent a negative duration. A timeout of `0` will make the transaction execute indefinitely. `null` (default) will use the default timeout configured on the server.
metadata	Object		the transaction metadata. Specified metadata will be attached to the executing transaction and visible in the output of `SHOW TRANSACTIONS YIELD *`. It will also get logged to the `query.log` file. This functionality makes it easier to tag transactions and is equivalent to the `dbms.setTXMetaData` procedure, see https://neo4j.com/docs/cypher-manual/current/clauses/transaction-clauses/#query-listing-transactions and https://neo4j.com/docs/operations-manual/current/reference/procedures/ for reference.