/*
 * Copyright (c) 2016, PostgreSQL Global Development Group
 * See the LICENSE file in the project root for more information.
 */

package org.postgresql.replication.fluent.logical;

import org.postgresql.replication.PGReplicationStream;
import org.postgresql.replication.fluent.ChainedCommonStreamBuilder;

import java.sql.SQLException;
import java.util.Properties;

public interface ChainedLogicalStreamBuilder
    extends ChainedCommonStreamBuilder<ChainedLogicalStreamBuilder> {
  
Open logical replication stream.
Throws:
SQLException –  if there are errors
Returns:
not null PGReplicationStream available for fetch data in logical form/**
   * Open logical replication stream.
   *
   * @return not null PGReplicationStream available for fetch data in logical form
   * @throws SQLException  if there are errors
   */
  PGReplicationStream start() throws SQLException;

  
Params:
optionName – name of option
optionValue – boolean value
Returns:
ChainedLogicalStreamBuilder/**
   *
   * @param optionName name of option
   * @param optionValue boolean value
   * @return ChainedLogicalStreamBuilder
   */

  ChainedLogicalStreamBuilder withSlotOption(String optionName, boolean optionValue);

  
Params:
optionName – name of option
optionValue – integer value
Returns:
ChainedLogicalStreamBuilder/**
   *
   * @param optionName name of option
   * @param optionValue integer value
   * @return ChainedLogicalStreamBuilder
   */
  ChainedLogicalStreamBuilder withSlotOption(String optionName, int optionValue);

  
Params:
optionName – name of option
optionValue – String value
Returns:
ChainedLogicalStreamBuilder/**
   *
   * @param optionName name of option
   * @param optionValue String value
   * @return ChainedLogicalStreamBuilder
   */
  ChainedLogicalStreamBuilder withSlotOption(String optionName, String optionValue);

  
Params:
options – properties
Returns:
ChainedLogicalStreamBuilder/**
   *
   * @param options properties
   * @return ChainedLogicalStreamBuilder
   */
  ChainedLogicalStreamBuilder withSlotOptions(Properties options);

}