Npgsql

https://www.npgsql.org
Admin
Npgsql is an open source ADO.NET Data Provider for PostgreSQL that allows C#, Visual Basic, and F#...
Tokens:670,855
Snippets:7,138
Trust Score:9.4
Update:2 months ago
Show doc for...
Tokens:
Raw
### StartReplication

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PgOutputConnectionExtensions.html

Instructs the server to start the Logical Streaming Replication Protocol (pgoutput logical decoding plugin), starting at WAL location `walLocation` or at the slot's consistent point if `walLocation` isn't specified. The server can reply with an error, for example if the requested section of the WAL has already been recycled.

```APIDOC
## StartReplication

### Description
Instructs the server to start the Logical Streaming Replication Protocol (pgoutput logical decoding plugin), starting at WAL location `walLocation` or at the slot's consistent point if `walLocation` isn't specified. The server can reply with an error, for example if the requested section of the WAL has already been recycled.

### Method Signature
```csharp
public static IAsyncEnumerable<PgOutputReplicationMessage> StartReplication(this LogicalReplicationConnection connection, PgOutputReplicationSlot slot, PgOutputReplicationOptions options, CancellationToken cancellationToken, NpgsqlLogSequenceNumber? walLocation = null)
```

### Parameters
#### Path Parameters
* **connection** (LogicalReplicationConnection) - The LogicalReplicationConnection to use for starting replication.
* **slot** (PgOutputReplicationSlot) - The replication slot that will be updated as replication progresses so that the server knows which WAL segments are still needed by the standby.
* **options** (PgOutputReplicationOptions) - The collection of options passed to the slot's logical decoding plugin.
* **cancellationToken** (CancellationToken) - The token to monitor for stopping the replication.
* **walLocation** (NpgsqlLogSequenceNumber?) - Optional. The WAL location to begin streaming at.

### Returns
IAsyncEnumerable<PgOutputReplicationMessage>
    A Task<TResult> representing an IAsyncEnumerable<T> that can be used to stream WAL entries in form of PgOutputReplicationMessage instances.
```

--------------------------------

### Example Console Log Output

Source: https://www.npgsql.org/doc/diagnostics/logging.html

This is an example of the console output generated by Npgsql when logging command executions at the Information level.

```text
info: Npgsql.Command[2001]
      Command execution completed (duration=16ms): SELECT 1
```

--------------------------------

### Start Replication with TestDecodingReplicationSlot

Source: https://www.npgsql.org/doc/replication.html

Connect to PostgreSQL, open a replication connection, and start consuming messages using the TestDecodingReplicationSlot. Ensure to call SetReplicationStatus to inform the server about processed WAL files.

```csharp
await using var conn = new LogicalReplicationConnection("Host=localhost;Username=test;Password=test");
await conn.Open();

var slot = new TestDecodingReplicationSlot("blog_slot");

// The following will loop until the cancellation token is triggered, and will print message types coming from PostgreSQL:
var cancellationTokenSource = new CancellationTokenSource();
await foreach (var message in conn.StartReplication(slot, cancellationTokenSource.Token))
{
    Console.WriteLine($"Message: {message.Data}");

    // Always call SetReplicationStatus() or assign LastAppliedLsn and LastFlushedLsn individually
    // so that Npgsql can inform the server which WAL files can be removed/recycled.
    conn.SetReplicationStatus(message.WalEnd);
}
```

--------------------------------

### Start PgOutput Replication Stream

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PgOutputConnectionExtensions.html

Starts streaming logical replication using the pgoutput plugin. Can begin at a specific WAL location or the slot's consistent point. Handles potential server errors like recycled WAL.

```csharp
public static IAsyncEnumerable<PgOutputReplicationMessage> StartReplication(this LogicalReplicationConnection connection, PgOutputReplicationSlot slot, PgOutputReplicationOptions options, CancellationToken cancellationToken, NpgsqlLogSequenceNumber? walLocation = null)
```

--------------------------------

### NpgsqlCube ToSubset Method Example

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlCube.html

Demonstrates how to create a new cube from a subset of dimensions of an existing cube using specified dimension indexes. This can be used to extract single dimensions, remove dimensions, or reorder them.

```csharp
var cube = new NpgsqlCube(new[] { 1, 3, 5 }, new[] { 6, 7, 8 }); // '(1,3,5),(6,7,8)'
cube.ToSubset(1); // '(3),(7)'
cube.ToSubset(2, 1, 0, 0); // '(5,3,1,1),(8,7,6,6)'
```

--------------------------------

### NpgsqlLSeg Start Property

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlLSeg.html

Gets or sets the start NpgsqlPoint of the line segment.

```csharp
public NpgsqlPoint Start { readonly get; set; }
```

--------------------------------

### BeginPrepareMessage

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PgOutput.Messages.html

Represents a Logical Replication Protocol begin prepare message.

```APIDOC
## BeginPrepareMessage

### Description
Logical Replication Protocol begin prepare message.

### Method
N/A (Class Definition)

### Endpoint
N/A

### Parameters
N/A

### Request Example
N/A

### Response
N/A
```

--------------------------------

### LogicalReplicationSlot ConsistentPoint Property

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.Internal.LogicalReplicationSlot.html

Gets the WAL location at which the slot became consistent. This is the earliest location from which streaming can start.

```csharp
public NpgsqlLogSequenceNumber ConsistentPoint { get; }
```

--------------------------------

### Create and Insert Cube Data with Npgsql

Source: https://www.npgsql.org/doc/release-notes/10.0.html

Demonstrates how to create a table with a CUBE column, insert a NpgsqlCube object, and retrieve it. Ensure the 'cube' extension is enabled.

```csharp
command.CommandText = ""
    CREATE EXTENSION IF NOT EXISTS cube;
    CREATE TABLE data (my_cude CUBE);
"";
await command.ExecuteNonQueryAsync();

var cube = new NpgsqlCube([1.0, 2.0, 3.0], [4.0, 5.0, 6.0]);
command.CommandText = "INSERT INTO data (my_cude) VALUES ($1)";
command.Parameters.Add(new() { Value = cube });
await command.ExecuteNonQueryAsync();

command.CommandText = "SELECT my_cude FROM data";
var readCube = (NpgsqlCube)(await command.ExecuteScalarAsync())!;
Console.WriteLine($"Read cube: {readCube}");

```

--------------------------------

### Implement Next Method

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.ValueGeneration.NpgsqlSequentialGuidValueGenerator.html

Gets a GUID value to be assigned to a property. This method is intended for internal use by Entity Framework Core.

```csharp
public override Guid Next(EntityEntry entry)
```

--------------------------------

### Configure Certificate Authentication Callbacks

Source: https://www.npgsql.org/efcore/misc/other.html

