Mar 12, 2025 · Mar 12, 2025 · Mar 13, 2025 · Mar 13, 2025 · Mar 13, 2025 · Mar 14, 2025
diff --git a/testgres/node_base.py b/testgres/node_base.py

    def __init__(self, os_ops: OsOperations, name=None, port=None, bin_dir=None, prefix=None):
        """
 PostgresNode constructor.
 PostgresNode_Base constructor.

        Args:
            os_ops: OS operations object.
            name: node's application name.
            port: port to accept connections.
            bin_dir: path to node's binary directory.
            allow_streaming: should this node add a hba entry for replication?

        Returns:
            This instance of :class:`.PostgresNode`
            This instance of :class:`.PostgresNode_Base`
        """

        # initialize this PostgreSQL node
            log_statement: one of ('all', 'off', 'mod', 'ddl').

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        postgres_conf = os.path.join(self.data_dir, PG_CONF_FILE)
            **kwargs: named config options.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.

        Examples:
            >>> append_conf(fsync=False)
            wait: wait until operation completes.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        assert __class__._C_MAX_START_ATEMPTS > 1
            wait: If True, waits until the operation is complete. Defaults to True.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """
        if not self.is_started:
            return self
            params: additional arguments for pg_ctl.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        _params = [
            params: additional arguments for pg_ctl.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        _params = [
        needed.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        _params = [
            full: clean full base dir

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        self._try_shutdown(max_attempts)
        """
        Set standby synchronization options. This corresponds to
        `synchronous_standby_names <https://www.postgresql.org/docs/current/static/runtime-config-replication.html#GUC-SYNCHRONOUS-STANDBY-NAMES>`_
        option. Note that :meth:`~.PostgresNode.reload` or
        :meth:`~.PostgresNode.restart` is needed for changes to take place.
        option. Note that :meth:`~.PostgresNode_Base.reload` or
        :meth:`~.PostgresNode_Base.restart` is needed for changes to take place.

        Args:
            standbys: either :class:`.First` or :class:`.Any` object specifying
                synchronization parameters or just a plain list of
                :class:`.PostgresNode`s replicas which would be equivalent
                :class:`.PostgresNode_Base`s replicas which would be equivalent
                to passing ``First(1, <list>)``. For PostgreSQL 9.5 and below
                it is only possible to specify a plain list of standbys as
                `FIRST` and `ANY` keywords aren't supported.
        Sets initialize=True.

        Returns:
            This instance of :class:`.PostgresNode`.
            This instance of :class:`.PostgresNode_Base`.
        """

        self.pgbench_run(initialize=True, **kwargs)
        Upgrade this node from an old node using pg_upgrade.

        Args:
            old_node:An instance ofPostgresNode representing the old node.
            old_node:A result ofcommand operation.
        """
        if not os.path.exists(old_node.data_dir):
            raise Exception("Old node must be initialized")
Original file line number	Diff line number	Diff line change
Expand Up		@@ -129,9 +129,10 @@ class PostgresNode_Base(object):

		def __init__(self, os_ops: OsOperations, name=None, port=None, bin_dir=None, prefix=None):
		"""
		PostgresNode constructor.
		PostgresNode_Base constructor.

		Args:
		os_ops: OS operations object.
		name: node's application name.
		port: port to accept connections.
		bin_dir: path to node's binary directory.
Expand DownExpand Up		@@ -648,7 +649,7 @@ def init(self, initdb_params=None, cached=True, **kwargs):
		allow_streaming: should this node add a hba entry for replication?

		Returns:
		This instance of :class:`.PostgresNode`
		This instance of :class:`.PostgresNode_Base`
		"""

		# initialize this PostgreSQL node
Expand DownExpand Up		@@ -682,7 +683,7 @@ def default_conf(self,
		log_statement: one of ('all', 'off', 'mod', 'ddl').

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		postgres_conf = os.path.join(self.data_dir, PG_CONF_FILE)
Expand DownExpand Up		@@ -779,7 +780,7 @@ def append_conf(self, line='', filename=PG_CONF_FILE, **kwargs):
		**kwargs: named config options.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.

		Examples:
		>>> append_conf(fsync=False)
Expand DownExpand Up		@@ -916,7 +917,7 @@ def start(self, params=[], wait=True):
		wait: wait until operation completes.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		assert __class__._C_MAX_START_ATEMPTS > 1
Expand DownExpand Up		@@ -1009,7 +1010,7 @@ def stop(self, params=[], wait=True):
		wait: If True, waits until the operation is complete. Defaults to True.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""
		if not self.is_started:
		return self
Expand DownExpand Up		@@ -1051,7 +1052,7 @@ def restart(self, params=[]):
		params: additional arguments for pg_ctl.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		_params = [
Expand DownExpand Up		@@ -1083,7 +1084,7 @@ def reload(self, params=[]):
		params: additional arguments for pg_ctl.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		_params = [
Expand All		@@ -1104,7 +1105,7 @@ def promote(self, dbname=None, username=None):
		needed.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		_params = [
Expand DownExpand Up		@@ -1173,7 +1174,7 @@ def cleanup(self, max_attempts=3, full=False):
		full: clean full base dir

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		self._try_shutdown(max_attempts)
Expand DownExpand Up		@@ -1534,13 +1535,13 @@ def set_synchronous_standbys(self, standbys):
		"""
		Set standby synchronization options. This corresponds to
		`synchronous_standby_names <https://www.postgresql.org/docs/current/static/runtime-config-replication.html#GUC-SYNCHRONOUS-STANDBY-NAMES>`_
		option. Note that :meth:`~.PostgresNode.reload` or
		:meth:`~.PostgresNode.restart` is needed for changes to take place.
		option. Note that :meth:`~.PostgresNode_Base.reload` or
		:meth:`~.PostgresNode_Base.restart` is needed for changes to take place.

		Args:
		standbys: either :class:`.First` or :class:`.Any` object specifying
		synchronization parameters or just a plain list of
		:class:`.PostgresNode`s replicas which would be equivalent
		:class:`.PostgresNode_Base`s replicas which would be equivalent
		to passing ``First(1, <list>)``. For PostgreSQL 9.5 and below
		it is only possible to specify a plain list of standbys as
		`FIRST` and `ANY` keywords aren't supported.
Expand DownExpand Up		@@ -1700,7 +1701,7 @@ def pgbench_init(self, **kwargs):
		Sets initialize=True.

		Returns:
		This instance of :class:`.PostgresNode`.
		This instance of :class:`.PostgresNode_Base`.
		"""

		self.pgbench_run(initialize=True, **kwargs)
Expand DownExpand Up		@@ -1915,7 +1916,7 @@ def upgrade_from(self, old_node, options=None, expect_error=False):
		Upgrade this node from an old node using pg_upgrade.

		Args:
		old_node:An instance ofPostgresNode representing the old node.
		old_node:A result ofcommand operation.
		"""
		if not os.path.exists(old_node.data_dir):
		raise Exception("Old node must be initialized")
Expand Down