Neomodel documentation

An Object Graph Mapper (OGM) for the Neo4j graph database, built on the awesome neo4j_driver

• Familiar Django model style definitions.

• Powerful query API.

• Enforce your schema through cardinality restrictions.

• Full transaction support.

• Thread safe.

• Async support.

• pre/post save/delete hooks.

• Django integration via django_neomodel

Requirements

For releases 5.x :

• Python 3.7+

• neo4j 5.x, 4.4 (LTS)

For releases 4.x :

• Python 3.7 -> 3.10

• Neo4j 4.x (including 4.4 LTS for neomodel version 4.0.10)

Installation

Install from pypi (recommended):

$ pip install neomodel

To install from github:

$ pip install git+git://github.com/neo4j-contrib/neomodel.git@HEAD#egg=neomodel-dev

Note

Breaking changes in 5.3

Introducing support for asynchronous programming to neomodel required to introduce some breaking changes:

• config.AUTO_INSTALL_LABELS has been removed. Please use the neomodel_install_labels (neomodel_install_labels) command instead.

Deprecations in 5.3

• Some standalone methods are moved into the Database() class and will be removed in a future release :

  • change_neo4j_password

  • clear_neo4j_database

  • drop_constraints

  • drop_indexes

  • remove_all_labels

  • install_labels

  • install_all_labels

• Additionally, to call these methods with async, use the ones in the AsyncDatabase() _adb_ singleton.

Contents

• Getting started
  • Connecting
  • Querying the graph
  • Defining Node Entities and Relationships
  • Database Inspection - Requires APOC
  • Applying constraints and indexes
  • Remove existing constraints and indexes
  • Create, Update, Delete operations
  • Retrieving nodes
  • Relationships
  • Retrieving additional relations
  • Async neomodel
• Relationships
  • Cardinality
  • Properties
  • Relationship Uniqueness
  • Relationships and Inheritance
  • Explicit Traversal
• Property types
  • Naming Convention
  • Defaults
  • Mandatory / Optional Properties
  • Choices
  • Array Properties
  • Unique Identifiers
  • Dates and times
  • Other properties
  • Aliasing properties
  • Independent database property name
  • Reserved properties
  • Notes
• Spatial Properties
  • The Point
  • Points in Neo4j
  • Points in neomodel
  • NeomodelPoint in detail
  • PointProperty in detail
  • Examples
• Advanced queries
  • Node sets and filtering
  • Complex lookups with Q objects
  • Has a relationship
  • Iteration, slicing and more
  • Filtering by relationship properties
  • Ordering by property
  • Retrieving paths
  • Async neomodel - Caveats
• Cypher queries
  • Stand alone
  • Integrations
  • Logging
  • Utilities
• Transactions
  • Basic usage
  • Explicit Transactions
  • Bookmarks
  • Impersonation
• Hooks
  • Hooks on relationships
• Batch node operations
  • create()
  • create_or_update()
  • get_or_create()
• Configuration
  • Connection
  • neomodel-managed (default)
  • self-managed
  • Change/Close the connection
  • Protect your credentials
  • Enable automatic index and constraint creation
  • Require timezones on DateTimeProperty
• Extending neomodel
  • Inheritance
  • Optional Labels
  • Mixins
  • Overriding the StructuredNode constructor
  • Automatic class resolution
  • neomodel under multiple processes and threads
• General API
  • Properties
  • Exceptions
  • Scripts
• Sync API Documentation
  • Core
  • Relationships
  • Property Manager
  • Paths
  • Match
• Async API Documentation
  • Core
  • Relationships
  • Property Manager
  • Paths
  • Match

Indices and tables

• Index

• Module Index