Set up callbacks for verifying server certificates and providing client certificates for authentication. Ensure callbacks are static methods when using `OnConfiguring` to avoid performance degradation.

```csharp
protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
    => optionsBuilder.UseNpgsql(
        "<connection_string>",
        options =>
        {
            options.RemoteCertificateValidationCallback(MyCallback1);
            options.ProvideClientCertificatesCallback(MyCallback2);
        });
```

--------------------------------

### Initialize NpgsqlDbContextOptionsBuilder

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.NpgsqlDbContextOptionsBuilder.html

Constructor for creating a new instance of the builder.

```csharp
public NpgsqlDbContextOptionsBuilder(DbContextOptionsBuilder optionsBuilder)__
```

--------------------------------

### Generate Database-Side Random GUID (Pre-PostgreSQL 18)

Source: https://www.npgsql.org/efcore/modeling/generated-properties.html

Configure a property to generate random GUIDs in the database using `uuid_generate_v4()`. Note that version 4 GUIDs perform worse with database indexes.

```csharp
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity<Blog>()
        .Property(e => e.SomeGuidProperty)
        .HasDefaultValueSql("uuid_generate_v4()");
}
```

--------------------------------

### Map Range Example (float)

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.NpgsqlDbContextOptionsBuilder.html

Example demonstrating how to map a PostgreSQL 'floatrange' type to its corresponding CLR type.

```csharp
NpgsqlTypeMappingSource.MapRange("floatrange", typeof(float));
```

--------------------------------

### NpgsqlDatabaseInfo Constructor (Protected)

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html

Initializes a new instance of the NpgsqlDatabaseInfo class with host, port, database name, and version.

```csharp
protected NpgsqlDatabaseInfo(string host, int port, string databaseName, Version version)
```

--------------------------------

### this[string]

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnectionStringBuilder.html

Gets or sets the value associated with the specified key. The keyword parameter is the key of the item to get or set.

```APIDOC
## this[string keyword]

### Description
Gets or sets the value associated with the specified key.

### Parameters 

`keyword` string
    
The key of the item to get or set.

### Property Value 

object
    
The value associated with the specified key.
```

--------------------------------

### Start Writing a Row (Synchronous)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBinaryImporter.html

Starts writing a single row. This method must be invoked before writing any columns for the row.

```csharp
public void StartRow()
```

--------------------------------

### Prepare a Command with Multiple Statements

Source: https://www.npgsql.org/doc/prepare.html

This example shows how to prepare a command containing multiple SQL statements. If the statements are identical, Npgsql will use a single prepared statement for all of them.

```csharp
var cmd = new NpgsqlCommand("UPDATE foo SET bar=@bar WHERE baz=@baz; UPDATE foo SET bar=@bar WHERE baz=@baz");
// set parameters.
await cmd.PrepareAsync();
```

--------------------------------

### Initialize NpgsqlBatchCommand

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommand.html

Initializes a new instance of the NpgsqlBatchCommand class with no command text.

```csharp
public NpgsqlBatchCommand()
```

--------------------------------

### Start Writing a Row (Asynchronous)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBinaryImporter.html

Asynchronously starts writing a single row. This method must be invoked before writing any columns for the row.

```csharp
public Task StartRowAsync(CancellationToken cancellationToken = default)
```

--------------------------------

### Configure DbContext with OnConfiguring

Source: https://www.npgsql.org/efcore/index.html

Use the OnConfiguring method to set up your DbContext with Npgsql. This is simple but discouraged for production.

```csharp
public class BloggingContext : DbContext
{
    public DbSet<Blog> Blogs { get; set; }
    public DbSet<Post> Posts { get; set; }

    protected override void OnConfiguring(DbContextOptionsBuilder optionsBuilder)
        => optionsBuilder.UseNpgsql("<connection string>");
}

// At the point where you need to perform a database operation:
using var context = new BloggingContext();
// Use the context...
```

--------------------------------

### GetGuid(int)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlNestedDataReader.html

Retrieves the value of the specified column as a globally unique identifier (GUID). Use this method when expecting GUID data.

```APIDOC
## GetGuid(int)

### Description
When overridden in a derived class, gets the value of the specified column as a globally unique identifier (GUID).

### Parameters
#### ordinal int
- **ordinal** (int) - Required - The zero-based column ordinal.

### Returns
Guid
The value of the specified column.

### Exceptions
- IndexOutOfRangeException: The column index is out of range.
- InvalidCastException: The specified cast is not valid.
```

--------------------------------

### NpgsqlDataAdapter Constructor with Command Text and Connection String

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataAdapter.html

Initializes a new instance of the NpgsqlDataAdapter class with a command text and a connection string.

```csharp
public NpgsqlDataAdapter(string selectCommandText, string selectConnectionString)__
```

--------------------------------

### NpgsqlBatchCommand Constructors

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommand.html

Initializes a new instance of the NpgsqlBatchCommand class.

```APIDOC
## NpgsqlBatchCommand()

### Description
Initializes a new NpgsqlBatchCommand.

### Method
Constructor

### Parameters
None
```

```APIDOC
## NpgsqlBatchCommand(string commandText)

### Description
Initializes a new NpgsqlBatchCommand.

### Method
Constructor

### Parameters
#### Path Parameters
- **commandText** (string) - Required - The text of the NpgsqlBatchCommand.
```

--------------------------------

### Map Range Generic Example (float)

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.NpgsqlDbContextOptionsBuilder.html

Example demonstrating how to map a PostgreSQL 'floatrange' type using the generic MapRange method.

```csharp
NpgsqlTypeMappingSource.MapRange<float>("floatrange");
```

--------------------------------

### Get Storage Parameter Configuration Source

Source: https://www.npgsql.org/efcore/api/Microsoft.EntityFrameworkCore.NpgsqlEntityTypeExtensions.html

Gets the configuration source for a specific storage parameter. Use this to track how a storage parameter was set.

```csharp
public static ConfigurationSource? GetStorageParameterConfigurationSource(this IConventionEntityType index, string parameterName)
```

--------------------------------

### Prepare and Execute a Command

Source: https://www.npgsql.org/doc/prepare.html

This snippet demonstrates the basic usage of preparing a command before execution. Ensure parameter types are set before calling PrepareAsync() if no values are provided initially.

```csharp
var cmd = new NpgsqlCommand(...);
cmd.Parameters.Add("param", NpgsqlDbType.Integer);
await cmd.PrepareAsync();
// Set parameters
await cmd.ExecuteNonQueryAsync();
// And so on
```

--------------------------------

### CopyTo DbBatchCommand Array Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommandCollection.html

Copies the elements of the collection to a DbBatchCommand array, starting at a specified index. Requires the destination array and starting index.

```csharp
public override void CopyTo(DbBatchCommand[] array, int arrayIndex)
```

--------------------------------

