Table of Contents

• Postgres Cluster Support in Python
  • Quick installation
  • Support
  • Project name
• pgtoolkit.conf
  • API Reference
    • parse()
    • parse_string()
    • Configuration
      • Configuration.path
      • Configuration.edit()
      • Configuration.save()
    • ParseError
  • Using as a CLI Script
• pgtoolkit.hba
  • API Reference
    • parse()
    • HBA
      • HBA.lines
      • HBA.path
      • HBA.__iter__()
      • HBA.parse()
      • HBA.save()
      • HBA.remove()
      • HBA.merge()
    • HBARecord
      • HBARecord.parse()
      • HBARecord.__init__()
      • HBARecord.__str__()
      • HBARecord.matches()
      • HBARecord.database
      • HBARecord.user
  • Examples
  • Using as a script
• pgtoolkit.log
  • Configuration
  • Performance
  • Limitations
  • API Reference
    • parse()
    • LogParser
    • PrefixParser
      • PrefixParser.from_configuration()
    • Record
      • Record.as_dict()
      • Record.prefix
      • Record.severity
      • Record.message_type
      • Record.raw_lines
      • Record.message_lines
      • Record.application_name
      • Record.command_tag
      • Record.database
      • Record.epoch
      • Record.error
      • Record.line_num
      • Record.pid
      • Record.remote_host
      • Record.remote_port
      • Record.session
      • Record.start
      • Record.timestamp
      • Record.user
      • Record.virtual_xid
      • Record.xid
    • UnknownData
      • UnknownData.lines
    • NoopFilters
      • NoopFilters.stage1()
      • NoopFilters.stage2()
      • NoopFilters.stage3()
  • Example
  • Using pgtoolkit.log as a script
• pgtoolkit.pgpass
  • parse()
  • edit()
  • PassEntry
    • PassEntry.parse()
    • PassEntry.matches()
    • PassEntry.hostname
    • PassEntry.port
    • PassEntry.database
    • PassEntry.username
    • PassEntry.password
  • PassComment
    • PassComment.matches()
    • PassComment.comment
  • PassFile
    • PassFile.parse()
    • PassFile.__iter__()
    • PassFile.sort()
    • PassFile.save()
    • PassFile.remove()
    • PassFile.lines
    • PassFile.path
  • Editing a .pgpass file
  • Using as a script
• pgtoolkit.service
  • API Reference
    • find()
    • parse()
    • Service
    • ServiceFile
      • ServiceFile.add()
      • ServiceFile.parse()
      • ServiceFile.save()
      • ServiceFile.path
  • Edit a service file
  • Load a service file to connect with psycopg2
  • Using as a script
• pgtoolkit.ctl
  • API Reference
    • PGCtl
      • PGCtl.controldata()
      • PGCtl.init()
      • PGCtl.reload()
      • PGCtl.restart()
      • PGCtl.start()
      • PGCtl.status()
      • PGCtl.stop()
    • AsyncPGCtl
      • AsyncPGCtl.get()
    • Status
      • Status.not_running
      • Status.running
      • Status.unspecified_datadir
    • run_command()
    • asyncio_run_command()
    • CommandRunner
      • CommandRunner.__call__()
    • AsyncCommandRunner
      • AsyncCommandRunner.__call__()