@auth/neo4j-adapter

Auth.js / NextAuth.js 用の公式 Neo4j アダプター。

インストール

npm install @auth/neo4j-adapter neo4j-driver

pnpm add @auth/neo4j-adapter neo4j-driver

yarn add @auth/neo4j-adapter neo4j-driver

bun add @auth/neo4j-adapter neo4j-driver

Neo4jOptions

これは Neo4j アダプターのオプションのインターフェースです。Neo4j アダプターは、Neo4j セッション を唯一の引数として受け取ります。

拡張

• Session

メソッド

_acquireConnection()

private _acquireConnection<T>(connectionConsumer): Promise<T>

このメソッドは、neo4j-driver-bolt-protocol パッケージの Rediscovery によって使用されます。

型パラメーター

パラメーター

戻り値

Promise<T>

接続プロミス

継承元

Session._acquireConnection

_assertSessionIsOpen()

private _assertSessionIsOpen(): void

戻り値

void

継承元

Session._assertSessionIsOpen

_beginTransaction()

_beginTransaction(
   accessMode, 
   txConfig, 
   apiTelemetryConfig?): TransactionPromise

パラメーター

戻り値

TransactionPromise

継承元

Session._beginTransaction

_connectionHolderWithMode()

_connectionHolderWithMode(mode): ConnectionHolder

パラメーター

戻り値

ConnectionHolder

継承元

Session._connectionHolderWithMode

_onCompleteCallback()

private _onCompleteCallback(meta, previousBookmarks?): void

パラメーター

戻り値

void

継承元

Session._onCompleteCallback

_onDatabaseNameResolved()

private _onDatabaseNameResolved(database?): void

セッションコンテキストで解決されたデータベース名を設定します。

パラメーター

戻り値

void

継承元

Session._onDatabaseNameResolved

_run()

_run<T>(
   query, 
   parameters, 
customRunner): Result<RecordShape>

型パラメーター

パラメーター

戻り値

Result<RecordShape>

継承元

Session._run

_runTransaction()

_runTransaction<T>(
   accessMode, 
   transactionConfig, 
transactionWork): Promise<T>

型パラメーター

パラメーター

戻り値

Promise<T>

継承元

Session._runTransaction

_transactionClosed()

private _transactionClosed(): void

戻り値

void

継承元

Session._transactionClosed

_updateBookmarks()

private _updateBookmarks(
   newBookmarks?, 
   previousBookmarks?, 
   database?): void

最後のブックマークの値を更新します。

パラメーター

戻り値

void

継承元

Session._updateBookmarks

beginTransaction()

beginTransaction(transactionConfig?): TransactionPromise

このセッションで新しいトランザクションを開始します。セッションで同時に実行できるトランザクションは最大1つです。複数の同時トランザクションを実行したい場合は、複数の同時セッションを使用する必要があります。

トランザクションが開いている間、セッションはトランザクション外でクエリを実行するために使用できません。

パラメータ

戻り値

TransactionPromise

新しいトランザクション。

継承元

Session.beginTransaction

close()

close(): Promise<void>

このセッションを閉じます。

戻り値

Promise<void>

継承元

Session.close

executeRead()

executeRead<T>(transactionWork, transactionConfig?): Promise<T>

READトランザクションで指定された作業単位を実行します。

指定された関数が例外をスローするか、リジェクトされたPromiseを返さない限り、トランザクションは自動的にコミットされます。指定された関数の失敗またはコミット自体の失敗の一部は、1秒の初期遅延と最大30秒の再試行時間で指数バックオフを使用して再試行されます。最大再試行時間は、ドライバー構成のmaxTransactionRetryTimeプロパティ（ミリ秒単位）で構成できます。

型パラメータ

パラメータ

戻り値

Promise<T>

指定された関数によって返された解決済みPromise、または指定された関数またはコミットが失敗した場合はリジェクトされたPromise。

継承元

Session.executeRead

executeWrite()

executeWrite<T>(transactionWork, transactionConfig?): Promise<T>

