pg-purepy
stable

Meta Information

  • Installation
    • Dependencies
  • Changelog
    • 0.9.5 (2023-12-20)
    • 0.9.4 (2023-11-25)
    • 0.9.0 (2023-11-19)
    • 0.8.2 (2023-06-09)
    • 0.8.1 (2022-04-21)
    • 0.8.0 (2022-03-22)
    • 0.7.4 (2021-10-29)
    • 0.7.3 (2021-10-27)
    • 0.7.2 (2021-08-03)
    • 0.7.1 (2021-07-14)
    • 0.7.0
  • Current Support For PostgreSQL Features
    • Currently Supported
    • Plan To Be Supported
    • Won’t Be Supported

API Usage

  • Message Types
    • Base Classes
      • PostgresMessage
      • QueryResultMessage
    • State-related messages
      • ParameterStatus
        • ParameterStatus.name
        • ParameterStatus.value
      • ErrorOrNoticeResponse
        • ErrorOrNoticeResponse.notice
        • ErrorOrNoticeResponse.recoverable
      • ReadyForQuery
        • ReadyForQuery.state
      • ReadyForQueryState
        • ReadyForQueryState.IDLE
        • ReadyForQueryState.IN_TRANSACTION
        • ReadyForQueryState.ERRORED_TRANSACTION
    • Auth-related messages
      • AuthenticationRequest
        • AuthenticationRequest.method
        • AuthenticationRequest.md5_salt
        • AuthenticationRequest.sasl_methods
      • AuthenticationMethod
        • AuthenticationMethod.CLEARTEXT
        • AuthenticationMethod.MD5
        • AuthenticationMethod.SASL
      • BackendKeyData
        • BackendKeyData.pid
        • BackendKeyData.secret_key
      • AuthenticationCompleted
    • Query-related messages
      • ColumnDescription
        • ColumnDescription.name
        • ColumnDescription.table_oid
        • ColumnDescription.column_index
        • ColumnDescription.type_oid
        • ColumnDescription.column_length
        • ColumnDescription.type_modifier
      • RowDescription
        • RowDescription.columns
      • DataRow
        • DataRow.description
        • DataRow.data
        • DataRow.to_dict()
      • CommandComplete
        • CommandComplete.tag
        • CommandComplete.row_count
      • ParseComplete
      • ParameterDescription
        • ParameterDescription.oids
      • PreparedStatementInfo
        • PreparedStatementInfo.name
        • PreparedStatementInfo.parameter_oids
        • PreparedStatementInfo.row_description
      • BindComplete
  • Low-Level API
    • Creation
      • SansIOClient
        • SansIOClient.__init__()
        • SansIOClient.encoding
        • SansIOClient.timezone
        • SansIOClient.dead
    • Doing… Stuff
    • The Ready Loop
      • SansIOClient.ready
      • pg_purepy.NO_DATA
      • SansIOClient.next_event()
      • SansIOClient.get_needed_synchronisation()
      • SansIOClient.receive_bytes()
    • Sending Commands
      • Startup
        • SansIOClient.do_startup()
      • Simple Queries
        • SansIOClient.do_simple_query()
      • Extended Queries
        • SansIOClient.do_create_prepared_statement()
        • SansIOClient.do_bind_execute()
      • Termination
        • SansIOClient.do_terminate()
      • Internal State
        • SansIOClient.state
        • ProtocolState
  • Asynchronous connection API
    • Connecting
      • open_database_connection()
      • AsyncPostgresConnection
        • AsyncPostgresConnection.ready
        • AsyncPostgresConnection.in_transaction
        • AsyncPostgresConnection.dead
        • AsyncPostgresConnection.connection_parameters
        • AsyncPostgresConnection.server_timezone
    • Querying
    • Querying, Eagerly
      • AsyncPostgresConnection.fetch()
      • AsyncPostgresConnection.execute()
      • AsyncPostgresConnection.fetch_one()
    • Querying, Lazily
      • AsyncPostgresConnection.query()
      • QueryResult
        • QueryResult.row_count()
    • Paramaterised Queries
    • Low-level querying
      • AsyncPostgresConnection.lowlevel_query()
    • Error handling
      • BaseDatabaseError
      • RecoverableDatabaseError
      • UnrecoverableDatabaseError
    • Transaction Helpers
      • AsyncPostgresConnection.with_transaction()
  • High-level API
    • Pooling
    • Connecting
      • pool.open_pool()
      • PooledDatabaseInterface
        • PooledDatabaseInterface.max_connections
        • PooledDatabaseInterface.idle_connections
        • PooledDatabaseInterface.waiting_tasks
    • Querying
      • PooledDatabaseInterface.execute()
      • PooledDatabaseInterface.fetch()
      • PooledDatabaseInterface.fetch_one()
    • Transactions
      • PooledDatabaseInterface.checkout_in_transaction()
    • Converters
      • PooledDatabaseInterface.add_converter()
      • PooledDatabaseInterface.add_converter_with_array()
    • Cancellation
  • Converting Arguments and Results
    • Built-in converters
      • “Fundamental” built-in types
      • Date/Time types
      • Enumeration types
        • EnumConverter
      • Array Types
        • ArrayConverter
      • hstore
    • Custom Converters
      • Converter
        • Converter.oid
        • Converter.from_postgres()
        • Converter.to_postgres()
      • ConversionContext
        • ConversionContext.client_encoding
        • ConversionContext.timezone
      • AsyncPostgresConnection.add_converter()
      • SansIOClient.add_converter()
pg-purepy
  • Search

© Copyright 2021-2023, Lura Skye. Revision 4e0cd3be.

Built with Sphinx using a theme provided by Read the Docs.