cmdbox.app.features.cli.datasource package
Submodules
cmdbox.app.features.cli.datasource.datasource_base module
- class cmdbox.app.features.cli.datasource.datasource_base.DatasourceBase(appcls, ver, language: str = None)[source]
Bases:
ResultEdgeFeature- DBTYPES = ['postgresql', 'sqlite']
- DBTYPE_PG = 'postgresql'
- DBTYPE_SQLITE = 'sqlite'
- build_where(where_data: Dict[str, Any], dbtype: str) Tuple[str, list][source]
WHERE句の文字列を構築します。 :param where_data: WHERE句に使用する条件の辞書。キーがカラム名、値が条件値です。 :param dbtype: データベースの種類('postgresql' または 'sqlite')
- Returns:
WHERE句の文字列と対応する値のリスト
- Return type:
Tuple[str, list]
- fetch_as_dicts(cursor) List[Dict[str, Any]][source]
カーソルから取得した結果を辞書のリストとして返します。 :param cursor: データベースカーソル
- Returns:
カーソルから取得した結果のリスト。各行は辞書として表されます。
- Return type:
List[Dict[str, Any]]
- get_context(dsconfig: Dict[str, Any]) Any[source]
データソース設定に基づいてデータベース接続を取得し、コンテキストマネージャーとして使用できるようにします。 :param dsconfig: データソース設定の辞書
- Returns:
コンテキストマネージャーとして使用できるデータベース接続オブジェクトとデータベース種別のタプル (conn, dbtype)
- Raises:
ValueError -- dbtype がサポートされていない場合
- is_dbtype_postgresql(dsconfig: Dict[str, Any]) bool[source]
- dsconfig の dbtype が PostgreSQL かどうかを判定します。
dsconfig に dbtype がない場合は SQLite とみなします。
- Parameters:
dsconfig -- データソース設定の辞書
dbtype -- 判定したいデータベース種別('postgresql' または 'sqlite')
- Returns:
dsconfig の dbtype が PostgreSQL の場合 True
- Return type:
bool
- Raises:
ValueError -- dbtype がサポートされていない場合
- is_dbtype_sqlite(dsconfig: Dict[str, Any]) bool[source]
dsconfig の dbtype が SQLite かどうかを判定します。 なお、dsconfig に dbtype がない場合は SQLite とみなします。 :param dsconfig: データソース設定の辞書
- Returns:
dsconfig の dbtype が SQLite の場合 True
- Return type:
bool
- load_datasource(data_dir: Path, dsname: str) Dict[str, Any][source]
データソース設定をファイルから読み込みます。 :param data_dir: データディレクトリのパス :param dsname: データソース名
- Returns:
データソース設定の辞書
- Raises:
FileNotFoundError -- 指定されたデータソース設定ファイルが存在しない場合
json.JSONDecodeError -- データソース設定ファイルの内容が有効なJSONでない場合
- qualified_name(schema: str, name: str, dbtype: str = None) str[source]
スキーマ名とオブジェクト名を結合して完全修飾名を作成します。 SQLiteの場合はスキーマをサポートしないため、nameをそのまま返します。 :param schema: スキーマ名 :param name: オブジェクト名 :param dbtype: データベース種別。DBTYPE_SQLITE の場合はスキーマを無視します。
- Returns:
完全修飾名
- Return type:
str
- async route_apprun(args: Namespace, payload: Dict[str, Any], logger: Logger, tm: float, pf: List[Dict[str, float]]) Tuple[int, Dict[str, Any], Any][source]
データソース設定の scope に基づいて apprun 処理をルーティングします。 client_data から dsconfig を読み込み、scope=='server' なら Redis 経由で svrun を呼び出し、 それ以外ならローカルで _do_run を実行します。
- save_datasource(data_dir: Path, *, dsname: str, dbtype: str, scope: str = 'client', client_data: str = None, db_host: str, db_port: int, db_user: str, db_password: str, db_name: str, db_timeout: int = None, db_path: str) None[source]
データソース設定をファイルに保存します。 :param data_dir: データディレクトリのパス :param dsname: データソース名 :param dbtype: データベース種別('postgresql' または 'sqlite') :param scope: 参照スコープ('client' または 'server') :param client_data: ローカルを参照させる場合のデータフォルダのパス(scope='client' の場合に必要) :param db_host: データベースホスト(PostgreSQLの場合) :param db_port: データベースポート(PostgreSQLの場合) :param db_user: データベースユーザー(PostgreSQLの場合) :param db_password: データベースパスワード(PostgreSQLの場合) :param db_name: データベース名(PostgreSQLの場合) :param db_timeout: データベース接続のタイムアウト(秒)(PostgreSQLの場合) :param db_path: SQLiteのデータベースファイルパス(SQLiteの場合)
- Raises:
ValueError -- dbtype がサポートされていない場合
IOError -- データソース設定ファイルの書き込みに失敗した場合
- validate_col_type(col_type: str) str[source]
カラムのデータ型として有効かどうかを検査します。 :param col_type: 検査するカラムのデータ型の文字列
- Returns:
入力されたカラムのデータ型が有効な場合はそのまま返します。
- Return type:
col_type
- Raises:
ValueError -- col_type が有効なカラムのデータ型でない場合に発生します。
- validate_columns(columns_str: str) str[source]
カラムリストの文字列を検査し、SQLクエリで使用できる形式に変換します。 :param columns_str: カラムリストの文字列。カラム名をカンマ区切りで指定します。空文字列や '*' の場合は全カラムを意味します。
- Returns:
SQLクエリで使用できるカラムリストの文字列。
- Return type:
str
- Raises:
ValueError -- columns_str に無効なカラム名が含まれている場合
- validate_identifier(name: str) str[source]
SQLの識別子(テーブル名、カラム名、スキーマ名など)として有効かどうかを検査します。 有効な識別子は、英字またはアンダースコアで始まり、その後に英数字またはアンダースコアが続く文字列です。 :param name: 検査する識別子の文字列
- Returns:
入力された識別子が有効な場合はそのまま返します。
- Return type:
- Raises:
ValueError -- name が有効なSQL識別子でない場合に発生します。
- validate_order_by(order_by_str: str) str[source]
ORDER BY句の文字列を検査し、SQLクエリで使用できる形式に変換します。 :param order_by_str: ORDER BY句の文字列。カラム名とオプションのASC/DESCをカンマ区切りで指定します。例: "name ASC, age DESC"
- Returns:
SQLクエリで使用できるORDER BY句の文字列。空文字列の場合は空文字列を返します。
- Return type:
str
- Raises:
ValueError -- order_by_str に無効な形式が含まれている場合