psycodict

psycodict is a dictionary-based Python interface to PostgreSQL databases: queries are Python dictionaries, results come back as Python values, and the metadata that makes this ergonomic — column types, sort orders, statistics — is managed for you. It was extracted from the LMFDB and powers several mathematical databases.

The guides below describe the system top-down; the API reference is generated from the docstrings.

Guides

• Getting started
  • Install
  • Quickstart
  • Features
  • Documentation
  • Supported versions
  • Setting up PostgreSQL
  • Running the tests
  • Provenance
• The query language
  • Introduction
  • Overall structure
  • Examples
  • Column constraints
  • Column part specifiers
  • Top-level special keys
  • Lower-level special keys
  • Comparing columns: the $col special key
  • The $raw special key
  • Joined queries
  • Typecasts
• Searching
  • Stability
  • Contents
  • search
  • lucky, lookup, exists, label_exists
  • random and random_sample
  • Counts and statistics
  • Joins
  • Result-value semantics
• Data management
  • Introduction
  • Creating tables
  • Row-level writes
  • Bulk file operations
  • Statistics and counts
  • Operational tips
• Metadata formats
  • Format history
  • The stamp
  • Connecting across formats
  • Migrating
  • Exported metadata files
  • Checklist: changing the metadata format
• Versioning and API stability
  • What is public
  • What is not covered
  • Database metadata compatibility
  • Deprecation policy
  • Python and PostgreSQL support

Reference

• API reference
  • psycodict.database
  • psycodict.searchtable
  • psycodict.table
  • psycodict.statstable
  • psycodict.encoding
  • psycodict.config
  • psycodict.utils
  • psycodict.notifications
  • psycodict.dbdiff
  • psycodict.slowlog
  • psycodict.base

Project

• Contributing
• Security policy