Table of Contents

Namespace Neo4j.Driver.Mapping

Classes

AsyncEnumerableExtensions

Contains extension methods for IAsyncEnumerable<T>.

DelegateAsyncEnumerableExtensions

Provides extension methods for materializing 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 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 using the global mapping system with the driver's ExecutableQuery<TIn, TOut> methods.

MappingConstructorAttribute

Indicates that the constructor should be used when mapping a record to an object.

MappingDefaultValueAttribute

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; instead, it will use the default value provided. This attribute will have 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 object mapper not to attempt to map any value to this property. This attribute does not affect custom-defined mappers.

MappingOptionalAttribute

If a property or 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 field than the property name when mapping a value to the marked property. This attribute does not affect custom-defined mappers. A path may consist of the name of the field to be mapped, or a dot-separated path to a nested field.

RecordExtensions

Contains extensions for accessing values simply from records and entities.

RecordObjectMapping

Controls global record mapping configuration.

Interfaces

IMappingBuilder<TObject>

Defines a builder for mapping objects from IRecords.

IMappingProvider

Interface to be implemented by a class that provides mappers to the mapping system.

IMappingRegistry

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

IRecordMapper<T>

Interface to be implemented by a class that maps records to objects of type T.

Enums

EntityMappingSource

Represents a mapping from an entity itself rather than any of its properties.