### NpgsqlDatabaseInfo Constructor with Server Version (Protected)

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html

Initializes a new instance of the NpgsqlDatabaseInfo class with host, port, database name, version, and server version string.

```csharp
protected NpgsqlDatabaseInfo(string host, int port, string databaseName, Version version, string serverVersion)
```

--------------------------------

### CopyTo NpgsqlBatchCommand Array Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommandCollection.html

Copies the elements of the collection to an NpgsqlBatchCommand array, starting at a specified index. Requires the destination array and starting index.

```csharp
public void CopyTo(NpgsqlBatchCommand[] array, int arrayIndex)
```

--------------------------------

### Initialize NpgsqlCommand with Command Text and Connection

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlCommand.html

Initializes a new instance of the NpgsqlCommand class with the text of the query and a NpgsqlConnection.

```csharp
public NpgsqlCommand(string? cmdText, NpgsqlConnection? connection)
```

--------------------------------

### StartingRawCopy Event ID

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlEventId.html

Represents the event of starting a raw copy operation.

```csharp
public const int StartingRawCopy = 40004
```

--------------------------------

### Configure Method

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NetTopologySuiteDataSourceConfigurationPlugin.html

Configures the Npgsql data source builder with NetTopologySuite settings.

```csharp
public void Configure(NpgsqlDataSourceBuilder npgsqlDataSourceBuilder)__
```

--------------------------------

### Generate GUID Client-Side for Non-Key Property

Source: https://www.npgsql.org/efcore/modeling/generated-properties.html

Configure a non-key property to generate sequential GUIDs client-side using `NpgsqlSequentialGuidValueGenerator`. This is optimized for database indexes.

```csharp
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity<Blog>()
        .Property(b => b.SomeGuidProperty)
        .HasValueGenerator<NpgsqlSequentialGuidValueGenerator>();
}
```

--------------------------------

### Constructor: NpgsqlSqlGenerationHelper

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.NpgsqlSqlGenerationHelper.html

Initializes a new instance of the NpgsqlSqlGenerationHelper class.

```APIDOC
## Constructor: NpgsqlSqlGenerationHelper

### Description
Initializes a new instance of the NpgsqlSqlGenerationHelper class using the provided dependencies.

### Parameters
- **dependencies** (RelationalSqlGenerationHelperDependencies) - Required - The dependencies required for SQL generation.
```

--------------------------------

### Get or Add PostgresEnum (Mutable)

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresEnum.html

Gets an existing PostgresEnum from the IMutableAnnotatable or adds a new one if it doesn't exist. Requires the enum name and labels.

```csharp
public static PostgresEnum GetOrAddPostgresEnum(IMutableAnnotatable annotatable, string? schema, string name, string[] labels)
```

--------------------------------

### Get or Add PostgresEnum (Convention)

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresEnum.html

Gets an existing PostgresEnum from the IConventionAnnotatable or adds a new one if it doesn't exist. Requires the enum name and labels.

```csharp
public static PostgresEnum GetOrAddPostgresEnum(IConventionAnnotatable annotatable, string? schema, string name, string[] labels)
```

--------------------------------

### EnableNetworkTypes Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlSlimDataSourceBuilder.html

Sets up network mappings for PhysicalAddress, IPAddress, NpgsqlInet, and NpgsqlCidr types to PostgreSQL macaddr, macaddr8, inet, and cidr types. Returns the builder instance for chaining.

```csharp
public NpgsqlSlimDataSourceBuilder EnableNetworkTypes()
```

--------------------------------

### Show

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.ReplicationConnection.html

Requests the server to send the current setting of a run-time parameter, similar to the SQL command SHOW.

```APIDOC
## Show(string, CancellationToken)

### Description
Requests the server to send the current setting of a run-time parameter. This is similar to the SQL command SHOW.

### Method
```csharp
public Task<string> Show(string parameterName, CancellationToken cancellationToken = default)
```

### Parameters
#### Parameters
- `parameterName` string - The name of a run-time parameter. Available parameters are documented in https://www.postgresql.org/docs/current/runtime-config.html.
- `cancellationToken` CancellationToken - An optional token to cancel the asynchronous operation. The default value is None.

### Returns
Task<string> - The current setting of the run-time parameter specified in `parameterName` as string.
```

--------------------------------

### Get Converter for Writing Value

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.PgConverterResolver-1.html

Abstract method to get the appropriate converter for writing a value of type T. Implementations should cache returned converters.

```csharp
public abstract PgConverterResolution? Get(T? value, PgTypeId? expectedPgTypeId)__
```

--------------------------------

### Generate Database-Side GUID (PostgreSQL 18+)

Source: https://www.npgsql.org/efcore/modeling/generated-properties.html

Configure a property to generate version 7 GUIDs directly in the database using `uuidv7()`. This is optimized for database indexes.

```csharp
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
    modelBuilder
        .Entity<Blog>()
        .Property(e => e.SomeGuidProperty)
        .HasDefaultValueSql("uuidv7()");
}
```

--------------------------------

### Build Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSourceBuilder.html

Builds and returns an NpgsqlDataSource instance that is ready for use.

```csharp
public NpgsqlDataSource Build()
```

--------------------------------

### Extract LTree Subtree

Source: https://www.npgsql.org/efcore/api/Microsoft.EntityFrameworkCore.LTree.html

Returns a subtree of this LTree from a starting position to an ending position (exclusive). This method is translated to the PostgreSQL subpath(ltree, start, end) function.

```csharp
public LTree Subtree(int start, int end)
```

--------------------------------

### Initialize NpgsqlCommand with Command Text

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlCommand.html

Initializes a new instance of the NpgsqlCommand class with the text of the query.

```csharp
public NpgsqlCommand(string? cmdText)
```

--------------------------------

### Get or Add PostgresEnum (Mutable, Default Schema)

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresEnum.html

Gets an existing PostgresEnum from the IMutableAnnotatable or adds a new one if it doesn't exist. Assumes the default schema if schema is not provided.

```csharp
public static PostgresEnum GetOrAddPostgresEnum(IMutableAnnotatable annotatable, string name, string[] labels)
```

--------------------------------

### BeginBinaryImportAsync(string, CancellationToken)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnection.html

Asynchronously begins a binary COPY FROM STDIN operation.

```APIDOC
## BeginBinaryImportAsync(string, CancellationToken)

### Description
Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.

### Signature
`public Task<NpgsqlBinaryImporter> BeginBinaryImportAsync(string copyFromCommand, CancellationToken cancellationToken = default)`

### Parameters
- **copyFromCommand** (string) - Required - A COPY FROM STDIN SQL command.
- **cancellationToken** (CancellationToken) - Optional - An optional token to cancel the asynchronous operation.

### Returns
- **Task<NpgsqlBinaryImporter>** - A NpgsqlBinaryImporter which can be used to write rows and columns.
```

