peewee

Peewee is a simple and small ORM. It has few (but expressive) concepts, making it easy to learn and intuitive to use.

• a small, expressive ORM
• python 2.7+ and 3.4+ (developed with 3.6)
• supports sqlite, mysql, postgresql and cockroachdb

Peewee’s source code hosted on GitHub.

• Example twitter app
• Models and fields
• Relationships and joins

• • Installing with git
  • Optional dependencies
• Quickstart
  • Storing data
  • Database
• Example app
  • Diving into the code
• Using Peewee Interactively
• • Patches
  • Questions
• • Initializing a Database
  • Using CockroachDB
  • Using MySQL
  • Run-time database configuration
  • Setting the database at run-time
  • Connection Management
  • Testing Peewee Applications
  • Framework Integration
  • Managing Transactions
  • Logging queries
• • Fields
  • Model options and table metadata
  • Primary Keys, Composite Keys and other Tricks
  • Circular foreign key dependencies
• • Creating a new record
  • Updating existing records
  • Deleting records
  • Create or get
  • Filtering records
  • Getting random records
  • Counting records
  • Retrieving Scalar Values
  • Retrieving row tuples / dictionaries / namedtuples
  • Common Table Expressions
• Query operators
  • Adding user-defined operators
  • SQL Functions
  • Security and SQL Injection
• • Model definitions
  • Joining multiple tables
  • Subqueries
  • Joining on arbitrary fields
  • Implementing Many to Many
• API Documentation
  • Query-builder
  • Schema Manager
  • Constants and Helpers
• • Getting started
  • Additional Features
• • Sqlite Extensions
  • Sqlite User-Defined Functions
  • Sqlcipher backend
  • Cockroach Database
  • DataSet
  • Hybrid Attributes
  • Shortcuts
  • pwiz, a model generator
  • Reflection
  • Connection pool
  • Flask Utils
• • Model Definitions
  • Basic Exercises
  • Modifying Data
  • Recursion
• • Declaring tables
  • Insert queries
  • Delete queries
  • More
• • Optimistic Locking
  • Top N objects per group
  • Date math
• • Backwards-incompatible

Note

If you find any bugs, odd behavior, or have an idea for a new feature please don’t hesitate to on GitHub or contact me.

Indices and tables

• Index