delta_trace_db.query.merge_query_params

Classes

MergeQueryParams(*, base, source, ...[, ...])

(en) This class defines special parameters for merge queries.
class delta_trace_db.query.merge_query_params.MergeQueryParams(*, base: str, source: list[str], relation_key: str, source_keys: list[str], output: str, dsl_tmp: dict, serial_base: str | None = None, serial_key: str | None = None)

Bases: CloneableFile

(en) This class defines special parameters for merge queries.

(ja) mergeクエリ用の専用パラメータを定義したクラスです。

Relation semantics

  • For each base item, at most one item is selected from each source collection.

  • The source items are aligned by index with the source list.

  • In DSL, source items can be referenced as 0.xxx, 1.xxx, etc.

  • If no matching source item is found, the source is treated as empty.

param base:

The name of the collection used as the base when merging.

type base:

str

param source:

An array of names of the source collections to be merged. Each element corresponds to the array index on dsl_tmp.

type source:

list[str]

param relation_key:

The key name on the base collection used for the relation.

type relation_key:

str

param source_keys:

Key names on each source collection whose values are compared with the value of relation_key on the base collection.

type source_keys:

list[str]

param output:

The name of the output collection.

type output:

str

param dsl_tmp:

Structural information of the merged items described in DSL.

type dsl_tmp:

dict

param serial_base:

When set, the serial number currently managed within the specified collection will be inherited.

type serial_base:

Optional[str]

param serial_key:

When set, the value of the specified key in dsl_tmp is treated as a serial key, and a serial number starting from 0 is assigned when adding items. Ignored if serial_base is set.

type serial_key:

Optional[str]

class_name = 'MergeQueryParams'
clone()

(en) Returns a deep copy of this object.

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

classmethod from_dict(src)

(en) Restore this object from the dictionary.

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

Parameters:

src (dict) – A dictionary made with to_dict of this class.

to_dict()

(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'