Method run

pgcli/pgexecute.py:317–427

Execute the sql in the database and return the results. :param statement: A string containing one or more sql statements :param pgspecial: PGSpecial object :param exception_formatter: A callable that accepts an Exception and returns a formatted (title, rows, h

(
        self,
        statement,
        pgspecial=None,
        exception_formatter=None,
        on_error_resume=False,
        explain_mode=False,
    )

        return ""

    def run(
        self,
        statement,
        pgspecial=None,
        exception_formatter=None,
        on_error_resume=False,
        explain_mode=False,
    ):
        """Execute the sql in the database and return the results.

        :param statement: A string containing one or more sql statements
        :param pgspecial: PGSpecial object
        :param exception_formatter: A callable that accepts an Exception and
               returns a formatted (title, rows, headers, status) tuple that can
               act as a query result. If an exception_formatter is not supplied,
               psycopg2 exceptions are always raised.
        :param on_error_resume: Bool. If true, queries following an exception
               (assuming exception_formatter has been supplied) continue to
               execute.

        :return: Generator yielding tuples containing
                 (title, rows, headers, status, query, success, is_special)
        """

        # Remove spaces and EOL
        statement = statement.strip()
        if not statement:  # Empty string
            yield None, None, None, None, statement, False, False

        # sql parse doesn't split on a comment first + special
        # so we're going to do it

        removed_comments = []
        sqlarr = []
        cleaned_command = ""

        # could skip if statement doesn't match ^-- or ^/*
        cleaned_command, removed_comments = remove_beginning_comments(statement)

        sqlarr = sqlparse.split(cleaned_command)

        # now re-add the beginning comments if there are any, so that they show up in
        # log files etc when running these commands

        if len(removed_comments) > 0:
            sqlarr = removed_comments + sqlarr

        # run each sql query
        for sql in sqlarr:
            # Remove spaces, eol and semi-colons.
            # Strip comments first so rstrip(";") works when there are
            # trailing comments after the semicolon, e.g.:
            #   vacuum freeze verbose t; -- 82% towards emergency
            sql = sqlparse.format(sql, strip_comments=True).strip().rstrip(";")
            sql = sql.strip()
            if not sql:
                continue
            try: