スクリプト開発 / コネクターオブジェクト `DFF.CONN` / MySQL

MySQL コネクターの操作オブジェクトは、主に MySQL を操作するためのメソッドを提供します。このコネクターは以下のデータベースと互換性があります。

MariaDB
Percona Server for MySQL
Alibaba Cloud PolarDB for MySQL
Alibaba Cloud OceanBase
Alibaba Cloud 分析型データベース (ADB) MySQL 版

DFF.CONN(...) のパラメータは次のとおりです。

パラメータ	型	必須 / デフォルト値	説明
`connector_id`	str	必須	コネクター ID
`database`	str	`None`	データベースを指定

`.query(...)`

SQL 文を実行し、list[dict] 形式のクエリ結果を返します。パラメータは次のとおりです。

パラメータ	型	必須 / デフォルト値	説明
`sql`	str	必須	SQL 文。パラメータプレースホルダーを含めることができます。 `?` はエスケープが必要なパラメータを表し、 `??` はエスケープが不要なパラメータを表します
`sql_params`	list	`None`	SQL パラメータ

例
sql = 'SELECT * FROM ?? WHERE seq > ?'
sql_params = ['demo', 1]
result = db.query(sql, sql_params=sql_params)

`.non_query(...)`

追加、削除、更新などの SQL 文を実行し、影響行数を返します。パラメータは次のとおりです。

パラメータ	型	必須 / デフォルト値	説明
`sql`	str	必須	SQL 文。パラメータプレースホルダーを含めることができます。 `?` はエスケープが必要なパラメータを表し、 `??` はエスケープが不要なパラメータを表します
`sql_params`	list	`None`	SQL パラメータ

例
sql = 'DELETE FROM ?? WHERE id = ?'
sql_params = ['demo', 1]
affected_rows = db.non_query(sql, sql_params=sql_params)

.query(...) と .non_query(...) は、実行が成功すると自動的にトランザクションをコミットし、実行が失敗すると自動的にロールバックして例外をスローします。

補助メソッド

メソッド	説明
`.query_raw(sql, sql_params=None)`	raw クエリ SQL を実行します。`DFF.SQL(...)` による構築を経由しません
`.non_query_raw(sql, sql_params=None)`	raw 非クエリ SQL を実行します。`DFF.SQL(...)` による構築を経由しません
`.format_sql(sql, sql_params=None, pretty=False)`	最終的な SQL 文字列を生成します。デバッグに適しています
`.tables()`	現在のデータベースのテーブル名のリストを返します
`.create_sql_builder(raw_sql=None)`	SQL Builder を作成します

通常の動的 SQL では、.query(...) または .non_query(...) の sql_params を使用することを優先してください。SQL が信頼できるコードによって完全に構築されている場合にのみ、raw SQL メソッドを使用してください。

トランザクション

同じトランザクション内で複数の SQL を実行する必要がある場合は、以下のメソッドを使用します。

メソッド	説明
`.start_trans()`	トランザクションを開始し、トランザクション接続オブジェクトを返します
`.trans_query(trans_conn, sql, sql_params=None)`	トランザクション内でクエリを実行し、`list[dict]` を返します
`.trans_non_query(trans_conn, sql, sql_params=None)`	トランザクション内で非クエリ SQL を実行し、影響行数を返します
`.commit(trans_conn)`	トランザクションをコミットし、トランザクション接続を閉じます
`.rollback(trans_conn)`	トランザクションをロールバックし、トランザクション接続を閉じます

例
trans_conn = db.start_trans()
db.trans_non_query(trans_conn, 'UPDATE ?? SET status = ? WHERE id = ?', ['demo', 'done', 1])
rows = db.trans_query(trans_conn, 'SELECT * FROM ?? WHERE id = ?', ['demo', 1])
db.commit(trans_conn)

トランザクション実行中に例外が発生した場合は、.rollback(trans_conn) を呼び出す必要があります。同じトランザクション接続オブジェクトは、コミットまたはロールバックの完了後は使用できません。

動的 SQL 文

query(...) と non_query(...) は内部で DFF.SQL(...) を使用して SQL 文を構築し、複雑な動的 SQL 文の構築をサポートします。

例えば、WHERE IN (...) の値の数が不定の場合や、INSERT INTO ... VALUES ... によるデータの一括書き込みなどです。

詳細はスクリプト開発 / SQL 構築 DFF.SQL を参照してください。

スクリプト開発 / コネクター オブジェクト DFF.CONN / MySQL

.query(...)

.non_query(...)