Tree

• API Documentation
  • GraphDatabase
    • Driver Construction
      • GraphDatabase
        • GraphDatabase.driver()
        • GraphDatabase.bookmark_manager()
    • URI
    • Auth
      • Auth
      • AuthManager
        • AuthManager.get_auth()
        • AuthManager.handle_security_exception()
      • AuthManagers
        • AuthManagers.static()
        • AuthManagers.basic()
        • AuthManagers.bearer()
      • ExpiringAuth
        • ExpiringAuth.auth
        • ExpiringAuth.expires_at
        • ExpiringAuth.expires_in()
      • Auth Token Helper Functions
        • basic_auth()
        • kerberos_auth()
        • bearer_auth()
        • custom_auth()
  • Driver
    • Driver
      • Driver.execute_query()
      • Driver.encrypted
      • Driver.session()
      • Driver.close()
      • Driver.execute_query_bookmark_manager
      • Driver.verify_connectivity()
      • Driver.get_server_info()
      • Driver.supports_multi_db()
      • Driver.verify_authentication()
      • Driver.supports_session_auth()
    • Driver Configuration
      • connection_acquisition_timeout
      • connection_timeout
      • connection_write_timeout
      • encrypted
      • keep_alive
      • max_connection_lifetime
      • liveness_check_timeout
      • max_connection_pool_size
      • max_transaction_retry_time
      • resolver
      • ssl_context
      • trusted_certificates
        • TrustSystemCAs
        • TrustAll
        • TrustCustomCAs
      • client_certificate
        • ClientCertificate
          • ClientCertificate.certfile
          • ClientCertificate.keyfile
          • ClientCertificate.password
        • ClientCertificateProvider
          • ClientCertificateProvider.get_certificate()
        • ClientCertificateProviders
          • ClientCertificateProviders.static()
          • ClientCertificateProviders.rotating()
        • RotatingClientCertificateProvider
          • RotatingClientCertificateProvider.update_certificate()
      • user_agent
      • notifications_min_severity
      • notifications_disabled_categories
      • notifications_disabled_classifications
      • warn_notification_severity
      • telemetry_disabled
      • Note on Encryption Configuration
    • Driver Object Lifetime
    • BoltDriver
      • BoltDriver
    • Neo4jDriver
      • Neo4jDriver
  • Sessions & Transactions
  • Session Construction
  • Session
    • Session
      • Session.close()
      • Session.closed()
      • Session.run()
      • Session.last_bookmarks()
      • Session.begin_transaction()
      • Session.execute_read()
      • Session.execute_write()
    • Query
      • Query
    • Session Configuration
      • bookmarks
      • database
      • impersonated_user
      • default_access_mode
      • fetch_size
      • bookmark_manager
      • auth
      • notifications_min_severity
      • notifications_disabled_categories
      • notifications_disabled_classifications
  • Transaction
    • Auto-commit Transactions
    • Explicit Transactions (Unmanaged Transactions)
      • Transaction
        • Transaction.run()
        • Transaction.commit()
        • Transaction.rollback()
        • Transaction.close()
        • Transaction.closed()
    • Managed Transactions (transaction functions)
      • ManagedTransaction
        • ManagedTransaction.run()
      • unit_of_work()
  • Result
    • Result
      • Result.__iter__()
      • Result.__next__()
      • Result.keys()
      • Result.consume()
      • Result.single()
      • Result.fetch()
      • Result.peek()
      • Result.graph()
      • Result.value()
      • Result.values()
      • Result.data()
      • Result.to_df()
      • Result.to_eager_result()
      • Result.closed()
    • EagerResult
      • EagerResult.records
      • EagerResult.summary
      • EagerResult.keys
    • Graph
      • Graph.nodes
      • Graph.relationships
      • Graph.relationship_type()
    • Record
      • Record.keys()
      • Record.get()
      • Record.index()
      • Record.items()
      • Record.value()
      • Record.values()
      • Record.data()
  • ResultSummary
    • ResultSummary
      • ResultSummary.server
      • ResultSummary.database
      • ResultSummary.query
      • ResultSummary.parameters
      • ResultSummary.query_type
      • ResultSummary.plan
      • ResultSummary.profile
      • ResultSummary.counters
      • ResultSummary.result_available_after
      • ResultSummary.result_consumed_after
      • ResultSummary.notifications
      • ResultSummary.summary_notifications
      • ResultSummary.gql_status_objects
    • SummaryCounters
      • SummaryCounters
        • SummaryCounters.nodes_created
        • SummaryCounters.nodes_deleted
        • SummaryCounters.relationships_created
        • SummaryCounters.relationships_deleted
        • SummaryCounters.properties_set
        • SummaryCounters.labels_added
        • SummaryCounters.labels_removed
        • SummaryCounters.indexes_added
        • SummaryCounters.indexes_removed
        • SummaryCounters.constraints_added
        • SummaryCounters.constraints_removed
        • SummaryCounters.system_updates
        • SummaryCounters.contains_updates
        • SummaryCounters.contains_system_updates
    • ServerInfo
      • ServerInfo
        • ServerInfo.address
        • ServerInfo.protocol_version
        • ServerInfo.agent
        • ServerInfo.update()
    • GqlStatusObject
      • GqlStatusObject
        • GqlStatusObject.is_notification
        • GqlStatusObject.gql_status
        • GqlStatusObject.status_description
        • GqlStatusObject.position
        • GqlStatusObject.raw_classification
        • GqlStatusObject.classification
        • GqlStatusObject.raw_severity
        • GqlStatusObject.severity
        • GqlStatusObject.diagnostic_record
      • NotificationClassification
        • NotificationClassification
          • NotificationClassification.HINT
          • NotificationClassification.UNRECOGNIZED
          • NotificationClassification.UNSUPPORTED
          • NotificationClassification.PERFORMANCE
          • NotificationClassification.DEPRECATION
          • NotificationClassification.GENERIC
          • NotificationClassification.SECURITY
          • NotificationClassification.TOPOLOGY
          • NotificationClassification.SCHEMA
          • NotificationClassification.UNKNOWN
    • SummaryNotification
      • SummaryNotification
        • SummaryNotification.title
        • SummaryNotification.code
        • SummaryNotification.description
        • SummaryNotification.severity_level
        • SummaryNotification.category
        • SummaryNotification.raw_severity_level
        • SummaryNotification.raw_category
        • SummaryNotification.position
      • NotificationSeverity
        • NotificationSeverity
          • NotificationSeverity.WARNING
          • NotificationSeverity.INFORMATION
          • NotificationSeverity.UNKNOWN
      • NotificationCategory
        • NotificationCategory
          • NotificationCategory.HINT
          • NotificationCategory.UNRECOGNIZED
          • NotificationCategory.UNSUPPORTED
          • NotificationCategory.PERFORMANCE
          • NotificationCategory.DEPRECATION
          • NotificationCategory.GENERIC
          • NotificationCategory.SECURITY
          • NotificationCategory.TOPOLOGY
          • NotificationCategory.SCHEMA
          • NotificationCategory.UNKNOWN
      • SummaryInputPosition
        • SummaryInputPosition
          • SummaryInputPosition.line
          • SummaryInputPosition.column
          • SummaryInputPosition.offset
      • SummaryNotificationPosition
        • neo4j.SummaryNotificationPosition
  • Data Types
    • Core Data Types
    • Extended Data Types
    • Graph Data Types
      • Node
        • Node
          • Node.graph
          • Node.id
          • Node.element_id
          • Node.labels
          • Node.get()
          • Node.keys()
          • Node.values()
          • Node.items()
      • Relationship
        • Relationship
          • Relationship.graph
          • Relationship.id
          • Relationship.element_id
          • Relationship.nodes
          • Relationship.start_node
          • Relationship.end_node
          • Relationship.type
          • Relationship.get()
          • Relationship.keys()
          • Relationship.values()
          • Relationship.items()
      • Path
        • Path
          • Path.graph
          • Path.nodes
          • Path.start_node
          • Path.end_node
          • Path.relationships
    • Spatial Data Types
    • Temporal Data Types
  • Bookmarks
    • Bookmarks
      • Bookmarks
        • Bookmarks.__bool__()
        • Bookmarks.__add__()
        • Bookmarks.raw_values
        • Bookmarks.from_raw_values()
    • BookmarkManager
      • BookmarkManager
        • BookmarkManager.update_bookmarks()
        • BookmarkManager.get_bookmarks()
  • Constants, Enums, Helpers
    • NotificationMinimumSeverity
      • NotificationMinimumSeverity.OFF
      • NotificationMinimumSeverity.WARNING
      • NotificationMinimumSeverity.INFORMATION
    • NotificationDisabledCategory
      • NotificationDisabledCategory.HINT
      • NotificationDisabledCategory.UNRECOGNIZED
      • NotificationDisabledCategory.UNSUPPORTED
      • NotificationDisabledCategory.PERFORMANCE
      • NotificationDisabledCategory.DEPRECATION
      • NotificationDisabledCategory.GENERIC
      • NotificationDisabledCategory.SECURITY
      • NotificationDisabledCategory.TOPOLOGY
      • NotificationDisabledCategory.SCHEMA
    • NotificationDisabledClassification
      • NotificationDisabledClassification.HINT
      • NotificationDisabledClassification.UNRECOGNIZED
      • NotificationDisabledClassification.UNSUPPORTED
      • NotificationDisabledClassification.PERFORMANCE
      • NotificationDisabledClassification.DEPRECATION
      • NotificationDisabledClassification.GENERIC
      • NotificationDisabledClassification.SECURITY
      • NotificationDisabledClassification.TOPOLOGY
      • NotificationDisabledClassification.SCHEMA
    • RoutingControl
      • RoutingControl.READ
      • RoutingControl.WRITE
    • Address
      • Address.family
      • Address.from_socket()
      • Address.parse()
      • Address.parse_list()
      • Address.host
      • Address.port
      • Address.port_number
    • IPv4Address
    • IPv6Address
  • Errors
    • GQL Errors
      • GqlError
        • GqlError.__cause__
        • GqlError.gql_status
        • GqlError.message
        • GqlError.gql_status_description
        • GqlError.gql_raw_classification
        • GqlError.gql_classification
        • GqlError.diagnostic_record
        • GqlError.find_by_gql_status()
      • GqlErrorClassification
        • GqlErrorClassification.CLIENT_ERROR
        • GqlErrorClassification.DATABASE_ERROR
        • GqlErrorClassification.TRANSIENT_ERROR
        • GqlErrorClassification.UNKNOWN
    • Neo4j Errors
      • Neo4jError
        • Neo4jError.message
        • Neo4jError.code
        • Neo4jError.is_retryable()
      • ClientError
      • CypherSyntaxError
      • CypherTypeError
      • ConstraintError
      • AuthError
      • TokenExpired
      • Forbidden
      • DatabaseError
      • TransientError
      • DatabaseUnavailable
      • NotALeader
      • ForbiddenOnReadOnlyDatabase
    • Driver Errors
      • DriverError
        • DriverError.is_retryable()
      • SessionError
        • SessionError.session
      • TransactionError
        • TransactionError.transaction
      • TransactionNestingError
      • ResultError
        • ResultError.result
      • ResultFailedError
      • ResultConsumedError
      • ResultNotSingleError
      • BrokenRecordError
      • SessionExpired
      • ServiceUnavailable
      • RoutingServiceUnavailable
      • WriteServiceUnavailable
      • ReadServiceUnavailable
      • IncompleteCommit
      • ConfigurationError
      • AuthConfigurationError
      • CertificateConfigurationError
      • UnsupportedServerProduct
    • Internal Driver Errors
  • Warnings
    • Warning Classes
      • PreviewWarning
      • Neo4jWarning
        • Neo4jWarning.notification
      • Neo4jDeprecationWarning
    • Filtering Warnings
  • Logging
    • Simple Approach
      • watch()
    • Context Manager
      • Watcher
        • Watcher.__enter__()
        • Watcher.__exit__()
        • Watcher.watch()
        • Watcher.stop()
    • Full Control
• Async API Documentation
  • AsyncGraphDatabase
    • Async Driver Construction
      • AsyncGraphDatabase
        • AsyncGraphDatabase.driver()
        • AsyncGraphDatabase.bookmark_manager()
    • URI
    • Async Auth
      • AsyncAuthManager
        • AsyncAuthManager.get_auth()
        • AsyncAuthManager.handle_security_exception()
      • AsyncAuthManagers
        • AsyncAuthManagers.static()
        • AsyncAuthManagers.basic()
        • AsyncAuthManagers.bearer()
  • AsyncDriver
    • AsyncDriver
      • AsyncDriver.execute_query()
      • AsyncDriver.encrypted
      • AsyncDriver.session()
      • AsyncDriver.close()
      • AsyncDriver.execute_query_bookmark_manager
      • AsyncDriver.verify_connectivity()
      • AsyncDriver.get_server_info()
      • AsyncDriver.supports_multi_db()
      • AsyncDriver.verify_authentication()
      • AsyncDriver.supports_session_auth()
    • Async Driver Configuration
      • resolver
      • client_certificate
        • AsyncClientCertificateProvider
          • AsyncClientCertificateProvider.get_certificate()
        • AsyncClientCertificateProviders
          • AsyncClientCertificateProviders.static()
          • AsyncClientCertificateProviders.rotating()
        • AsyncRotatingClientCertificateProvider
          • AsyncRotatingClientCertificateProvider.update_certificate()
    • Driver Object Lifetime
    • AsyncBoltDriver
      • AsyncBoltDriver
    • AsyncNeo4jDriver
      • AsyncNeo4jDriver
  • AsyncSessions & AsyncTransactions
  • AsyncSession Construction
  • AsyncSession
    • AsyncSession
      • AsyncSession.close()
      • AsyncSession.cancel()
      • AsyncSession.closed()
      • AsyncSession.run()
      • AsyncSession.last_bookmarks()
      • AsyncSession.begin_transaction()
      • AsyncSession.execute_read()
      • AsyncSession.execute_write()
    • Session Configuration
      • bookmark_manager
  • AsyncTransaction
    • Auto-commit Transactions
    • Explicit Transactions (Unmanaged Transactions)
      • AsyncTransaction
        • AsyncTransaction.run()
        • AsyncTransaction.commit()
        • AsyncTransaction.rollback()
        • AsyncTransaction.close()
        • AsyncTransaction.cancel()
        • AsyncTransaction.closed()
    • Managed Transactions (transaction functions)
      • AsyncManagedTransaction
        • AsyncManagedTransaction.run()
  • AsyncResult
    • AsyncResult
      • AsyncResult.__aiter__()
      • AsyncResult.__anext__()
      • AsyncResult.keys()
      • AsyncResult.consume()
      • AsyncResult.single()
      • AsyncResult.fetch()
      • AsyncResult.peek()
      • AsyncResult.graph()
      • AsyncResult.value()
      • AsyncResult.values()
      • AsyncResult.data()
      • AsyncResult.to_df()
      • AsyncResult.to_eager_result()
      • AsyncResult.closed()
  • AsyncBookmarkManager
    • AsyncBookmarkManager
      • AsyncBookmarkManager.update_bookmarks()
      • AsyncBookmarkManager.get_bookmarks()
  • Async Cancellation
  • Async Logging
• Spatial Data Types
  • Point
    • Point
      • Point.srid
  • CartesianPoint
    • CartesianPoint
      • CartesianPoint.x
      • CartesianPoint.y
      • CartesianPoint.z
    • Examples
  • WGS84Point
    • WGS84Point
      • WGS84Point.x
      • WGS84Point.y
      • WGS84Point.z
      • WGS84Point.longitude
      • WGS84Point.latitude
      • WGS84Point.height
    • Examples
• Temporal Data Types
  • Constants
    • MIN_YEAR
    • MAX_YEAR
  • Date
    • Date
    • Class methods
      • Date.today()
      • Date.utc_today()
      • Date.from_timestamp()
      • Date.utc_from_timestamp()
      • Date.from_ordinal()
      • Date.parse()
      • Date.from_native()
      • Date.from_clock_time()
      • Date.is_leap_year()
      • Date.days_in_year()
      • Date.days_in_month()
    • Class attributes
      • Date.min
      • Date.max
      • Date.resolution
    • Instance attributes
      • Date.year
      • Date.month
      • Date.day
      • Date.year_month_day
      • Date.year_week_day
      • Date.year_day
    • Operations
      • Date.__hash__()
      • Date.__eq__()
      • Date.__ne__()
      • Date.__lt__()
      • Date.__gt__()
      • Date.__le__()
      • Date.__ge__()
      • Date.__add__()
      • Date.__sub__()
    • Instance methods
      • Date.replace()
      • Date.time_tuple()
      • Date.to_ordinal()
      • Date.to_clock_time()
      • Date.to_native()
      • Date.weekday()
      • Date.iso_weekday()
      • Date.iso_calendar()
      • Date.iso_format()
      • Date.__repr__()
      • Date.__str__()
      • Date.__format__()
    • Special values
      • ZeroDate
  • Time
    • Time
    • Class methods
      • Time.now()
      • Time.utc_now()
      • Time.from_ticks()
      • Time.from_native()
      • Time.from_clock_time()
    • Class attributes
      • Time.min
      • Time.max
      • Time.resolution
    • Instance attributes
      • Time.ticks
      • Time.hour
      • Time.minute
      • Time.second
      • Time.nanosecond
      • Time.hour_minute_second_nanosecond
      • Time.tzinfo
    • Operations
      • Time.__hash__()
      • Time.__eq__()
      • Time.__ne__()
      • Time.__lt__()
      • Time.__gt__()
      • Time.__le__()
      • Time.__ge__()
    • Instance methods
      • Time.replace()
      • Time.utc_offset()
      • Time.dst()
      • Time.tzname()
      • Time.to_clock_time()
      • Time.to_native()
      • Time.iso_format()
      • Time.__repr__()
      • Time.__str__()
      • Time.__format__()
    • Special values
      • Midnight
      • Midday
  • DateTime
    • DateTime
    • Class methods
      • DateTime.now()
      • DateTime.utc_now()
      • DateTime.from_timestamp()
      • DateTime.utc_from_timestamp()
      • DateTime.from_ordinal()
      • DateTime.combine()
      • DateTime.from_native()
      • DateTime.from_clock_time()
    • Class attributes
      • DateTime.min
      • DateTime.max
      • DateTime.resolution
    • Instance attributes
      • DateTime.year
      • DateTime.month
      • DateTime.day
      • DateTime.year_month_day
      • DateTime.year_week_day
      • DateTime.year_day
      • DateTime.hour
      • DateTime.minute
      • DateTime.second
      • DateTime.nanosecond
      • DateTime.tzinfo
      • DateTime.hour_minute_second_nanosecond
    • Operations
      • DateTime.__hash__()
      • DateTime.__eq__()
      • DateTime.__ne__()
      • DateTime.__lt__()
      • DateTime.__gt__()
      • DateTime.__le__()
      • DateTime.__ge__()
      • DateTime.__add__()
      • DateTime.__sub__()
    • Instance methods
      • DateTime.date()
      • DateTime.time()
      • DateTime.timetz()
      • DateTime.replace()
      • DateTime.as_timezone()
      • DateTime.utc_offset()
      • DateTime.dst()
      • DateTime.tzname()
      • DateTime.to_ordinal()
      • DateTime.to_clock_time()
      • DateTime.to_native()
      • DateTime.weekday()
      • DateTime.iso_weekday()
      • DateTime.iso_calendar()
      • DateTime.iso_format()
      • DateTime.__repr__()
      • DateTime.__str__()
      • DateTime.__format__()
    • Special values
      • Never
      • UnixEpoch
  • Duration
    • Duration
    • Class attributes
      • Duration.min
      • Duration.max
    • Instance attributes
      • Duration.months
      • Duration.days
      • Duration.seconds
      • Duration.nanoseconds
      • Duration.years_months_days
      • Duration.hours_minutes_seconds_nanoseconds
    • Operations
      • Duration.__bool__()
      • Duration.__add__()
      • Duration.__sub__()
      • Duration.__mul__()
      • Duration.__truediv__()
      • Duration.__floordiv__()
      • Duration.__mod__()
      • Duration.__divmod__()
      • Duration.__pos__()
      • Duration.__neg__()
      • Duration.__abs__()
      • Duration.__repr__()
      • Duration.__str__()
    • Instance methods
      • Duration.iso_format()
• Vector Data Types
  • Vector
    • Vector.raw()
    • Vector.set_raw()
    • Vector.dtype
    • Vector.from_bytes()
    • Vector.from_native()
    • Vector.to_native()
    • Vector.from_numpy()
    • Vector.to_numpy()
    • Vector.from_pyarrow()
    • Vector.to_pyarrow()
  • VectorEndian
    • VectorEndian.BIG
    • VectorEndian.LITTLE
  • VectorDType
    • VectorDType.F32
    • VectorDType.F64
    • VectorDType.I8
    • VectorDType.I16
    • VectorDType.I32
    • VectorDType.I64
• Other Driver Data Types
  • Unsupported Type
    • UnsupportedType
      • UnsupportedType.name
      • UnsupportedType.minimum_protocol_version
      • UnsupportedType.message
• Breaking Changes
  • Version Scheme Changes
  • Python Versions
  • Namespace Changes
  • Secure Connection
  • Bookmark Changes
  • Exceptions Changes
  • URI Scheme Changes
  • Class Renaming Changes
  • Argument Renaming Changes
  • API Changes
  • Dependency Changes
  • Configuration Name Changes