Table of Contents

Namespace Neo4j.Driver.Mapping

Classes

AsyncEnumerableExtensions

Contains extension methods for mapping IAsyncEnumerable<IRecord> streams to C# objects.

CypherParameterMappingAttribute

Overrides the Cypher parameter name used when the containing object is passed as a query parameter.

DelegateAsyncEnumerableExtensions

Provides extension methods for materializing System.Collections.Generic.IAsyncEnumerable<T> into lists of objects by mapping each record in the enumerable to an object using provided delegates.

DelegateExecutableQueryMappingExtensions

Contains extensions for using delegate mapping with the driver's Neo4j.Driver.Internal.ExecutableQuery<TIn, TOut> methods.

DelegateMappingRecordExtensions

Contains extensions for mapping records to objects using delegates.

EntityExtensions

Contains extensions for entities such as nodes and relationships.

ExecutableQueryMappingExtensions

Contains extensions for mapping results from the ExecutableQuery(string) API to C# objects.

MappingBinding

Represents metadata for mapping an entity during the mapping process in the Neo4j driver.

MappingBindingsAttribute

An attribute that applies metadata for mapping bindings in Neo4j object mapping. This attribute is used to customize the mapping of properties or parameters when interacting with the Neo4j database.

MappingConstructorAttribute

Marks the constructor that the default mapper should use when creating an instance of the decorated type.

MappingDefaultValueAttribute

Marks a property or constructor parameter as optional and specifies a fallback value to use when the corresponding record field is absent. The mapper will not throw an exception if the field is missing. This attribute has no effect when using custom-defined mappers.

MappingFailedException

The exception that is thrown when the mapping of a record to a target type failed.

MappingIgnoredAttribute

Instructs the default mapper to skip this property entirely. No value will be read from the record or assigned to this property. This attribute does not affect custom-defined mappers.

MappingOptionalAttribute

If a property is decorated with this attribute, it will be considered optional. The mapper will not throw an exception if it cannot find the named value in the record. This attribute will have no effect when using custom-defined mappers.

MappingSourceAttribute

Instructs the default mapper to use a different record field name (or dot-separated path) when mapping a value to the marked property or parameter. This attribute does not affect custom-defined mappers.

RecordExtensions

Contains extensions for accessing values simply from records and entities.

RecordObjectMapping

Controls global record mapping configuration.

Interfaces

IMappingBindingMutator

Implemented by attributes that customise how the default mapper reads a property or parameter.

IMappingBuilder<TObject>

Defines a builder for mapping objects from IRecords.

IMappingProvider

Implement this interface to register one or more type mappings using the fluent IMappingBuilder<TObject> API.

IMappingRegistry

Contains methods for registering a mapping with the global mapping configuration.

IRecordMapper<T>

Implement this interface to provide a fully custom mapping from an IRecord to an object of type T.

Enums

EntityMappingSource

Controls what aspect of a graph entity is read when mapping a record field to a C# property.