- Installing and Testing
- Quickstart
- Example app
- Using Peewee Interactively
- Contributing
- Database
- Initializing a Database
- Using Postgresql
- Using SQLite
- Using MariaDB
- Using MySQL
- Connecting using a Database URL
- Run-time database configuration
- Dynamically defining a database
- Setting the database at run-time
- Thread-Safety and Multiple Databases
- Connection Management
- Connection Pooling
- Testing Peewee Applications
- Async with Gevent
- Framework Integration
- Executing Queries
- Managing Transactions
- Database Errors
- Logging queries
- Adding a new Database Driver
- Models and Fields
- Querying
- Creating a new record
- Bulk inserts
- Updating existing records
- Atomic updates
- Deleting records
- Selecting a single record
- Create or get
- Selecting multiple records
- Filtering records
- Sorting records
- Getting random records
- Paginating records
- Counting records
- Aggregating records
- Retrieving Scalar Values
- Window functions
- Retrieving row tuples / dictionaries / namedtuples
- Returning Clause
- Common Table Expressions
- Foreign Keys and Joins
- Query operators
- Relationships and Joins
- API Documentation
- Database
DatabaseDatabase.init()Database.__enter__()Database.connection_context()Database.connect()Database.close()Database.is_closed()Database.connection()Database.cursor()Database.execute_sql()Database.execute()Database.last_insert_id()Database.rows_affected()Database.in_transaction()Database.atomic()Database.manual_commit()Database.session_start()Database.session_commit()Database.session_rollback()Database.transaction()Database.savepoint()Database.begin()Database.commit()Database.rollback()Database.batch_commit()Database.table_exists()Database.get_tables()Database.get_indexes()Database.get_columns()Database.get_primary_keys()Database.get_foreign_keys()Database.get_views()Database.sequence_exists()Database.create_tables()Database.drop_tables()Database.bind()Database.bind_ctx()Database.extract_date()Database.truncate_date()Database.random()
SqliteDatabaseSqliteDatabase.pragma()SqliteDatabase.cache_sizeSqliteDatabase.foreign_keysSqliteDatabase.journal_modeSqliteDatabase.journal_size_limitSqliteDatabase.mmap_sizeSqliteDatabase.page_sizeSqliteDatabase.read_uncommittedSqliteDatabase.synchronousSqliteDatabase.wal_autocheckpointSqliteDatabase.timeoutSqliteDatabase.register_aggregate()SqliteDatabase.aggregate()SqliteDatabase.register_collation()SqliteDatabase.collation()SqliteDatabase.register_function()SqliteDatabase.func()SqliteDatabase.register_window_function()SqliteDatabase.window_function()SqliteDatabase.table_function()SqliteDatabase.unregister_aggregate()SqliteDatabase.unregister_collation()SqliteDatabase.unregister_function()SqliteDatabase.unregister_table_function()SqliteDatabase.load_extension()SqliteDatabase.attach()SqliteDatabase.detach()SqliteDatabase.atomic()SqliteDatabase.transaction()
PostgresqlDatabaseMySQLDatabase
- Query-builder
NodeSourceBaseTableTableJoinValuesListCTEColumnBaseColumnAliasNegatedValueAsIs()CastOrderingAsc()Desc()ExpressionEntitySQLCheck()Functionfn()WindowCase()NodeListCommaNodeList()EnclosedNodeList()DQTupleOnConflictEXCLUDEDBaseQueryRawQueryQuerySelectQuerySelectBaseCompoundSelectQuerySelect_WriteQueryUpdateInsertDeleteIndexModelIndex
- Fields
FieldIntegerFieldBigIntegerFieldSmallIntegerFieldAutoFieldBigAutoFieldIdentityFieldFloatFieldDoubleFieldDecimalFieldCharFieldFixedCharFieldTextFieldBlobFieldBitFieldBigBitFieldUUIDFieldBinaryUUIDFieldDateTimeFieldDateFieldTimeFieldTimestampFieldIPFieldBooleanFieldBareFieldForeignKeyFieldDeferredForeignKeyManyToManyFieldDeferredThroughModelCompositeKey
- Schema Manager
- Model
MetadataSubclassAwareMetadataModelModel.alias()Model.select()Model.update()Model.insert()Model.insert_many()Model.insert_from()Model.replace()Model.replace_many()Model.raw()Model.delete()Model.create()Model.bulk_create()Model.bulk_update()Model.get()Model.get_or_none()Model.get_by_id()Model.set_by_id()Model.delete_by_id()Model.get_or_create()Model.filter()Model.get_id()Model.save()Model.dirty_fieldsModel.is_dirty()Model.delete_instance()Model.bind()Model.bind_ctx()Model.table_exists()Model.create_table()Model.drop_table()Model.truncate_table()Model.index()Model.add_index()Model.dependencies()Model.__iter__()Model.__len__()
ModelAliasModelSelectprefetch()
- Query-builder Internals
- Constants and Helpers
- Database
- SQLite Extensions
- Playhouse, extensions to Peewee
- Sqlite Extensions
- SqliteQ
- Sqlite User-Defined Functions
- Functions, listed by collection name
if_then_else()strip_tz()humandelta()mintdiff()avgtdiff()duration()date_series()file_ext()file_read()gzip()gunzip()hostname()toggle()setting()clear_toggles()clear_settings()randomrange()gauss_distribution()sqrt()tonumber()mode()minrange()avgrange()range()median()substr_count()strip_chars()damerau_levenshtein_dist()levenshtein_dist()str_dist()regex_search()
- Functions, listed by collection name
- apsw, an advanced sqlite driver
- Sqlcipher backend
- Postgresql Extensions
- Cockroach Database
- MySQL Extensions
- DataSet
- Fields
- Hybrid Attributes
- Key/Value Store
- Shortcuts
- Signal support
- pwiz, a model generator
- Schema Migrations
- Example usage
- Supported Operations
- Migrations API
migrate()SchemaMigratorSchemaMigrator.add_column()SchemaMigrator.drop_column()SchemaMigrator.rename_column()SchemaMigrator.add_not_null()SchemaMigrator.drop_not_null()SchemaMigrator.add_column_default()SchemaMigrator.drop_column_default()SchemaMigrator.alter_column_type()SchemaMigrator.rename_table()SchemaMigrator.add_index()SchemaMigrator.drop_index()SchemaMigrator.add_constraint()SchemaMigrator.drop_constraint()SchemaMigrator.add_unique()
PostgresqlMigratorSqliteMigratorMySQLMigrator
- Reflection
- Database URL
- Connection pool
- Test Utils
- Flask Utils
- Query Examples
- Model Definitions
- Schema Creation
- Basic Exercises
- Retrieve everything
- Retrieve specific columns from a table
- Control which rows are retrieved
- Control which rows are retrieved - part 2
- Basic string searches
- Matching against multiple possible values
- Classify results into buckets
- Working with dates
- Removing duplicates, and ordering results
- Combining results from multiple queries
- Simple aggregation
- More aggregation
- Joins and Subqueries
- Retrieve the start times of members’ bookings
- Work out the start times of bookings for tennis courts
- Produce a list of all members who have recommended another member
- Produce a list of all members, along with their recommender
- Produce a list of all members who have used a tennis court
- Produce a list of costly bookings
- Produce a list of all members, along with their recommender, using no joins.
- Produce a list of costly bookings, using a subquery
- Modifying Data
- Insert some data into a table
- Insert multiple rows of data into a table
- Insert calculated data into a table
- Update some existing data
- Update multiple rows and columns at the same time
- Update a row based on the contents of another row
- Delete all bookings
- Delete a member from the cd.members table
- Delete based on a subquery
- Aggregation
- Count the number of facilities
- Count the number of expensive facilities
- Count the number of recommendations each member makes.
- List the total slots booked per facility
- List the total slots booked per facility in a given month
- List the total slots booked per facility per month
- Find the count of members who have made at least one booking
- List facilities with more than 1000 slots booked
- Find the total revenue of each facility
- Find facilities with a total revenue less than 1000
- Output the facility id that has the highest number of slots booked
- List the total slots booked per facility per month, part 2
- List the total hours booked per named facility
- List each member’s first booking after September 1st 2012
- Produce a list of member names, with each row containing the total member count
- Produce a numbered list of members
- Output the facility id that has the highest number of slots booked, again
- Rank members by (rounded) hours used
- Find the top three revenue generating facilities
- Classify facilities by value
- Recursion
- Query Builder
- Hacks
- Changes in 3.0
Search
Please activate JavaScript to enable the search functionality.
Enter your search words into the box below and hit "search". Note that the search function will automatically search for all of the words. Pages containing fewer words won't appear in the result list.
Enter your search criteria in the search
box above or at left.