Documents

Contents

Database

モジュール概要

SQLite database manager.

チュートリアル

最初に以下の最小例でモジュール利用方法を確認し、その後 API リファレンスを参照してください。

from nexom.app.db import DatabaseManager

dbm = DatabaseManager('app.db', auto_commit=True)
rows = dbm.execute('SELECT 1')
print(rows)

運用チェックリスト

  • 本番では例外処理を必ず実装し、戻り値の型を固定してください。
  • 引数のデフォルト値と必須/任意を仕様書としてチーム内で固定してください。
  • ログと監視を追加し、エラー時の復旧手順を運用Runbookに記載してください。

API リファレンス（全関数・全メソッド）

モジュール関数

_call_error_handler

分類: internal function

シグネチャ

_call_error_handler(e: Error)

使い方と仕様

実装コード由来のAPIです。

引数

  • e / kind=positional-or-keyword / type=Error / 必須 / default=なし

戻り値

型指定なし

例外・注意点

実装コード内の例外仕様を確認してください。

利用例

from nexom.app.db import _call_error_handler

result = _call_error_handler(e=...)
print(result)

クラス

DatabaseManager

分類: public class

Simple SQLite database manager. - Opens a connection on construction - Applies safe PRAGMA defaults - Provides execute/execute_many helpers

DatabaseManager の全メソッド

__init__

分類: special method

シグネチャ
__init__(self, db_file: str, auto_commit: bool = True)
使い方と仕様

メソッドドキュメントは未定義です。

引数
  • db_file / kind=positional-or-keyword / type=str / 必須 / default=なし
  • auto_commit / kind=positional-or-keyword / type=bool / 任意 / default=True
戻り値

型指定なし

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(db_file="sample", auto_commit=True)
_init

分類: internal method

シグネチャ
_init(self) -> None
使い方と仕様

Initialize tables (override in subclasses).

引数
  • 引数なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj._init()
print(result)
start_connection

分類: public method

シグネチャ
start_connection(self, auto_commit: bool = True) -> None
使い方と仕様

Open a SQLite connection and apply PRAGMA defaults.

引数
  • auto_commit / kind=positional-or-keyword / type=bool / 任意 / default=True
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj.start_connection(auto_commit=True)
print(result)
rip_connection

分類: public method

シグネチャ
rip_connection(self) -> None
使い方と仕様

Close the current connection.

引数
  • 引数なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj.rip_connection()
print(result)
_commit

分類: internal method

シグネチャ
_commit(self) -> None
使い方と仕様

Commit the current transaction.

引数
  • 引数なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj._commit()
print(result)
commit

分類: public method

シグネチャ
commit(self) -> None
使い方と仕様

Public commit wrapper.

引数
  • 引数なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj.commit()
print(result)
execute

分類: public method

シグネチャ
execute(self, sql: str, *args: Any) -> list[tuple] | None
使い方と仕様

Execute a single SQL statement. Returns rows for SELECT, otherwise None.

引数
  • sql / kind=positional-or-keyword / type=str / 必須 / default=なし
  • args / kind=variadic-positional(*args) / type=Any / 必須 / default=なし
戻り値

list[tuple] | None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj.execute(sql="sample")
print(result)
execute_many

分類: public method

シグネチャ
execute_many(self, sql_inserts: Iterable[tuple[str, tuple]]) -> None
使い方と仕様

Execute multiple SQL statements in a single transaction.

引数
  • sql_inserts / kind=positional-or-keyword / type=Iterable[tuple[str, tuple]] / 必須 / default=なし
戻り値

None

例外・注意点

実装コード内の例外仕様を確認してください。

利用例
from nexom.app.db import DatabaseManager

obj = DatabaseManager(...)
result = obj.execute_many(sql_inserts="sample")
print(result)

ソース情報

  • module: nexom.app.db
  • source file: services/venv/lib/python3.10/site-packages/nexom/app/db.py
  • generated date: 2026-03-14

©2026 Nexom MIT-License