credmark.cmf.model.ledger.LedgerQueryTable

class LedgerQueryTable(**kwargs)

Bases: LedgerQuery, LedgerTable

Methods

as_
describe
field
select	Query data from the table.

Attributes

alias
bigint_cols
colnames	Return the set of column names in the table.
columns	Return the set of column names for the table.
table_key

property colnames: List[str]

Return the set of column names in the table. They can be used in the query.

property columns: List[str]

Return the set of column names for the table. They will be used in the database.

For contract ledger tables, the set will include all contract-specific columns.

select(columns=None, joins=None, where=None, group_by=None, order_by=None, limit=None, offset=None, aggregates=None, having=None, bigint_cols=None, analytics_mode=None)

Query data from the table.

Parameters

• columns (Optional[Union[list[str], list[credmark.cmf.types.ledger.ColumnField]]]) –

• joins (Optional[list[Union[tuple[credmark.cmf.types.ledger.JoinType, credmark.cmf.types.ledger.LedgerTable, str], tuple[credmark.cmf.types.ledger.LedgerTable, str], tuple[credmark.cmf.types.ledger.JoinType, credmark.cmf.types.ledger.LedgerTable, credmark.cmf.types.ledger.ColumnField], tuple[credmark.cmf.types.ledger.LedgerTable, credmark.cmf.types.ledger.ColumnField]]]]) –

• where (Optional[str]) –

• group_by (Optional[Union[list[str], list[credmark.cmf.types.ledger.ColumnField]]]) –

• order_by (Optional[Union[str, ColumnField]]) –

• limit (Optional[int]) –

• offset (Optional[int]) –

• aggregates (Optional[list[tuple[str, str]]]) –

• having (Optional[str]) –

• bigint_cols (Optional[list[str]]) –

• analytics_mode (Optional[bool]) –

Return type

LedgerModelOutput