ores.trading.equity_position_instrument
Table of Contents
Represents EquityPosition and EquityOptionPosition trades: a plain
equity holding or an equity option position. For option positions,
option_data_json holds the serialised option parameters; for plain
equity positions, price captures the reference price and
option_data_json is null.
1. Flags
2. Natural keys
3. Columns
3.1. instrument_id
UUID uniquely identifying this equity position instrument.
Surrogate key for the instrument record.
3.2. trade_type_code
Trade type code (soft FK to ores_trading_trade_types_tbl).
Routes ORE product types: EquityPosition, EquityOptionPosition.
std::string("EquityPosition")
3.3. party_id
Party that owns this instrument.
Set from session variable app.current_party_id.
3.4. trade_id
Optional soft FK to the parent trade.
Links instrument to a trade if applicable.
3.5. underlying_name
Name of the underlying equity.
std::string("ACME Corp")
3.6. currency
ISO 4217 currency code.
e.g., USD, EUR, GBP.
std::string("USD")
3.7. quantity
Number of shares / contracts held.
100.0
3.8. price
Entry price; absent for market-price positions.
3.9. option_data_json
EquityOptionPosition only: serialised option parameters; empty otherwise.
3.10. description
Optional free-text description.
Human-readable notes about this instrument.
4. SQL
4.1. Flags
4.2. Checks
| expression |
|---|
| "underlying_name" <> '' |
| "currency" <> '' |
| "trade_type_code" in ('EquityPosition', 'EquityOptionPosition') |
| ("trade_type_code" = 'EquityOptionPosition' and "option_data_json" is not null) or ("trade_type_code" = 'EquityPosition' and "option_data_json" is null) |
4.3. Indexes
| name | columns | unique | current_only | where_extra |
|---|---|---|---|---|
| party | tenant_id, party_id | false | true | |
| trade_id | tenant_id, trade_id | true | true | trade_id is not null |
| trade_type | tenant_id, trade_type_code | false | true |
5. Insert trigger
5.1. Validations
| column | validation_function |
|---|---|
| trade_type_code | ores_trading_validate_trade_type_fn |
6. C++
The C++ domain class is decomposed into nested sub-structs (the C1202
pattern from PRs #1047/#1071/#1075/#1083/#1085): the implicit scaffolding
columns (version, tenant_id, workspace_id, the primary key) and the
columns marked :group: identity above fold into an
instrument_identity identity; member (see the
ores.trading.instrument_identity field-group model), the implicit audit
columns fold into an ores::dq::domain::audit_record audit; member (see
the ores.dq.audit_record field-group model), and the remaining columns
stay flat in between. The SQL schema, DB entity and column lists are
unaffected — only the domain class and the mapper's domain-side accesses
nest. The entity templates consume these annotations; domain and
repository profiles regenerate correctly.
6.1. Flags
6.2. Repository
6.3. Domain includes
#include <optional> #include <string>
6.4. Conventions
6.5. Table display
| column | header |
|---|---|
| identity.instrument_id | ID |
| identity.trade_type_code | Type |
| underlying_name | Underlying |
| currency | Ccy |
| quantity | Quantity |
| audit.recorded_at | Recorded At |
6.6. Custom repository methods
7. See also
- ores.trading — component group overview.