Search Results for

    Show / Hide Table of Contents

    Interface INpgsqlTypeMapper

    A type mapper, managing how to read and write CLR values to PostgreSQL data types. A type mapper exists for each connection, as well as a single global type mapper (accessible via NpgsqlConnection.GlobalTypeMapper).

    Namespace: Npgsql.TypeMapping
    Assembly: Npgsql.dll
    Syntax
    public interface INpgsqlTypeMapper

    Properties

    DefaultNameTranslator

    The default name translator to convert CLR type names and member names.

    Declaration
    INpgsqlNameTranslator DefaultNameTranslator { get; }
    Property Value
    Type Description
    INpgsqlNameTranslator

    Methods

    AddTypeResolverFactory(TypeHandlerResolverFactory)

    Adds a type resolver factory, which produces resolvers that can add or modify support for PostgreSQL types. Typically used by plugins.

    Declaration
    void AddTypeResolverFactory(TypeHandlerResolverFactory resolverFactory)
    Parameters
    Type Name Description
    TypeHandlerResolverFactory resolverFactory

    The type resolver factory to be added.

    MapComposite(Type, String, INpgsqlNameTranslator)

    Maps a CLR type to a composite type.

    Declaration
    INpgsqlTypeMapper MapComposite(Type clrType, string pgName = null, INpgsqlNameTranslator nameTranslator = null)
    Parameters
    Type Name Description
    Type clrType

    The .NET type to be mapped.

    String pgName

    A PostgreSQL type name for the corresponding composite type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    INpgsqlTypeMapper
    Remarks

    Maps CLR fields and properties by string to PostgreSQL names. The translation strategy can be controlled by the nameTranslator parameter, which defaults to NpgsqlSnakeCaseNameTranslator. If there is a discrepancy between the .NET type and database type while a composite is read or written, an exception will be raised.

    MapComposite<T>(String, INpgsqlNameTranslator)

    Maps a CLR type to a PostgreSQL composite type.

    Declaration
    INpgsqlTypeMapper MapComposite<T>(string pgName = null, INpgsqlNameTranslator nameTranslator = null)
    Parameters
    Type Name Description
    String pgName

    A PostgreSQL type name for the corresponding composite type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    INpgsqlTypeMapper
    Type Parameters
    Name Description
    T

    The .NET type to be mapped

    Remarks

    CLR fields and properties by string to PostgreSQL names. The translation strategy can be controlled by the nameTranslator parameter, which defaults to NpgsqlSnakeCaseNameTranslator. You can also use the PgNameAttribute on your members to manually specify a PostgreSQL name. If there is a discrepancy between the .NET type and database type while a composite is read or written, an exception will be raised.

    MapEnum<TEnum>(String, INpgsqlNameTranslator)

    Maps a CLR enum to a PostgreSQL enum type.

    Declaration
    INpgsqlTypeMapper MapEnum<TEnum>(string pgName = null, INpgsqlNameTranslator nameTranslator = null)
        where TEnum : struct, Enum
    Parameters
    Type Name Description
    String pgName

    A PostgreSQL type name for the corresponding enum type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    INpgsqlTypeMapper
    Type Parameters
    Name Description
    TEnum

    The .NET enum type to be mapped

    Remarks

    CLR enum labels are mapped by name to PostgreSQL enum labels. The translation strategy can be controlled by the nameTranslator parameter, which defaults to NpgsqlSnakeCaseNameTranslator. You can also use the PgNameAttribute on your enum fields to manually specify a PostgreSQL enum label. If there is a discrepancy between the .NET and database labels while an enum is read or written, an exception will be raised.

    Reset()

    Resets all mapping changes performed on this type mapper and reverts it to its original, starting state.

    Declaration
    void Reset()

    UnmapComposite(Type, String, INpgsqlNameTranslator)

    Removes an existing composite mapping.

    Declaration
    bool UnmapComposite(Type clrType, string pgName = null, INpgsqlNameTranslator nameTranslator = null)
    Parameters
    Type Name Description
    Type clrType

    The .NET type to be unmapped.

    String pgName

    A PostgreSQL type name for the corresponding composite type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    Boolean

    UnmapComposite<T>(String, INpgsqlNameTranslator)

    Removes an existing composite mapping.

    Declaration
    bool UnmapComposite<T>(string pgName = null, INpgsqlNameTranslator nameTranslator = null)
    Parameters
    Type Name Description
    String pgName

    A PostgreSQL type name for the corresponding composite type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    T

    UnmapEnum<TEnum>(String, INpgsqlNameTranslator)

    Removes an existing enum mapping.

    Declaration
    bool UnmapEnum<TEnum>(string pgName = null, INpgsqlNameTranslator nameTranslator = null)
        where TEnum : struct, Enum
    Parameters
    Type Name Description
    String pgName

    A PostgreSQL type name for the corresponding enum type in the database. If null, the name translator given in nameTranslator will be used.

    INpgsqlNameTranslator nameTranslator

    A component which will be used to translate CLR names (e.g. SomeClass) into database names (e.g. some_class). Defaults to NpgsqlSnakeCaseNameTranslator

    Returns
    Type Description
    Boolean
    Type Parameters
    Name Description
    TEnum

    Extension Methods

    NpgsqlGeoJSONExtensions.UseGeoJson(INpgsqlTypeMapper, GeoJSONOptions, Boolean)
    NpgsqlNodaTimeExtensions.UseNodaTime(INpgsqlTypeMapper)
    NpgsqlJsonNetExtensions.UseJsonNet(INpgsqlTypeMapper, Type[], Type[], Nullable<JsonSerializerSettings>)
    NpgsqlNetTopologySuiteExtensions.UseNetTopologySuite(INpgsqlTypeMapper, Nullable<CoordinateSequenceFactory>, Nullable<PrecisionModel>, Ordinates, Boolean)
    In This Article
    Back to top © Copyright 2022 The Npgsql Development Team