credmark.cmf.types.ledger.LedgerJoin
- DTO class LedgerJoin(*, type=None, tableKey, alias=None, on)[source]
Bases:
BaseModel
Join in a query. It is defined by table key, table alias and expression to join on.
Show JSON schema
{ "title": "LedgerJoin", "description": "Join in a query.\nIt is defined by table key, table alias and\nexpression to join on.", "type": "object", "properties": { "type": { "description": "Type of join. Defaults to inner join.", "allOf": [ { "$ref": "#/definitions/JoinType" } ] }, "tableKey": { "title": "Tablekey", "description": "Key of the table to be joined", "type": "string" }, "alias": { "title": "Alias", "description": "Alias for the table", "type": "string" }, "on": { "title": "On", "description": "Join expression, for example \"a.address = b.address\"", "type": "string" } }, "required": [ "tableKey", "on" ], "definitions": { "JoinType": { "title": "JoinType", "description": "An enumeration.", "enum": [ "inner", "leftOuter", "rightOuter", "fullOuter", "cross", "natural" ], "type": "string" } } }
- Fields
- Parameters
- Return type
None