delta_trace_db.query.cause.cause

Classes

Cause(who, when, what, why, from_[, serial, ...])

(en) A class for entering a description of a query.
class delta_trace_db.query.cause.cause.Cause(who: Actor, when: TemporalTrace, what: str, why: str, from_: str, serial: str | None = None, chain_parent_serial: str | None = None, context: Dict[str, Any] | None = None, confidence_score: float = 1.0)

Bases: CloneableFile

(en) A class for entering a description of a query. If you write this class accurately, you can log queries and trace a nearly complete history of database operations. It is recommended to include this class in queries in cases with high security requirements.

(ja) クエリに関する説明を入力するためのクラスです。 このクラスを正確に記述する場合、クエリをログとして保存することで、 データベース操作のほぼ完全な歴史を辿ることが可能になります。 高度なセキュリティ要件があるケースではこのクラスをクエリに含めることをお勧めします。

Parameters:

  • serial (Optional[str]) – A unique identifier assigned to this operation.

  • chain_parent_serial (Optional[str]) – The serial of the previous Cause, in case this operation is a chain operation.

  • who (Actor) – Information about the person who performed the operation.

  • when (TemporalTrace) – The “time trail” of the event.

  • what (str) – An explanation of this inquiry, i.e., what kind of operation it is. Example: Obtaining data for a specified period on screen A.

  • why (str) – An explanation of why this inquiry is being made. Example: Correcting a user’s input error.

  • from (str) – An explanation of where the inquiry is coming from. Example: From mobile app A.

  • context (Optional[Dict[str, Any]]) – Other more detailed information.

  • confidence_score (float) – A degree of confidence expressed as 0.0 to 1.0. When correcting an error, this indicates the degree of confidence that the data entered or overwritten is correct. Especially in the case of automatic operation by AI, the AI’s confidence level is entered here. In the case of human operation, 1.0 is always entered.

class_name = 'Cause'
clone() → Cause

(en) Returns a deep copy of this object.

(ja) このオブジェクトのディープコピーを返します。

classmethod from_dict(src: Dict[str, Any]) → Cause

(en) Restore this object from the dictionary.

(ja) このオブジェクトを辞書から復元します。

Parameters:

src (Dict[str, Any]) – A dictionary made with to_dict of this class.

Returns:

復元されたオブジェクト

Return type:

CloneableFile

to_dict() → Dict[str, Any]

(en) Convert the object to a dictionary. The returned dictionary can only contain primitive types, null, lists or maps with only primitive elements. If you want to include other classes, the target class should inherit from this class and chain calls to_dict.

(ja) このオブジェクトを辞書に変換します。 戻り値の辞書にはプリミティブ型かプリミティブ型要素のみのリスト またはマップ等、そしてNoneのみを含められます。 それ以外のクラスを含めたい場合、対象のクラスもこのクラスを継承し、 to_dictを連鎖的に呼び出すようにしてください。

version = '1'