io.r2dbc.postgresql.replication.ReplicationSlot Maven / Gradle / Ivy

Go to download
/*
 * Copyright 2019-2020 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package io.r2dbc.postgresql.replication;

import reactor.util.annotation.Nullable;

/**
 * Information returned on replication slot creation.
 *
 * Returned keys of CREATE_REPLICATION_SLOT:
 * 

 * slot_name String {@code =>} the slot name
 * 
consistent_point String {@code =>} LSN at which we became consistent
 * 
snapshot_name String {@code =>} exported snapshot's name (may be {@code null})
 * 
output_plugin String {@code =>} output plugin (may be {@code null})
 * 
 */
public final class ReplicationSlot {

    private final String slotName;

    private final ReplicationType replicationType;

    private final LogSequenceNumber consistentPoint;

    @Nullable
    private final String snapshotName;

    @Nullable
    private final String outputPlugin;

    public ReplicationSlot(String slotName, ReplicationType replicationType,
                           LogSequenceNumber consistentPoint, @Nullable String snapshotName, @Nullable String outputPlugin) {
        this.slotName = slotName;
        this.replicationType = replicationType;
        this.consistentPoint = consistentPoint;
        this.snapshotName = snapshotName;
        this.outputPlugin = outputPlugin;
    }

    /**
     * Returns the replication slot name.
     *
     * @return the slot name
     */
    public String getSlotName() {
        return this.slotName;
    }

    /**
     * Replication type of the slot created, {@code PHYSICAL} or {@code LOGICAL}.
     *
     * @return {@link ReplicationType}, {@code PHYSICAL} or {@code LOGICAL}
     */
    public ReplicationType getReplicationType() {
        return this.replicationType;
    }

    /**
     * Returns the {@link LogSequenceNumber LSN} at which we became consistent.
     *
     * @return {@link LogSequenceNumber} at {@code consistent_point}
     */
    public LogSequenceNumber getConsistentPoint() {
        return this.consistentPoint;
    }

    /**
     * Returns the exported snapshot name at the point of replication slot creation.
     *
     * As long as the exporting transaction remains open, other transactions can import its snapshot,
     * and thereby be guaranteed that they see exactly the same view of the database that the first
     * transaction sees.
     *
     * @return exported {@code snapshot_name}
     */
    @Nullable
    public String getSnapshotName() {
        return this.snapshotName;
    }

    /**
     * Returns the output plugin used on slot creation.
     *
     * @return the output plugin used on slot creation
     */
    @Nullable
    public String getOutputPlugin() {
        return this.outputPlugin;
    }

}