dev-npgsql/npgsql: Npgsql is the .NET data provider for PostgreSQL.

src/Npgsql/Replication/ReplicationSlotOptions.cs

61 строка2 KB

Brar Piening

Implement the PostgreSQL Streaming Replication Protocol

08 ноя 2020, 22:16

08 ноя 2020, 22:165a3b020

using JetBrains.Annotations;
using NpgsqlTypes;
using System;

namespace Npgsql.Replication
{
    /// <summary>
    /// Contains information about a replication slot.
    /// </summary>
    public readonly struct ReplicationSlotOptions
    {
        /// <summary>
        /// Creates a new <see cref="ReplicationSlotOptions"/> instance.
        /// </summary>
        /// <param name="slotName">
        /// The name of the replication slot.
        /// </param>
        /// <param name="consistentPoint">
        /// The WAL location at which the slot became consistent.
        /// </param>
        public ReplicationSlotOptions(string slotName, string? consistentPoint = null)
            : this(slotName, consistentPoint is null ? default : NpgsqlLogSequenceNumber.Parse(consistentPoint), null){}

        /// <summary>
        /// Creates a new <see cref="ReplicationSlotOptions"/> instance.
        /// </summary>
        /// <param name="slotName">
        /// The name of the replication slot.
        /// </param>
        /// <param name="consistentPoint">
        /// The WAL location at which the slot became consistent.
        /// </param>
        public ReplicationSlotOptions(string slotName, NpgsqlLogSequenceNumber consistentPoint)
            : this(slotName, consistentPoint, null) {}

        internal ReplicationSlotOptions(
            string slotName,
            NpgsqlLogSequenceNumber consistentPoint,
            string? snapshotName)
        {
            SlotName = slotName ?? throw new ArgumentNullException(nameof(slotName), "The replication slot name cannot be null.");
            ConsistentPoint = consistentPoint;
            SnapshotName = snapshotName;
        }

        /// <summary>
        /// The name of the replication slot.
        /// </summary>
        public string SlotName { get; }

        /// <summary>
        /// The WAL location at which the slot became consistent.
        /// </summary>
        public NpgsqlLogSequenceNumber ConsistentPoint { get; }

        /// <summary>
        /// The identifier of the snapshot exported by the CREATE_REPLICATION_SLOT command.
        /// </summary>
        internal string? SnapshotName { get; }
    }
}