--------------------------------

### Initialize NpgsqlValueGenerationConvention

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.Conventions.NpgsqlValueGenerationConvention.html

Constructor for creating a new instance of the convention with required dependencies.

```csharp
public NpgsqlValueGenerationConvention(ProviderConventionSetBuilderDependencies dependencies, RelationalConventionSetBuilderDependencies relationalDependencies)__
```

--------------------------------

### Initialize NpgsqlBatchCommand with Command Text

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatchCommand.html

Initializes a new instance of the NpgsqlBatchCommand class with the specified command text.

```csharp
public NpgsqlBatchCommand(string commandText)
```

--------------------------------

### Access RemoteCertificateValidationCallback

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NpgsqlOptionsExtension.html

Gets the specified RemoteCertificateValidationCallback.

```csharp
public virtual RemoteCertificateValidationCallback? RemoteCertificateValidationCallback { get; }
```

--------------------------------

### NpgsqlDataAdapter Constructor with Command Text and Connection

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataAdapter.html

Initializes a new instance of the NpgsqlDataAdapter class with a command text and an NpgsqlConnection.

```csharp
public NpgsqlDataAdapter(string selectCommandText, NpgsqlConnection selectConnection)__
```

--------------------------------

### Access ProvidePasswordCallback

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NpgsqlOptionsExtension.html

Gets the specified ProvidePasswordCallback.

```csharp
public virtual ProvidePasswordCallback? ProvidePasswordCallback { get; }
```

--------------------------------

### Access ProvideClientCertificatesCallback

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NpgsqlOptionsExtension.html

Gets the specified ProvideClientCertificatesCallback.

```csharp
public virtual ProvideClientCertificatesCallback? ProvideClientCertificatesCallback { get; }
```

--------------------------------

### Initialize NpgsqlHistoryRepository

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Migrations.Internal.NpgsqlHistoryRepository.html

Constructor for the NpgsqlHistoryRepository class.

```csharp
public NpgsqlHistoryRepository(HistoryRepositoryDependencies dependencies)__
```

--------------------------------

### Basic Transaction Management

Source: https://www.npgsql.org/doc/basic-usage.html

Demonstrates how to initiate, execute commands within, and commit a basic transaction using Npgsql. Ensure all commands are executed before committing or rolling back.

```csharp
await using var connection = await dataSource.OpenConnectionAsync();
await using var transaction = await connection.BeginTransactionAsync();

await using var command1 = new NpgsqlCommand("...", connection, transaction);
await command1.ExecuteNonQueryAsync();

await using var command2 = new NpgsqlCommand("...", connection, transaction);
await command2.ExecuteNonQueryAsync();

await transaction.CommitAsync();

```

--------------------------------

### Value

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlParameter.html

Gets or sets the value of the parameter.

```APIDOC
## Value

### Description
Gets or sets the value of the parameter.

### Property Value
object - An object that is the value of the parameter. The default value is null.
```

--------------------------------

### PgTypeId Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.Postgres.Field.html

Gets the PgTypeId of the field.

```csharp
public PgTypeId PgTypeId { get; init; }__
```

--------------------------------

### Initialize NpgsqlCommand with Command Text, Connection, and Transaction

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlCommand.html

Initializes a new instance of the NpgsqlCommand class with the text of the query, a NpgsqlConnection, and the NpgsqlTransaction.

```csharp
public NpgsqlCommand(string? cmdText, NpgsqlConnection? connection, NpgsqlTransaction? transaction)
```

--------------------------------

### Name Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.Postgres.Field.html

Gets the name of the field.

```csharp
public string Name { get; init; }__
```

--------------------------------

### BeginBinaryImport(string)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnection.html

Begins a binary COPY FROM STDIN operation for high-performance data import to a PostgreSQL table.

```APIDOC
## BeginBinaryImport(string)

### Description
Begins a binary COPY FROM STDIN operation, a high-performance data import mechanism to a PostgreSQL table.

### Signature
`public NpgsqlBinaryImporter BeginBinaryImport(string copyFromCommand)`

### Parameters
- **copyFromCommand** (string) - Required - A COPY FROM STDIN SQL command.

### Returns
- **NpgsqlBinaryImporter** - A NpgsqlBinaryImporter which can be used to write rows and columns.
```

--------------------------------

### Name Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html

Gets the name of the database.

```csharp
public string Name { get; }
```

--------------------------------

### StartReplication(NpgsqlLogSequenceNumber, CancellationToken, uint)

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PhysicalReplicationConnection.html

Starts streaming WAL for logical replication from a specified WAL location. The server can return errors if the WAL segment has already been recycled. An optional timeline can be specified.

```APIDOC
## StartReplication(NpgsqlLogSequenceNumber, CancellationToken, uint)

### Description
Instructs the server to start streaming the WAL for logical replication, starting at WAL location `walLocation`. The server can reply with an error, for example if the requested section of WAL has already been recycled.

### Method
`public IAsyncEnumerable<XLogDataMessage> StartReplication(NpgsqlLogSequenceNumber walLocation, CancellationToken cancellationToken, uint timeline = 0)`

### Parameters
#### Path Parameters
- **walLocation** (NpgsqlLogSequenceNumber) - Required - The WAL location to begin streaming at.
- **cancellationToken** (CancellationToken) - Required - The token to be used for stopping the replication.
- **timeline** (uint) - Optional - Streaming starts on timeline tli.

### Returns
#### Success Response
- **IAsyncEnumerable<XLogDataMessage>** - A Task<TResult> representing an IAsyncEnumerable<T> that can be used to stream WAL entries in form of XLogDataMessage instances.

### Remarks
If the client requests a timeline that's not the latest but is part of the history of the server, the server will stream all the WAL on that timeline starting from the requested start point up to the point where the server switched to another timeline.
```

--------------------------------

### Constructor: NpgsqlExecutionStrategyFactory

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.NpgsqlExecutionStrategyFactory.html

Initializes a new instance of the NpgsqlExecutionStrategyFactory class.

```APIDOC
## Constructor: NpgsqlExecutionStrategyFactory

### Description
Initializes a new instance of the NpgsqlExecutionStrategyFactory class with the specified dependencies.

### Parameters
- **dependencies** (ExecutionStrategyDependencies) - Required - The dependencies required for the execution strategy factory.
```

--------------------------------

### GetIdentityStartValueConfigurationSource

Source: https://www.npgsql.org/efcore/api/Microsoft.EntityFrameworkCore.NpgsqlPropertyExtensions.html

Retrieves the ConfigurationSource for the identity start value.

```APIDOC
## GetIdentityStartValueConfigurationSource(IConventionProperty)

### Description
Returns the ConfigurationSource for the identity start value.

### Method
GET (Conceptual - this is a method call, not a direct HTTP endpoint)

### Endpoint
N/A (Method Extension)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **source** (ConfigurationSource?) - The ConfigurationSource for the identity start value.

#### Response Example
```json
{
  "source": "Convention"
}
```
```

--------------------------------

### NetTopologySuiteDataSourceConfigurationPlugin Constructor

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NetTopologySuiteDataSourceConfigurationPlugin.html

Initializes a new instance of the configuration plugin with singleton options.

```csharp
public NetTopologySuiteDataSourceConfigurationPlugin(INpgsqlNetTopologySuiteSingletonOptions options)__
```

--------------------------------

### Retrieve NpgsqlDbType

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.Mapping.NpgsqlCharacterCharTypeMapping.html

Gets the NpgsqlDbType associated with this mapping.

```csharp
public virtual NpgsqlDbType NpgsqlDbType { get; }__
```

--------------------------------

### NpgsqlDataSource.CreateCommand(string?)

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataSource.html

Creates a command ready for use against this NpgsqlDataSource.

```APIDOC
## Methods
### CreateCommand(string?)
Creates a command ready for use against this NpgsqlDataSource.
```csharp
public NpgsqlCommand CreateCommand(string? commandText = null)
```
#### Parameters
`commandText` string - An optional SQL for the command.
#### Returns
NpgsqlCommand
```

--------------------------------

### GetOrAddPostgresRange Method

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresRange.html

Gets or adds a PostgresRange from or to the IMutableAnnotatable.

```csharp
public static PostgresRange GetOrAddPostgresRange(IMutableAnnotatable annotatable, string? schema, string name, string subtype, string? canonicalFunction = null, string? subtypeOpClass = null, string? collation = null, string? subtypeDiff = null)__
```

--------------------------------

### Constructor: NpgsqlModificationCommandBatchFactory

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Update.Internal.NpgsqlModificationCommandBatchFactory.html

Initializes a new instance of the NpgsqlModificationCommandBatchFactory class.

```APIDOC
## Constructor: NpgsqlModificationCommandBatchFactory

### Description
Initializes a new instance of the NpgsqlModificationCommandBatchFactory class with the required dependencies and database context options.

### Parameters
- **dependencies** (ModificationCommandBatchFactoryDependencies) - Required - The dependencies for the batch factory.
- **options** (IDbContextOptions) - Required - The database context options.
```

--------------------------------

### Constructor: NpgsqlNetTopologySuiteTypeMappingSourcePlugin

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Storage.Internal.NpgsqlNetTopologySuiteTypeMappingSourcePlugin.html

Initializes a new instance of the NpgsqlNetTopologySuiteTypeMappingSourcePlugin class. This is an internal API.

```APIDOC
## Constructor NpgsqlNetTopologySuiteTypeMappingSourcePlugin

### Description
This is an internal API that supports the Entity Framework Core infrastructure and not subject to the same compatibility standards as public APIs. It may be changed or removed without notice in any release. You should only use it directly in your code with extreme caution and knowing that doing so can result in application failures when updating to a new Entity Framework Core release.

```csharp
public NpgsqlNetTopologySuiteTypeMappingSourcePlugin(INpgsqlNetTopologySuiteSingletonOptions options)
```

### Parameters
#### Path Parameters
- **options** (INpgsqlNetTopologySuiteSingletonOptions) - Required - Description
```

--------------------------------

### Access PostgresVersion

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.Internal.NpgsqlOptionsExtension.html

Gets the backend version to target.

```csharp
public virtual Version PostgresVersion { get; }
```

--------------------------------

### TableOID

Source: https://www.npgsql.org/doc/api/Npgsql.Schema.NpgsqlDbColumn.html

Gets the OID of the PostgreSQL table of this column.

```APIDOC
## TableOID

### Description
The OID of the PostgreSQL table of this column.

### Property Value 

`uint`
```

--------------------------------

### Initialize NpgsqlAnnotationProvider

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.Internal.NpgsqlAnnotationProvider.html

Constructor for the NpgsqlAnnotationProvider class requiring RelationalAnnotationProviderDependencies.

```csharp
public NpgsqlAnnotationProvider(RelationalAnnotationProviderDependencies dependencies)__
```

--------------------------------

### Configure OpenTelemetry Tracing

Source: https://www.npgsql.org/doc/diagnostics/tracing.html

Initialize the TracerProvider with Npgsql support and a console exporter to begin capturing trace data.

```csharp
using var tracerProvider = Sdk.CreateTracerProviderBuilder()
    .SetResourceBuilder(ResourceBuilder.CreateDefault().AddService("npgsql-tester"))
    .SetSampler(new AlwaysOnSampler())
    // This optional activates tracing for your application, if you trace your own activities:
    .AddSource("MyApp")
    // This activates up Npgsql's tracing:
    .AddNpgsql()
    // This prints tracing data to the console:
    .AddConsoleExporter()
    .Build();
```

--------------------------------

### PostgresType

Source: https://www.npgsql.org/doc/api/Npgsql.Schema.NpgsqlDbColumn.html

Gets the PostgresType describing the type of this column.

```APIDOC
## PostgresType

### Description
The PostgresType describing the type of this column.

### Property Value 

`PostgresType`
```

--------------------------------

### NpgsqlTsQuery.Kind Property

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlTsQuery.html

Gets the node kind of the tsquery.

```csharp
public NpgsqlTsQuery.NodeKind Kind { get; }
```

--------------------------------

### EnableLTree Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlSlimDataSourceBuilder.html

Sets up mappings for the PostgreSQL ltree extension types. Returns the builder instance for chaining.

```csharp
public NpgsqlSlimDataSourceBuilder EnableLTree()
```

--------------------------------

### Start Logical Replication with Npgsql

Source: https://www.npgsql.org/doc/replication.html

Initiate logical replication using Npgsql, consuming messages from a specified slot and publication.

```csharp
await using var conn = new LogicalReplicationConnection("<connection_string>");
await conn.Open();

var slot = new PgOutputReplicationSlot("blog_slot");

// The following will loop until the cancellation token is triggered, and will print message types coming from PostgreSQL:
var cancellationTokenSource = new CancellationTokenSource();
await foreach (var message in conn.StartReplication(
    slot, new PgOutputReplicationOptions("blog_pub", 1), cancellationTokenSource.Token))
{
    Console.WriteLine($"Received message type: {message.GetType().Name}");

    // Always call SetReplicationStatus() or assign LastAppliedLsn and LastFlushedLsn individually
    // so that Npgsql can inform the server which WAL files can be removed/recycled.
    conn.SetReplicationStatus(message.WalEnd);
}

```

--------------------------------

### Keys

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnectionStringBuilder.html

Gets an ICollection containing the keys of the NpgsqlConnectionStringBuilder.

```APIDOC
## Keys

### Description
Gets an ICollection containing the keys of the NpgsqlConnectionStringBuilder.

### Property Value 

ICollection<string>
```

--------------------------------

### StartReplication(PhysicalReplicationSlot, CancellationToken)

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PhysicalReplicationConnection.html

Starts streaming WAL for physical replication using a specified replication slot. The server streams WAL from the location and timeline ID in the slot. It can return errors if the WAL segment has already been recycled.

```APIDOC
## StartReplication(PhysicalReplicationSlot, CancellationToken)

### Description
Instructs the server to start streaming the WAL for physical replication, starting at the WAL location and timeline id specified in `slot`. The server can reply with an error, for example if the requested section of the WAL has already been recycled.

### Method
`public IAsyncEnumerable<XLogDataMessage> StartReplication(PhysicalReplicationSlot slot, CancellationToken cancellationToken)`

### Parameters
#### Path Parameters
- **slot** (PhysicalReplicationSlot) - Required - The replication slot that will be updated as replication progresses so that the server knows which WAL segments are still needed by the standby. The `slot` must contain a valid RestartLsn to be used for this overload.
- **cancellationToken** (CancellationToken) - Required - The token to be used for stopping the replication.

### Returns
#### Success Response
- **IAsyncEnumerable<XLogDataMessage>** - A Task<TResult> representing an IAsyncEnumerable<T> that can be used to stream WAL entries in form of XLogDataMessage instances.

### Remarks
If the client requests a timeline that's not the latest but is part of the history of the server, the server will stream all the WAL on that timeline starting from the requested start point up to the point where the server switched to another timeline.
```

--------------------------------

### TypeModifier Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.Postgres.Field.html

Gets the type modifier of the field.

```csharp
public int TypeModifier { get; init; }__
```

--------------------------------

### NpgsqlFactory Creation Methods

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlFactory.html

Methods for creating instances of various database provider objects.

```csharp
public override DbBatch CreateBatch()
```

```csharp
public override DbBatchCommand CreateBatchCommand()
```

```csharp
public override DbCommand CreateCommand()
```

```csharp
public override DbCommandBuilder CreateCommandBuilder()
```

```csharp
public override DbConnection CreateConnection()
```

```csharp
public override DbConnectionStringBuilder CreateConnectionStringBuilder()
```

```csharp
public override DbDataAdapter CreateDataAdapter()
```

```csharp
public override DbDataSource CreateDataSource(string connectionString)
```

```csharp
public override DbParameter CreateParameter()
```

--------------------------------

### PgTypeId Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.PgConverterResolution.html

Gets the PgTypeId associated with this resolution.

```APIDOC
## PgTypeId Property

### Description
Gets the PgTypeId associated with this resolution.

### Property Value
(PgTypeId) - The PgTypeId instance.
```

--------------------------------

### Converter Property

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.PgConverterResolution.html

Gets the PgConverter associated with this resolution.

```APIDOC
## Converter Property

### Description
Gets the PgConverter associated with this resolution.

### Property Value
(PgConverter) - The PgConverter instance.
```

--------------------------------

### StartReplication

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.TestDecodingConnectionExtensions.html

Starts streaming WAL for logical replication using the test_decoding plugin. This method can begin streaming from a specific WAL location or the slot's consistent point and returns an asynchronous stream of decoded data.

```APIDOC
## StartReplication

### Description
Instructs the server to start streaming the WAL for logical replication using the test_decoding logical decoding plugin, starting at WAL location `walLocation` or at the slot's consistent point if `walLocation` isn't specified.

### Method
`public static IAsyncEnumerable<TestDecodingData> StartReplication(this LogicalReplicationConnection connection, TestDecodingReplicationSlot slot, CancellationToken cancellationToken, TestDecodingOptions? options = null, NpgsqlLogSequenceNumber? walLocation = null)`

### Parameters
#### Path Parameters
None

#### Query Parameters
None

#### Request Body
None

### Parameters
* `connection` (LogicalReplicationConnection) - The LogicalReplicationConnection to use for starting replication.
* `slot` (TestDecodingReplicationSlot) - The replication slot that will be updated as replication progresses.
* `cancellationToken` (CancellationToken) - The token to monitor for stopping the replication.
* `options` (TestDecodingOptions?) - Optional. The collection of options passed to the slot's logical decoding plugin.
* `walLocation` (NpgsqlLogSequenceNumber?) - Optional. The WAL location to begin streaming at.

### Returns
IAsyncEnumerable<TestDecodingData> - A Task<TResult> representing an IAsyncEnumerable<T> that can be used to stream WAL entries in form of TestDecodingData instances.

### Remarks
See https://www.postgresql.org/docs/current/test-decoding.html for more information.
```

--------------------------------

### Start Test Decoding Replication Stream

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.TestDecodingConnectionExtensions.html

Starts streaming WAL entries for logical replication using the test_decoding plugin. Can begin at a specific WAL location or the slot's consistent point. Handles potential server errors if WAL data has been recycled.

```csharp
public static IAsyncEnumerable<TestDecodingData> StartReplication(this LogicalReplicationConnection connection, TestDecodingReplicationSlot slot, CancellationToken cancellationToken, TestDecodingOptions? options = null, NpgsqlLogSequenceNumber? walLocation = null)
```

--------------------------------

### GetIdentityStartValue

Source: https://www.npgsql.org/efcore/api/Microsoft.EntityFrameworkCore.NpgsqlPropertyExtensions.html

Retrieves the identity start value for a given property.

```APIDOC
## GetIdentityStartValue(IReadOnlyProperty)

### Description
Returns the identity start value.

### Method
GET (Conceptual - this is a method call, not a direct HTTP endpoint)

### Endpoint
N/A (Method Extension)

### Parameters
#### Path Parameters
N/A

#### Query Parameters
N/A

#### Request Body
N/A

### Request Example
N/A

### Response
#### Success Response (200)
- **value** (long?) - The identity start value.

#### Response Example
```json
{
  "value": 1
}
```
```

--------------------------------

### NpgsqlTypeMappingPostprocessor Constructor

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Query.Internal.NpgsqlTypeMappingPostprocessor.html

Initializes a new instance of the NpgsqlTypeMappingPostprocessor class with the required dependencies.

```APIDOC
## Constructor: NpgsqlTypeMappingPostprocessor

### Description
Initializes a new instance of the NpgsqlTypeMappingPostprocessor class. This is an internal API and should be used with caution.

### Parameters
- **dependencies** (QueryTranslationPostprocessorDependencies) - Required
- **relationalDependencies** (RelationalQueryTranslationPostprocessorDependencies) - Required
- **queryCompilationContext** (RelationalQueryCompilationContext) - Required
```

--------------------------------

### BeginRawBinaryCopyAsync

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlConnection.html

Begins a raw binary COPY operation for high-performance data export or import.