WRITEトランザクションで指定された作業単位を実行します。

指定された関数が例外をスローするか、リジェクトされたPromiseを返さない限り、トランザクションは自動的にコミットされます。指定された関数の失敗またはコミット自体の失敗の一部は、1秒の初期遅延と最大30秒の再試行時間で指数バックオフを使用して再試行されます。最大再試行時間は、ドライバー構成のmaxTransactionRetryTimeプロパティ（ミリ秒単位）で構成できます。

型パラメータ

パラメータ

戻り値

Promise<T>

指定された関数によって返された解決済みPromise、または指定された関数またはコミットが失敗した場合はリジェクトされたPromise。

継承元

Session.executeWrite

lastBookmark()

lastBookmark(): string[]

最後に完了したトランザクションに続いて受信したブックマークを返します。

戻り値

string[]

以前のトランザクションへの参照。

継承元

Session.lastBookmark

非推奨

このメソッドはバージョン6.0で削除されます。代わりにSession#lastBookmarksを使用してください。

参照

Session#lastBookmarks

lastBookmarks()

lastBookmarks(): string[]

最後に完了したトランザクションに続いて受信したブックマークを返します。

戻り値

string[]

以前のトランザクションへの参照。

継承元

Session.lastBookmarks

readTransaction()

readTransaction<T>(transactionWork, transactionConfig?): Promise<T>

READトランザクションで指定された作業単位を実行します。

指定された関数が例外をスローするか、リジェクトされたPromiseを返さない限り、トランザクションは自動的にコミットされます。指定された関数の失敗またはコミット自体の失敗の一部は、1秒の初期遅延と最大30秒の再試行時間で指数バックオフを使用して再試行されます。最大再試行時間は、ドライバー構成のmaxTransactionRetryTimeプロパティ（ミリ秒単位）で構成できます。

型パラメータ

パラメータ

戻り値

Promise<T>

指定された関数によって返された解決済みPromise、または指定された関数またはコミットが失敗した場合はリジェクトされたPromise。

継承元

Session.readTransaction

非推奨

このメソッドはバージョン6.0で削除されます。代わりにSession#executeReadを使用してください。

参照

Session#executeRead

run()

run<R>(
   query, 
   parameters?, 
transactionConfig?): Result<R>

Cypherクエリを実行します。クエリオブジェクト（例：{text: "MATCH ...", parameters: {param: 1}}）またはクエリとパラメータを別々の引数として呼び出すことができます。

型パラメータ

パラメータ

戻り値

Result<R>

新しい結果。

継承元

Session.run

writeTransaction()

writeTransaction<T>(transactionWork, transactionConfig?): Promise<T>

WRITEトランザクションで指定された作業単位を実行します。

指定された関数が例外をスローするか、リジェクトされたPromiseを返さない限り、トランザクションは自動的にコミットされます。指定された関数の失敗またはコミット自体の失敗の一部は、1秒の初期遅延と最大30秒の再試行時間で指数バックオフを使用して再試行されます。最大再試行時間は、ドライバー構成のmaxTransactionRetryTimeプロパティ（ミリ秒単位）で構成できます。

型パラメータ

パラメータ

戻り値

Promise<T>

指定された関数によって返された解決済みPromise、または指定された関数またはコミットが失敗した場合はリジェクトされたPromise。

継承元

Session.writeTransaction

非推奨

このメソッドはバージョン6.0で削除されます。代わりにSession#executeWriteを使用してください。

参照

Session#executeWrite

format

const format: {
  from: null | T;
  to: Record<string, unknown>;
};

型宣言

from()

Neo4jオブジェクトを受け取り、プレーンなJavaScriptオブジェクトを返します

型パラメータ

パラメータ

戻り値

null | T

to()

プレーンなJavaScriptオブジェクトを受け取り、Neo4j互換のオブジェクトに変換します

パラメータ

戻り値

Record<string, unknown>

Neo4jAdapter()

Neo4jAdapter(session): Adapter

パラメータ

戻り値

Adapter