Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Introduce driver level Hydration and Dehydration hooks #1157

Draft
wants to merge 2 commits into
base: 5.0
Choose a base branch
from

Conversation

bigmontz
Copy link
Contributor

@bigmontz bigmontz commented Nov 1, 2023

This hooks enable driver users to globaly map their own data types to Neo4j driver types and vice-versa.

Example:

import neo4j, { DateTime } from 'neo4j-driver'

const driver = neo4j.driver('neo4j://localhost:7687', neo4j.auth.basic('neo4j', 'password'), {
    // converting types came from the Datebase
    hydrationHooks: {
        // converting neo4j.DateTime to ISO String, 
        // but you might also convert to some library
        DateTime: (datetime) => datetime.toString()
    },
    // Converting type which user supplied to neo4j types
    dehydrationHooks: [
        // Define a dehydration hook from javascript Date
        {
            // Checking if the type is instance of Date
            isTypeInstance: maybeStdDate => maybeStdDate instanceof Date,
            // Called when a types is Date and need to converted/dehydrated
            dehydrate: stdDate => DateTime.fromStandardDate(stdDate)
        }
    ]
})

const { records: [record]  } = await driver.executeQuery("RETURN $now AS now", { now: new Date()})
console.log(`Now is ${record.get('now')}`)

await driver.close()

The driver is able to hydrate Duration, LocalTime, LocalDateTime, Time, Date, DateTime and Point. Other types will not able to be hydrated since they are used by driver internals and the hydration step occurs while data is being received from the socket.

Dehydration, in other hand, can be done from any data type since it got converted to types which driver can understand.

This hooks enable driver users to globaly map their own data types to
Neo4j driver types and vice-versa.
@bigmontz bigmontz closed this Nov 2, 2023
@bigmontz bigmontz force-pushed the 5.x-hydration-hooks branch from a889c03 to e191168 Compare November 2, 2023 12:50
@bigmontz bigmontz reopened this Nov 2, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant