Search Results for

    Show / Hide Table of Contents

    Class NpgsqlDbContextOptionsBuilderExtensions

    Provides extension methods on and used to configure a to context to a PostgreSQL database with Npgsql.

    Inheritance
    object
    NpgsqlDbContextOptionsBuilderExtensions
    Namespace: Microsoft.EntityFrameworkCore
    Assembly: Npgsql.EntityFrameworkCore.PostgreSQL.dll
    Syntax
    public static class NpgsqlDbContextOptionsBuilderExtensions

    Methods

    | Improve this Doc View Source

    UseNpgsql(DbContextOptionsBuilder, DbConnection, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder UseNpgsql(this DbContextOptionsBuilder optionsBuilder, DbConnection connection, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null)
    Parameters
    Type Name Description
    DbContextOptionsBuilder optionsBuilder

    A builder for setting options on the context.

    DbConnection connection

    An existing to be used to connect to the database. If the connection is in the open state then EF will not open or close the connection. If the connection is in the closed state then EF will open and close the connection as needed.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder

    The options builder so that further configuration can be chained.

    | Improve this Doc View Source

    UseNpgsql(DbContextOptionsBuilder, DbDataSource, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder UseNpgsql(this DbContextOptionsBuilder optionsBuilder, DbDataSource dataSource, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null)
    Parameters
    Type Name Description
    DbContextOptionsBuilder optionsBuilder

    A builder for setting options on the context.

    DbDataSource dataSource

    A which will be used to get database connections.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder

    The options builder so that further configuration can be chained.

    | Improve this Doc View Source

    UseNpgsql(DbContextOptionsBuilder, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL server with Npgsql, but without initially setting any or connection string.

    The connection or connection string must be set before the is used to connect to a database. Set a connection using . Set a connection string using .

    Declaration
    public static DbContextOptionsBuilder UseNpgsql(this DbContextOptionsBuilder optionsBuilder, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null)
    Parameters
    Type Name Description
    DbContextOptionsBuilder optionsBuilder

    The builder being used to configure the context.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder

    The options builder so that further configuration can be chained.

    | Improve this Doc View Source

    UseNpgsql(DbContextOptionsBuilder, string?, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder UseNpgsql(this DbContextOptionsBuilder optionsBuilder, string? connectionString, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null)
    Parameters
    Type Name Description
    DbContextOptionsBuilder optionsBuilder

    A builder for setting options on the context.

    string? connectionString

    The connection string of the database to connect to.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder

    The options builder so that further configuration can be chained.

    | Improve this Doc View Source

    UseNpgsql<TContext>(DbContextOptionsBuilder<TContext>, DbConnection, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder<TContext> UseNpgsql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, DbConnection connection, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null) where TContext : DbContext
    Parameters
    Type Name Description
    DbContextOptionsBuilder<><TContext> optionsBuilder

    A builder for setting options on the context.

    DbConnection connection

    An existing to be used to connect to the database. If the connection is in the open state then EF will not open or close the connection. If the connection is in the closed state then EF will open and close the connection as needed.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder<><TContext>

    The options builder so that further configuration can be chained.

    Type Parameters
    Name Description
    TContext
    | Improve this Doc View Source

    UseNpgsql<TContext>(DbContextOptionsBuilder<TContext>, DbDataSource, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder<TContext> UseNpgsql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, DbDataSource dataSource, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null) where TContext : DbContext
    Parameters
    Type Name Description
    DbContextOptionsBuilder<><TContext> optionsBuilder

    A builder for setting options on the context.

    DbDataSource dataSource

    A which will be used to get database connections.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder<><TContext>

    The options builder so that further configuration can be chained.

    Type Parameters
    Name Description
    TContext
    | Improve this Doc View Source

    UseNpgsql<TContext>(DbContextOptionsBuilder<TContext>, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL server with Npgsql, but without initially setting any , or connection string.

    The connection, data source or connection string must be set before the is used to connect to a database. Set a connection using , a data source using SetDbDataSource(DatabaseFacade, DbDataSource), or a connection string using .

    Declaration
    public static DbContextOptionsBuilder<TContext> UseNpgsql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null) where TContext : DbContext
    Parameters
    Type Name Description
    DbContextOptionsBuilder<><TContext> optionsBuilder

    The builder being used to configure the context.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-specific configuration.

    Returns
    Type Description
    DbContextOptionsBuilder<><TContext>

    The options builder so that further configuration can be chained.

    Type Parameters
    Name Description
    TContext
    | Improve this Doc View Source

    UseNpgsql<TContext>(DbContextOptionsBuilder<TContext>, string?, Action<NpgsqlDbContextOptionsBuilder>?)

    Configures the context to connect to a PostgreSQL database with Npgsql.

    Declaration
    public static DbContextOptionsBuilder<TContext> UseNpgsql<TContext>(this DbContextOptionsBuilder<TContext> optionsBuilder, string? connectionString, Action<NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction = null) where TContext : DbContext
    Parameters
    Type Name Description
    DbContextOptionsBuilder<><TContext> optionsBuilder

    A builder for setting options on the context.

    string? connectionString

    The connection string of the database to connect to.

    Action<><NpgsqlDbContextOptionsBuilder>? npgsqlOptionsAction

    An optional action to allow additional Npgsql-configuration.

    Returns
    Type Description
    DbContextOptionsBuilder<><TContext>

    The options builder so that further configuration can be chained.

    Type Parameters
    Name Description
    TContext
    • Improve this Doc
    • View Source
    In This Article
    Back to top © Copyright 2023 The Npgsql Development Team