3.0における変更点
このドキュメントでは、2.xから3.xに移行する際に注意すべき変更点について説明します。
後方互換性のない変更
可能な限り後方互換性を維持するように努めました。変更されたAPIの中には、DeprecationWarning を発生させるものがあります。
データベース
get_conn()はDatabase.connection()に変更されました。get_cursor()はDatabase.cursor()に変更されました。execution_context()は、データベースインスタンスをコンテキストマネージャーとして使用することで置き換えられました。トランザクションなしの接続コンテキストの場合は、
Database.connection_context()を使用してください。Database.create_tables()とDatabase.drop_tables()、そしてModel.create_table()とModel.drop_table()はすべて、デフォルトでsafe=Trueになっています（create_tableは存在しない場合は作成し、drop_tableは存在する場合は削除します）。connect_kwargs属性はconnect_paramsに名前変更されました。カスタムフィールドタイプの定義の初期化パラメータが
fieldsからfield_typesに変更されました。
モデルのメタオプション
db_tableはtable_nameに変更されましたdb_table_funcはtable_functionに変更されましたorder_byは削除されました（SELECTクエリに適用されるデフォルトの順序を指定するために使用されていました）。validate_backrefsは削除されました。逆参照はもはや検証されません。
モデル
BaseModelはModelBaseに名前変更されました生のモデルデータへのアクセスは、
_dataの代わりに__data__を使用して行われるようになりました。モデルメソッド
_prepare_instance()は削除されました。モデルとその関連インデックスを生成するためのDDLステートメントを出力する
sqlall()メソッドは削除されました。
フィールド
db_columnはcolumn_nameに変更されましたdb_fieldクラス属性はfield_typeに変更されました（カスタムフィールドサブクラスを実装する場合に使用されます）model_class属性はmodelに変更されましたPrimaryKeyFieldはAutoFieldに名前変更されましたForeignKeyFieldコンストラクタには、以下の変更点があります。rel_modelはmodelに変更されましたto_fieldはfieldに変更されましたrelated_nameはbackrefに変更されました
ManyToManyFieldは、メインのpeewee.pyモジュールに含まれるようになりました。拡張フィールド
PasswordField、PickledField、AESEncryptedFieldが削除されました。
クエリ
JOIN_INNER、JOIN_LEFT_OUTER などは、JOIN.INNER、JOIN.LEFT_OUTER などになりました。
クエリ結果ラッパーの実装を含むC拡張機能は削除されました。
さらに、Select.aggregate_rows() が削除されました。このヘルパーは、左結合クエリの重複を排除し、モデルとそのリレーションを反復処理する際の効率性を高めるために使用されていました。実際には、コードの複雑さと、その限られた有用性から、これを廃止することにしました。代わりに、prefetch() を使用して同じ結果を得ることができます。
Selectクエリの属性_selectは_returningに変更されましたnaive()メソッドはobjects()になりました。これはデフォルトでモデルクラスをコンストラクタとして使用しますが、代替コンストラクタとして任意の呼び出し可能オブジェクトを受け入れます。annotate()クエリメソッドはサポートされなくなりました。
Case() ヘルパーは、playhouse.shortcuts モジュールからメインのpeeweeモジュールに移動しました。
cast() メソッドはもはや関数ではなく、すべてのカラムのようなオブジェクトのメソッドになりました。
InsertQuery.return_id_list() メソッドは、_WriteQuery.returning() を使用する、より一般的なパターンに置き換えられました。
InsertQuery.upsert() メソッドは、より一般的で柔軟な Insert.on_conflict() メソッドに置き換えられました。
prefetch() を使用する場合、収集されたインスタンスは、外部キーの backref と同じ属性に格納されます。以前は、結合されたインスタンスに (backref)_prefetch を使用してアクセスしていました。
構成可能なSQL文字列を作成するために使用される SQL オブジェクトは、2番目のパラメータとしてリスト/タプルパラメータを期待するようになりました。
削除された拡張機能
以下の拡張機能は、playhouse には含まれなくなりました。
berkeleydbcsv_utilsdjpeeweegfkkvpskelread_slave
SQLite拡張
SQLite拡張モジュールのVirtualModelクラスは、わずかに異なるMetaオプションを受け入れます。
arguments- 仮想テーブルで定義されているカラムの後に追加される任意の引数を指定するために使用されます。文字列のリストである必要があります。extension_module(変更なし)options(extension_optionsを置き換えます) - カラムとargumentsの後に表示される仮想テーブルの任意のオプション。prefix_arguments- 仮想テーブル宣言の引数またはカラムの前に表示されるべき文字列のリスト。
そのため、仮想テーブルのモデルを宣言する場合、おおよそ次のように構築されます。
CREATE VIRTUAL TABLE "table name" USING extension_module (
prefix arguments,
field definitions,
arguments,
options)
PostgreSQL拡張
PostgresqlExtDatabaseは、デフォルトではhstore拡張を登録しなくなりました。3.0以降でhstore拡張を使用するには、データベースオブジェクトを初期化するときにregister_hstore=Trueを渡します。
シグナル拡張
post_initシグナルは削除されました。
新機能
クエリビルダーは、より柔軟で強力になるように、根本から書き直されました。クエリを構築するための汎用的な、低レベルAPIが追加されました。
SQLite
多くのSQLite固有の機能が、playhouse.sqlite_extモジュールからpeeweeに移動されました。たとえば、
ユーザー定義関数、集約、照合、およびテーブル関数。
拡張機能の読み込み。
プラグマの指定。
詳細については、「SQLiteの使用」セクションと「SQLite拡張」ドキュメントを参照してください。
SQLite拡張
sqlite-vtfuncの仮想テーブル実装は、peeweeコードベースに統合されました。