```csharp
public Task<NpgsqlRawCopyStream> BeginRawBinaryCopyAsync(string copyCommand, CancellationToken cancellationToken = default)__
```

--------------------------------

### StartedTransaction Event ID

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlEventId.html

Represents the event of starting a transaction.

```csharp
public const int StartedTransaction = 30000
```

--------------------------------

### GetOperator

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Query.Internal.NpgsqlQuerySqlGenerator.html

Gets the SQL operator for a SQL binary operation.

```APIDOC
## GetOperator(SqlBinaryExpression)

### Description
Gets the SQL operator for a SQL binary operation.

### Method
protected override string GetOperator(SqlBinaryExpression e)

### Parameters
#### Path Parameters
- **e** (SqlBinaryExpression) - Required -

### Returns
string - A string representation of the binary operator.
```

--------------------------------

### NpgsqlDatabaseInfo Constructors

Source: https://www.npgsql.org/doc/api/Npgsql.Internal.NpgsqlDatabaseInfo.html

Initializes a new instance of the NpgsqlDatabaseInfo class with provided connection details and version information.

```APIDOC
## NpgsqlDatabaseInfo(string, int, string, Version)

### Description
Initializes the instance of NpgsqlDatabaseInfo.

### Parameters
- **host** (string) - The hostname or IP address of the database.
- **port** (int) - The TCP port of the database.
- **databaseName** (string) - The database name.
- **version** (Version) - The version of the PostgreSQL database.

## NpgsqlDatabaseInfo(string, int, string, Version, string)

### Description
Initializes the instance of NpgsqlDatabaseInfo.

### Parameters
- **host** (string) - The hostname or IP address of the database.
- **port** (int) - The TCP port of the database.
- **databaseName** (string) - The database name.
- **version** (Version) - The version of the PostgreSQL database.
- **serverVersion** (string) - The PostgreSQL version string as returned by the server_version option.
```

--------------------------------

### Prepare Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatch.html

Synchronously creates a prepared version of the batch or its commands on the data source. Use to optimize repeated execution of the same batch.

```csharp
public override void Prepare()__
```

--------------------------------

### Type Information

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Query.Expressions.Internal.PgRegexMatchExpression.html

Methods for getting delegate and action types.

```APIDOC
## Type Information

### Description
Provides methods to obtain delegate and action types based on parameter types.

### Methods

- **Expression.GetActionType(params Type[])**: Gets the type of an `Action` delegate with the specified parameter types.
- **Expression.GetDelegateType(params Type[])**: Gets the type of a delegate with the specified return and parameter types.
- **Expression.GetFuncType(params Type[])**: Gets the type of a `Func` delegate with the specified return and parameter types.
```

--------------------------------

### Initialize PhysicalReplicationConnection with Connection String

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PhysicalReplicationConnection.html

Initializes a new instance of the PhysicalReplicationConnection class with a specified connection string. This allows configuring the connection to the PostgreSQL database.

```csharp
public PhysicalReplicationConnection(string? connectionString)
```

--------------------------------

### GetPostgresRanges Method

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresRange.html

Gets the collection of PostgresRange stored in the IAnnotatable.

```csharp
public static IEnumerable<PostgresRange> GetPostgresRanges(IReadOnlyAnnotatable annotatable)__
```

--------------------------------

### GetPostgresExtensions Method

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresExtension.html

Gets the collection of PostgresExtension stored in the IAnnotatable.

```csharp
public static IEnumerable<PostgresExtension> GetPostgresExtensions(IReadOnlyAnnotatable annotatable)__
```

--------------------------------

### Example dotnet-counters output

Source: https://www.npgsql.org/doc/diagnostics/metrics.html

Sample output showing various Npgsql metrics including bytes read/written and connection pool states.

```text
[Npgsql]
    db.client.operation.npgsql.bytes_read (By / 1 sec)
        db.client.connection.pool.name=CustomersDB                                          1,020
    db.client.operation.npgsql.bytes_written (By / 1 sec)
        db.client.connection.pool.name=CustomersDB                                            710
    db.client.operation.duration (s)
        db.client.connection.pool.name=CustomersDB,Percentile=50                                0.001
        db.client.connection.pool.name=CustomersDB,Percentile=95                                0.001
        db.client.connection.pool.name=CustomersDB,Percentile=99                                0.001
    db.client.operation.npgsql.executing ({command})
        db.client.connection.pool.name=CustomersDB                                              2
    db.client.operation.npgsql.prepared_ratio
        db.client.connection.pool.name=CustomersDB                                              0
    db.client.connection.max ({connection})
        db.client.connection.pool.name=CustomersDB                                            100
    db.client.connection.count ({connection})
        db.client.connection.pool.name=CustomersDB,state=idle                                   3
        db.client.connection.pool.name=CustomersDB,state=used                                   2
```

--------------------------------

### Initialize NpgsqlCommand

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlCommand.html

Initializes a new instance of the NpgsqlCommand class.

```csharp
public NpgsqlCommand()
```

--------------------------------

### Access PostgresEnum Name

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Metadata.PostgresEnum.html

Gets the name of the PostgreSQL enum.

```csharp
public virtual string Name { get; }
```

--------------------------------

### NpgsqlCommand Constructors

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlCommand.html

Initializes a new instance of the NpgsqlCommand class with different configurations.

```APIDOC
## NpgsqlCommand()

### Description
Initializes a new instance of the NpgsqlCommand class.

### Method
Constructor

### Parameters
None

## NpgsqlCommand(string? cmdText)

### Description
Initializes a new instance of the NpgsqlCommand class with the text of the query.

### Method
Constructor

### Parameters
#### Path Parameters
* **cmdText** (string) - Required - The text of the query.

## NpgsqlCommand(string? cmdText, NpgsqlConnection? connection)

### Description
Initializes a new instance of the NpgsqlCommand class with the text of the query and a NpgsqlConnection.

### Method
Constructor

### Parameters
#### Path Parameters
* **cmdText** (string) - Required - The text of the query.
* **connection** (NpgsqlConnection) - Required - A NpgsqlConnection that represents the connection to a PostgreSQL server.

## NpgsqlCommand(string? cmdText, NpgsqlConnection? connection, NpgsqlTransaction? transaction)

### Description
Initializes a new instance of the NpgsqlCommand class with the text of the query, a NpgsqlConnection, and the NpgsqlTransaction.

### Method
Constructor

### Parameters
#### Path Parameters
* **cmdText** (string) - Required - The text of the query.
* **connection** (NpgsqlConnection) - Required - A NpgsqlConnection that represents the connection to a PostgreSQL server.
* **transaction** (NpgsqlTransaction) - Required - The NpgsqlTransaction in which the NpgsqlCommand executes.
```

--------------------------------

### Method: TryGetServiceCharacteristics

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Infrastructure.EntityFrameworkNpgsqlServicesBuilder.html

Gets the ServiceCharacteristics for the given service type.

```APIDOC
## Method TryGetServiceCharacteristics(Type)

Gets the ServiceCharacteristics for the given service type.
```csharp
protected override ServiceCharacteristics? TryGetServiceCharacteristics(Type serviceType)
```

#### Parameters 

`serviceType` Type
    
The type that defines the service API.
#### Returns 

ServiceCharacteristics?
    
The ServiceCharacteristics for the type or null if it's not an EF service.
```

--------------------------------

### Get TrigramsShow

Source: https://www.npgsql.org/efcore/api/Microsoft.EntityFrameworkCore.NpgsqlTrigramsDbFunctionsExtensions.html

Translates to the PostgreSQL show_trgm(text) function.

```csharp
public static string[] TrigramsShow(this DbFunctions _, string text)__
```

--------------------------------

### NpgsqlTid BlockNumber Property

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlTid.html

Gets the block number of the NpgsqlTid.

```csharp
public uint BlockNumber { get; }
```

--------------------------------

### NpgsqlBatch Constructors

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlBatch.html

Initializes a new NpgsqlBatch. You can optionally provide a connection and transaction to associate with the batch.

```APIDOC
## NpgsqlBatch(NpgsqlConnection?, NpgsqlTransaction?)

### Description
Initializes a new NpgsqlBatch.

### Parameters
- **connection** (NpgsqlConnection) - A NpgsqlConnection that represents the connection to a PostgreSQL server.
- **transaction** (NpgsqlTransaction) - The NpgsqlTransaction in which the NpgsqlCommand executes.
```

--------------------------------

### NpgsqlCircle Radius Property

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlCircle.html

Gets or sets the radius of the circle.

```csharp
public double Radius { readonly get; set; }
```

--------------------------------

### Initialize NpgsqlQueryCompilationContextFactory

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.Query.Internal.NpgsqlQueryCompilationContextFactory.html

Constructor for the factory requiring query compilation dependencies.

```csharp
public NpgsqlQueryCompilationContextFactory(QueryCompilationContextDependencies dependencies, RelationalQueryCompilationContextDependencies relationalDependencies)__
```

--------------------------------

### NpgsqlCidr Address Property

Source: https://www.npgsql.org/doc/api/NpgsqlTypes.NpgsqlCidr.html

Gets the IPAddress component of the NpgsqlCidr.

```csharp
public IPAddress Address { get; }
```

--------------------------------

### Explicitly Prepare and Execute SQL

Source: https://www.npgsql.org/doc/prepare.html

Demonstrates preparing a SQL statement on a physical connection. Subsequent calls with the same SQL on the same physical connection will reuse the prepared statement.

```csharp
await using (var conn = await dataSource.OpenConnectionAsync())
await using (var cmd = new NpgsqlCommand("<some_sql>", conn))
{
    await cmd.PrepareAsync();    // First time on this physical connection, Npgsql prepares with PostgreSQL
    await cmd.ExecuteNonQueryAsync();
}

await using (var conn = await dataSource.OpenConnectionAsync())
await using (var cmd = new NpgsqlCommand("<some_sql>", conn))
{
    // We assume the internal connection pool returned the same physical connection used above
    await cmd.PrepareAsync();    // The connection already has a prepared statement for <some_sql>, this doesn't need to do anything
    await cmd.ExecuteNonQueryAsync();
}
```

--------------------------------

### RestartLsn Property

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PhysicalReplicationSlot.html

Gets the replication slot's `restart_lsn`.

```APIDOC
## RestartLsn

### Description
The replication slot's `restart_lsn`.

### Property Value
NpgsqlLogSequenceNumber?
```

--------------------------------

### Construct NpgsqlRetryingExecutionStrategy

Source: https://www.npgsql.org/efcore/api/Npgsql.EntityFrameworkCore.PostgreSQL.NpgsqlRetryingExecutionStrategy.html

Various constructors for initializing the execution strategy with different dependency and configuration options.

```csharp
public NpgsqlRetryingExecutionStrategy(DbContext context)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(DbContext context, int maxRetryCount)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(DbContext context, int maxRetryCount, TimeSpan maxRetryDelay, ICollection<string>? errorCodesToAdd)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(ExecutionStrategyDependencies dependencies)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(ExecutionStrategyDependencies dependencies, ICollection<string>? errorCodesToAdd)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(ExecutionStrategyDependencies dependencies, int maxRetryCount)__
```

```csharp
public NpgsqlRetryingExecutionStrategy(ExecutionStrategyDependencies dependencies, int maxRetryCount, TimeSpan maxRetryDelay, ICollection<string>? errorCodesToAdd)__
```

--------------------------------

### NpgsqlDataAdapter Constructor with Select Command

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataAdapter.html

Initializes a new instance of the NpgsqlDataAdapter class with a specified NpgsqlCommand for selecting data.

```csharp
public NpgsqlDataAdapter(NpgsqlCommand selectCommand)__
```

--------------------------------

### Get Column Name

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PgOutput.ReplicationValue.html

Retrieves the name of the specified column.

```csharp
public string GetFieldName()
```

--------------------------------

### EnableGeometricTypes Method

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlSlimDataSourceBuilder.html

Sets up network mappings for types like NpgsqlPoint and NpgsqlPath to PostgreSQL point, path, etc. Returns the builder instance for chaining.

```csharp
public NpgsqlSlimDataSourceBuilder EnableGeometricTypes()
```

--------------------------------

### PhysicalReplicationSlot RestartLsn Property

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PhysicalReplicationSlot.html

Gets the restart_lsn of the replication slot.

```csharp
public NpgsqlLogSequenceNumber? RestartLsn { get; }
```

--------------------------------

### Initialize LogicalReplicationConnection with Connection String

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.LogicalReplicationConnection.html

Initializes a new instance of the LogicalReplicationConnection class using a provided connection string.

```csharp
public LogicalReplicationConnection(string? connectionString)
```

--------------------------------

### GetValue

Source: https://www.npgsql.org/doc/api/Npgsql.NpgsqlDataReader.html

Gets the value of the specified column as an instance of object.

```APIDOC
## GetValue(int)

### Description
Gets the value of the specified column as an instance of object.

### Method
`object GetValue(int ordinal)`

### Parameters
#### Path Parameters
- **ordinal** (int) - Required - The zero-based column ordinal.

### Returns
#### Success Response
- **object** - The value of the specified column.
```

--------------------------------

### RelationMessage RelationId Property

Source: https://www.npgsql.org/doc/api/Npgsql.Replication.PgOutput.Messages.RelationMessage.html

Gets the unique identifier for the relation.

```csharp
public uint RelationId { get; }
```
Tokens:
Raw