Topics
Newt DB topics
These guides go deeper than the getting started page. Each one covers a single area of configuration, data handling or operations, and points back to the reference when you need exact arguments.
Configuration
Connect and configure
How a Newt DB connection is described, and how a database is declared in a configuration file.
Data
Shape and search your data
What a schema means in Newt DB, how objects become JSON, and how to change that JSON before it is stored.
Database schemas
There is no server side schema. Python classes carry the expectations, and the shape can change as the application changes.
Read the guideJSON serialization
Class names, reference objects, intrarecord cycles, persistent columns and the date rules used by the converter.
Read the guideData transformation
Supply a transform function to flatten a structure, rewrite a state or skip records that should not reach the newt table.
Read the guideInformation for ZODB users
What Newt DB adds to RelStorage and PostgreSQL, and the two routes for bringing an existing database across.
Read the guideOperations
Run it in production
Packing, background conversion, change streams and the URI route used by application frameworks.
Database administration
PostgreSQL administration, binary distributions, Docker, and the packing duties that belong to a Newt DB database.
Read the guideAsynchronous JSON conversion
Move conversion out of the write path with the newt updater daemon, and monitor its lag from your existing alerting system.
Read the guideFollowing changes
Stream committed changes into search indexes, caches, analytics or any other system that needs its own copy.
Read the guidezodburi URI support
Open a database with a newt URI, set the driver, cache and pool options, and understand what the zodburi route leaves out.
Read the guideNeed an exact signature? The API reference lists every function, method and class with its arguments and return value.