Contents Menu Expand Light mode Dark mode Auto light/dark, in light mode Auto light/dark, in dark mode Skip to content
RelStorage 4.1.2.dev0 documentation
RelStorage 4.1.2.dev0 documentation
  • Getting Started With RelStorage
    • Installation
      • Installing Database Drivers for PostgreSQL
      • Installing Database Drivers for MySQL
      • Installing Database Drivers for Oracle
      • Installing Database Drivers for SQLite
    • Configuring Your Database
      • Setting Up PostgreSQL
      • Setting Up MySQL
      • Setting Up Oracle
      • Setting Up SQLite
    • Configuring ZODB To Use RelStorage
    • Tips and Other Useful Information
    • Use With zodburi
  • Included Command Line Utilities
    • Copying Data Between ZODB Storages: zodbconvert
    • Packing Or Reference Checking A ZODB Storage: zodbpack
  • Supported Databases
    • PostgreSQL
      • Installing Database Drivers for PostgreSQL
      • Setting Up PostgreSQL
      • PostgreSQL Adapter Options
      • Using Connection Pooling (pgBouncer)
    • MySQL
      • Installing Database Drivers for MySQL
      • Setting Up MySQL
      • MySQL Adapter Options
    • Oracle
      • Installing Database Drivers for Oracle
      • Setting Up Oracle
      • Oracle Adapter Options
    • SQLite
      • Installing Database Drivers for SQLite
      • Setting Up SQLite
      • SQLite Adapter Options
      • SQLite FAQ
  • Configuration Reference
    • RelStorage Options
    • Database-Specific Adapter Options
      • PostgreSQL Adapter Options
      • MySQL Adapter Options
      • Oracle Adapter Options
      • SQLite Adapter Options
  • FAQs
    • SQLite FAQ
  • Performance
    • Client Cache Tracing
  • Migrating to a new version of RelStorage
    • Migrating to RelStorage version 3.0
    • Migrating to RelStorage version 1.5
    • Migrating to RelStorage version 1.4.2
    • Migrating to RelStorage version 1.4
    • Migrating from RelStorage version 1.1.1 to version 1.1.2
    • Migrating from RelStorage version 1.1 to version 1.1.1
    • Migrating from RelStorage version 1.0 or 1.0.1 to version 1.1
    • 1.0 Beta Migration
  • Developing RelStorage
    • Running Tests
    • Caching with checkpoints
      • relstorage.cache.interfaces
      • relstorage.cache.local_client
      • relstorage.cache.persistence – Helpers for various disk-based persistent storage format
      • relstorage.cache.storage_cache
      • relstorage.cache.trace
      • relstorage.cache.mvcc – MVCC tracking for cache objects
    • What Happens In A Pack
  • Changes
  • Historical Changes
  • PGStorage history
  • Internal Details
    • relstorage.adapters.adapter – Base class for IRelStorageAdapter
    • relstorage.adapters.batch – Batch table row insert/delete support
    • relstorage.adapters.connections – Connection management for the storage layer
    • relstorage.adapters.connmanager
    • relstorage.adapters.dbiter
    • relstorage.adapters.drivers – Helpers for drivers
    • relstorage.adapters.interfaces – Interfaces provided by RelStorage database adapters
    • relstorage.adapters.locker – Locker implementations
    • relstorage.adapters.mover – IObjectMover implementation
    • relstorage.adapters.mysql.adapter – MySQL adapter for RelStorage
    • relstorage.adapters.mysql.connmanager – MySQL adapter for RelStorage
    • relstorage.adapters.mysql.locker – Locker implementations
    • relstorage.adapters.mysql.mover – IObjectMover implementation
    • relstorage.adapters.mysql.oidallocator – IOIDAllocator implementations
    • relstorage.adapters.mysql.packundo – Pack/Undo implementations
    • relstorage.adapters.mysql.schema – Database schema installers
    • relstorage.adapters.mysql.stats – Stats implementations
    • relstorage.adapters.mysql.txncontrol – TransactionControl implementations
    • relstorage.adapters.oidallocator – IOIDAllocator implementations
    • relstorage.adapters.oracle.adapter – Oracle adapter for RelStorage
    • relstorage.adapters.oracle.batch – Batch table row insert/delete support
    • relstorage.adapters.oracle.connmanager – Oracle adapter for RelStorage
    • relstorage.adapters.oracle.dialect – The Oracle dialect
    • relstorage.adapters.oracle.drivers – Oracle IDBDriver implementations
    • relstorage.adapters.oracle.locker – Locker implementations
    • relstorage.adapters.oracle.mover – IObjectMover implementation
    • relstorage.adapters.oracle.oidallocator – IOIDAllocator implementations
    • relstorage.adapters.oracle.packundo – Pack/Undo implementations
    • relstorage.adapters.oracle.schema – Database schema installers
    • relstorage.adapters.oracle.scriptrunner
    • relstorage.adapters.oracle.stats – Stats implementations
    • relstorage.adapters.oracle.txncontrol – TransactionControl implementations
    • relstorage.adapters.packundo – Pack/Undo implementations
    • relstorage.adapters.poller
    • relstorage.adapters.postgresql.adapter – PostgreSQL adapter for RelStorage
    • relstorage.adapters.postgresql.batch – Batch table row insert/delete support
    • relstorage.adapters.postgresql.connmanager – PostgreSQL adapter for RelStorage
    • relstorage.adapters.postgresql.locker – Locker implementations
    • relstorage.adapters.postgresql.mover – IObjectMover implementation
    • relstorage.adapters.postgresql.oidallocator – IOIDAllocator implementations
    • relstorage.adapters.postgresql.schema – Database schema installers
    • relstorage.adapters.postgresql.stats – Stats implementations
    • relstorage.adapters.postgresql.txncontrol – TransactionControl implementations
    • relstorage.adapters.postgresql.util – PostgreSQL utilities
    • relstorage.adapters.replica
    • relstorage.adapters.schema – Database schema installers
    • relstorage.adapters.scriptrunner
    • relstorage.adapters.sqlite.adapter – sqlite3 adapter for RelStorage
    • relstorage.adapters.sqlite.batch
    • relstorage.adapters.sqlite.connmanager
    • relstorage.adapters.sqlite.dialect – sqlite3 dialect
    • relstorage.adapters.sqlite.drivers
    • relstorage.adapters.sqlite.locker
    • relstorage.adapters.sqlite.mover
    • relstorage.adapters.sqlite.oidallocator – sqlite3 adapter for RelStorage
    • relstorage.adapters.sqlite.poller
    • relstorage.adapters.sqlite.schema
    • relstorage.adapters.sqlite.scriptrunner
    • relstorage.adapters.sqlite.stats
    • relstorage.adapters.sqlite.txncontrol
    • relstorage.adapters.stats – Stats implementations
    • relstorage.adapters.txncontrol – TransactionControl implementations
    • relstorage.cache.interfaces
    • relstorage.cache.local_client
    • relstorage.cache.local_database – The definition of how local cache databases are manipulated
    • relstorage.cache.memcache_client – An implementation of IStateCache using a memcache client
    • relstorage.cache.mvcc – MVCC tracking for cache objects
    • relstorage.cache.persistence – Helpers for various disk-based persistent storage format
    • relstorage.cache.storage_cache
    • relstorage.cache.trace
    • relstorage.config – ZConfig directive implementations for binding RelStorage to Zope
    • relstorage.interfaces – Interfaces for top-level RelStorage components
    • relstorage.options
    • relstorage.pylibmc_wrapper – A wrapper around pylibmc to make it not raise memcache errors
    • relstorage.treemark – OID tree traversal for the garbage collection phase of packing
    • relstorage.zodbconvert – ZODB storage conversion utility
    • relstorage.zodbpack – ZODB storage packing utility
    • relstorage.zodburi_resolver
Back to top
View this page

Developing RelStorage¶

Hacking on RelStorage should generally be done in a virtual environment. Buildout may also be used.

  • Running Tests
  • Caching with checkpoints
  • What Happens In A Pack
Next
Running Tests
Previous
1.0 Beta Migration
Copyright © 2016-2023, RelStorage contributors
Made with Sphinx and @pradyunsg's Furo