yrzam/findb
1
0
Fork 0
mirror of https://github.com/yrzam/findb.git synced 2025-11-04 01:59:05 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

description fields, categories hierarchy, better booleans

Browse Source
This commit is contained in:
yrzam
2024-02-16 04:25:33 +04:00
parent b501d5159c
commit f0e903f509
2 changed files with 153 additions and 26 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@@ -109,10 +109,14 @@ reason_phys_asset_id - (optional) physical asset, due to which transaction has o
A **transaction category** describes the logical sense of the transaction. A **transaction category** describes the logical sense of the transaction.
Transaction categories must form a hierarchy with only one root. If a certain flag (starting with `is_`) is set to true on a category, it must be set to true on all of its child categories. The integrity is ensured via triggers that throw exceptions.
``` ```
is_rebalance - whether the transaction is a part of self-transfer / exchange
is_passive - whether the income or expense is passive (see definition below) is_passive - whether the income or expense is passive (see definition below)
is_rebalance - whether the transaction is a part of self-transfer / exchange
is_initial_import - whether the transaction is an upload of the existing assets for accounting (thus it is neither active nor passive income/expense) is_initial_import - whether the transaction is an upload of the existing assets for accounting (thus it is neither active nor passive income/expense)
parent_id - reference to a category that is a superset of the current one
min_view_depth - in the flattened representation, category shall not appear on a level lower than N, N>=0. Parent category takes multiple levels instead
... ...
``` ```
@@ -124,7 +128,7 @@ Income or expense is considered passive if two conditions are met:
> For example, paying tax for the property a person lives in is not a passive loss, although paying it for a property that they lend is a passive loss. > For example, paying tax for the property a person lives in is not a passive loss, although paying it for a property that they lend is a passive loss.
> Examples of transaction categories: salary transfer, rent payment, self transfer or exchange, dividends payout. > Examples of transaction categories: expense, salary transfer, rent payment, self transfer or exchange, dividends payout.
### latest_fin_transactions (editable view) ### latest_fin_transactions (editable view)

171
schema.sql
View File

@@ -43,12 +43,13 @@ CREATE TABLE "fin_assets" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
"code" TEXT NOT NULL, "code" TEXT NOT NULL,
"name" TEXT, "name" TEXT,
"description" TEXT,
"type_id" INTEGER NOT NULL, "type_id" INTEGER NOT NULL,
"is_base" INTEGER NOT NULL DEFAULT 0, "is_base" INTEGER NOT NULL DEFAULT 0,
"is_active" INTEGER NOT NULL DEFAULT 1, "is_active" INTEGER NOT NULL DEFAULT 1,
UNIQUE("type_id","code"), UNIQUE("type_id","code"),
PRIMARY KEY("id"), FOREIGN KEY("type_id") REFERENCES "fin_asset_types"("id"),
FOREIGN KEY("type_id") REFERENCES "fin_asset_types"("id") PRIMARY KEY("id")
); );
CREATE TABLE "fin_assets_storages" ( CREATE TABLE "fin_assets_storages" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
@@ -65,39 +66,45 @@ CREATE TABLE "fin_assets_storages" (
CREATE TABLE "fin_storages" ( CREATE TABLE "fin_storages" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
"name" TEXT NOT NULL UNIQUE, "name" TEXT NOT NULL UNIQUE,
"description" TEXT,
"is_active" INTEGER NOT NULL DEFAULT 1, "is_active" INTEGER NOT NULL DEFAULT 1,
PRIMARY KEY("id") PRIMARY KEY("id")
); );
CREATE TABLE "fin_transaction_categories" ( CREATE TABLE "fin_transaction_categories" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
"name" TEXT NOT NULL UNIQUE, "name" TEXT NOT NULL UNIQUE,
"is_rebalance" INTEGER NOT NULL DEFAULT 0,
"is_passive" INTEGER NOT NULL DEFAULT 0, "is_passive" INTEGER NOT NULL DEFAULT 0,
"is_rebalance" INTEGER NOT NULL DEFAULT 0,
"is_initial_import" INTEGER NOT NULL DEFAULT 0, "is_initial_import" INTEGER NOT NULL DEFAULT 0,
"parent_id" INTEGER,
"min_view_depth" INTEGER NOT NULL DEFAULT 0,
FOREIGN KEY("parent_id") REFERENCES "fin_transaction_categories"("id"),
PRIMARY KEY("id") PRIMARY KEY("id")
); );
CREATE TABLE "fin_transactions" ( CREATE TABLE "fin_transactions" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
"date" NUMERIC NOT NULL, "date" NUMERIC NOT NULL,
"description" TEXT,
"asset_storage_id" INTEGER NOT NULL, "asset_storage_id" INTEGER NOT NULL,
"amount" NUMERIC NOT NULL, "amount" NUMERIC NOT NULL,
"category_id" INTEGER NOT NULL, "category_id" INTEGER NOT NULL,
"reason_fin_asset_storage_id" INTEGER, "reason_fin_asset_storage_id" INTEGER,
"reason_phys_asset_id" INTEGER, "reason_phys_asset_id" INTEGER,
FOREIGN KEY("reason_fin_asset_storage_id") REFERENCES "fin_assets_storages"("id"),
FOREIGN KEY("category_id") REFERENCES "fin_transaction_categories"("id"),
PRIMARY KEY("id"), PRIMARY KEY("id"),
FOREIGN KEY("reason_phys_asset_id") REFERENCES "phys_assets"("id") FOREIGN KEY("reason_phys_asset_id") REFERENCES "phys_assets"("id"),
FOREIGN KEY("reason_fin_asset_storage_id") REFERENCES "fin_assets_storages"("id"),
FOREIGN KEY("category_id") REFERENCES "fin_transaction_categories"("id")
); );
CREATE TABLE "phys_assets" ( CREATE TABLE "phys_assets" (
"id" INTEGER NOT NULL, "id" INTEGER NOT NULL,
"name" TEXT NOT NULL UNIQUE, "name" TEXT NOT NULL UNIQUE,
"description" TEXT,
"buy_transaction_id" INTEGER, "buy_transaction_id" INTEGER,
"sell_transaction_id" INTEGER, "sell_transaction_id" INTEGER,
"is_expired" INTEGER NOT NULL DEFAULT 0, "is_expired" INTEGER NOT NULL DEFAULT 0,
FOREIGN KEY("buy_transaction_id") REFERENCES "fin_transactions"("id"),
FOREIGN KEY("sell_transaction_id") REFERENCES "fin_transactions"("id"), FOREIGN KEY("sell_transaction_id") REFERENCES "fin_transactions"("id"),
PRIMARY KEY("id") PRIMARY KEY("id"),
FOREIGN KEY("buy_transaction_id") REFERENCES "fin_transactions"("id")
); );
CREATE INDEX "i_balance_goals_asset_storage_id" ON "balance_goals" ( CREATE INDEX "i_balance_goals_asset_storage_id" ON "balance_goals" (
"asset_storage_id" "asset_storage_id"
@@ -204,15 +211,15 @@ from (
(select b.amount from balances b where b.asset_storage_id=fas.id order by b.date desc limit 1)* (select b.amount from balances b where b.asset_storage_id=fas.id order by b.date desc limit 1)*
(select far.rate from fin_asset_rates far where far.asset_id=fa.id order by far.date desc limit 1), (select far.rate from fin_asset_rates far where far.asset_id=fa.id order by far.date desc limit 1),
2) as base_balance, 2) as base_balance,
(select code from fin_assets fa2 where fa2.is_base=1 limit 1) as base_asset (select code from fin_assets fa2 where fa2.is_base limit 1) as base_asset
from from
fin_assets_storages fas fin_assets_storages fas
join fin_assets fa on fa.id=fas.asset_id join fin_assets fa on fa.id=fas.asset_id
join fin_asset_types fat on fat.id=fa.type_id join fin_asset_types fat on fat.id=fa.type_id
join fin_storages fs on fs.id=fas.storage_id join fin_storages fs on fs.id=fas.storage_id
where where
fa.is_active=1 and fa.is_active and
fs.is_active=1 fs.is_active
order by order by
fas.priority desc fas.priority desc
) t ) t
@@ -222,7 +229,7 @@ CREATE VIEW current_fin_allocation as
select select
t.name as "group", t.name as "group",
round(t.base_balance,2) as base_balance, round(t.base_balance,2) as base_balance,
(select code from fin_assets fa2 where fa2.is_base=1 limit 1) as base_asset, (select code from fin_assets fa2 where fa2.is_base limit 1) as base_asset,
(round(t.current_share, 1) || '%') as current_share, (round(t.current_share, 1) || '%') as current_share,
(round(t.target_share, 1) || '%') as target_share (round(t.target_share, 1) || '%') as target_share
from ( from (
@@ -252,7 +259,7 @@ from (
left join fin_storages fs on fs.id=fas.storage_id left join fin_storages fs on fs.id=fas.storage_id
where where
fas.id is null or fas.id is null or
(fa.is_active=1 and fs.is_active=1) (fa.is_active and fs.is_active)
group by group by
fag.id fag.id
) t ) t
@@ -273,8 +280,8 @@ from (
join fin_storages fs on fs.id=fas.storage_id join fin_storages fs on fs.id=fas.storage_id
where where
fas.allocation_group_id is null and fas.allocation_group_id is null and
fa.is_active=1 and fa.is_active and
fs.is_active=1 fs.is_active
) t ) t
where where
t.base_balance!=0 or t.target_share!=0 t.base_balance!=0 or t.target_share!=0
@@ -286,12 +293,12 @@ select
fat.name as asset_type, fat.name as asset_type,
fa.code as asset, fa.code as asset,
(select rate from fin_asset_rates far where far.asset_id=fa.id order by far.date desc limit 1) as rate, (select rate from fin_asset_rates far where far.asset_id=fa.id order by far.date desc limit 1) as rate,
(select fa2.code from fin_assets fa2 where fa2.is_base=1 limit 1) as base_asset (select fa2.code from fin_assets fa2 where fa2.is_base limit 1) as base_asset
from from
fin_assets fa fin_assets fa
join fin_asset_types fat on fat.id=fa.type_id join fin_asset_types fat on fat.id=fa.type_id
where where
fa.is_active=1; fa.is_active;
CREATE VIEW historical_monthly_balances as CREATE VIEW historical_monthly_balances as
with recursive dates(mo_start_date, date) as ( with recursive dates(mo_start_date, date) as (
values( values(
@@ -310,7 +317,7 @@ with recursive dates(mo_start_date, date) as (
), ),
constants as( constants as(
select select
(select code from fin_assets fa2 where fa2.is_base=1 limit 1) as base_asset (select code from fin_assets fa2 where fa2.is_base limit 1) as base_asset
), ),
data_by_type as materialized( -- force materialize - 2x faster due to lead() data_by_type as materialized( -- force materialize - 2x faster due to lead()
@@ -332,7 +339,7 @@ select
( (
select select
coalesce(sum( coalesce(sum(
(select sum(ft.amount) from fin_transactions ft join fin_transaction_categories ftc on ftc.id=ft.category_id where ft.asset_storage_id=fas.id and ft.date>=d.mo_start_date and ft.date<=d.date and ftc.is_rebalance=0 and ftc.is_passive=0 and ftc.is_initial_import=0)* (select sum(ft.amount) from fin_transactions ft join fin_transaction_categories ftc on ftc.id=ft.category_id where ft.asset_storage_id=fas.id and ft.date>=d.mo_start_date and ft.date<=d.date and not ftc.is_rebalance and not ftc.is_passive and not ftc.is_initial_import)*
(select far.rate from fin_asset_rates far where far.asset_id=fas.asset_id and far.date<=d.date order by far.date desc limit 1) (select far.rate from fin_asset_rates far where far.asset_id=fas.asset_id and far.date<=d.date order by far.date desc limit 1)
),0) ),0)
from from
@@ -344,7 +351,7 @@ select
( (
select select
coalesce(sum( coalesce(sum(
(select sum(ft.amount) from fin_transactions ft join fin_transaction_categories ftc on ftc.id=ft.category_id where ft.asset_storage_id=fas.id and ft.date>=d.mo_start_date and ft.date<=d.date and ftc.is_initial_import=1)* (select sum(ft.amount) from fin_transactions ft join fin_transaction_categories ftc on ftc.id=ft.category_id where ft.asset_storage_id=fas.id and ft.date>=d.mo_start_date and ft.date<=d.date and ftc.is_initial_import)*
(select far.rate from fin_asset_rates far where far.asset_id=fas.asset_id and far.date<=d.date order by far.date desc limit 1) (select far.rate from fin_asset_rates far where far.asset_id=fas.asset_id and far.date<=d.date order by far.date desc limit 1)
),0) ),0)
from from
@@ -579,6 +586,122 @@ begin
on conflict(asset_id,date) do update on conflict(asset_id,date) do update
set rate=new.rate; set rate=new.rate;
end; end;
CREATE TRIGGER fin_transaction_categories_insert insert on fin_transaction_categories
begin
with
recursive parents(path, parent_id) as (
values('/'||new.id||'/', new.parent_id)
union all
select
p.path||cat.id||'/', cat.parent_id
from
parents p
join fin_transaction_categories cat on cat.id=p.parent_id
where
p.path not like '%/'||cat.id||'/%'
),
children(path, id) as (
values('/'||new.id||'/', new.id)
union all
select
c.path||cat.id||'/', cat.id
from
children c
join fin_transaction_categories cat on cat.parent_id=c.id
where
c.path not like '%/'||cat.id||'/%'
)
select
case
when new.parent_id is not null and not exists(select 1 from fin_transaction_categories where id=new.parent_id)
then raise(abort, 'parent does not exist')
when new.parent_id is null and exists(select 1 from fin_transaction_categories where parent_id is null and id!=new.id)
then raise(abort, 'root of the hierarchy already exists')
when not exists(select 1 from parents where parent_id is null)
then raise(abort, 'upper part of the hierarchy is circular')
when (not new.is_passive and p.has_passive) or (not new.is_rebalance and p.has_rebalance) or (not new.is_initial_import and p.has_initial_import)
then raise(abort, 'parent conditions not met')
when (new.is_passive and c.has_not_passive) or (new.is_rebalance and c.has_not_rebalance) or (new.is_initial_import and c.has_not_initial_import)
then raise(abort, 'child conditions not met')
end
from
(
select
coalesce(max(cat.is_passive),0) as has_passive,
coalesce(max(cat.is_rebalance),0) as has_rebalance,
coalesce(max(cat.is_initial_import),0) as has_initial_import
from
parents p
join fin_transaction_categories cat on cat.id=p.parent_id
) p,
(
select
not coalesce(min(cat.is_passive),1) as has_not_passive,
not coalesce(min(cat.is_rebalance),1) as has_not_rebalance,
not coalesce(min(cat.is_initial_import),1) as has_not_initial_import
from
children c
join fin_transaction_categories cat on cat.parent_id=c.id
) c;
end;
CREATE TRIGGER fin_transaction_categories_update update of id,parent_id,is_passive,is_rebalance,is_initial_import on fin_transaction_categories
begin
with
recursive parents(path, parent_id) as (
values('/'||new.id||'/', new.parent_id)
union all
select
p.path||cat.id||'/', cat.parent_id
from
parents p
join fin_transaction_categories cat on cat.id=p.parent_id
where
p.path not like '%/'||cat.id||'/%'
),
children(path, id) as (
values('/'||new.id||'/', new.id)
union all
select
c.path||cat.id||'/', cat.id
from
children c
join fin_transaction_categories cat on cat.parent_id=c.id
where
c.path not like '%/'||cat.id||'/%'
)
select
case
when new.parent_id is not null and not exists(select 1 from fin_transaction_categories where id=new.parent_id)
then raise(abort, 'parent does not exist')
when new.parent_id is null and exists(select 1 from fin_transaction_categories where parent_id is null and id!=new.id)
then raise(abort, 'root of the hierarchy already exists')
when not exists(select 1 from parents where parent_id is null)
then raise(abort, 'upper part of the hierarchy is circular')
when (not new.is_passive and p.has_passive) or (not new.is_rebalance and p.has_rebalance) or (not new.is_initial_import and p.has_initial_import)
then raise(abort, 'parent conditions not met')
when (new.is_passive and c.has_not_passive) or (new.is_rebalance and c.has_not_rebalance) or (new.is_initial_import and c.has_not_initial_import)
then raise(abort, 'child conditions not met')
end
from
(
select
coalesce(max(cat.is_passive),0) as has_passive,
coalesce(max(cat.is_rebalance),0) as has_rebalance,
coalesce(max(cat.is_initial_import),0) as has_initial_import
from
parents p
join fin_transaction_categories cat on cat.id=p.parent_id
) p,
(
select
not coalesce(min(cat.is_passive),1) as has_not_passive,
not coalesce(min(cat.is_rebalance),1) as has_not_rebalance,
not coalesce(min(cat.is_initial_import),1) as has_not_initial_import
from
children c
join fin_transaction_categories cat on cat.parent_id=c.id
) c;
end;
CREATE TRIGGER latest_fin_transactions_delete instead of delete on latest_fin_transactions CREATE TRIGGER latest_fin_transactions_delete instead of delete on latest_fin_transactions
begin begin
delete from delete from
@@ -633,7 +756,7 @@ begin
select select
case case
when coalesce(new.date, date('now'))!=date('now') and new.adjust_balance=1 when coalesce(new.date, date('now'))!=date('now') and new.adjust_balance
then raise(abort, 'adjust_balance works only with current date') then raise(abort, 'adjust_balance works only with current date')
end; end;
@@ -648,7 +771,7 @@ begin
join fin_asset_types fat on fat.id=fa.type_id join fin_asset_types fat on fat.id=fa.type_id
join fin_storages fs on fs.id=fas.storage_id join fin_storages fs on fs.id=fas.storage_id
where where
new.adjust_balance=1 and new.adjust_balance and
fa.code = new.asset_code and fa.code = new.asset_code and
fat.name = new.asset_type and fat.name = new.asset_type and
fs.name = new.storage fs.name = new.storage
@@ -705,7 +828,7 @@ begin
select select
case case
when (coalesce(new.date, date('now'))!=date('now') or old.date!=date('now')) and new.adjust_balance=1 when (coalesce(new.date, date('now'))!=date('now') or old.date!=date('now')) and new.adjust_balance
then raise(abort, 'adjust_balance works only with current date') then raise(abort, 'adjust_balance works only with current date')
end; end;
@@ -720,7 +843,7 @@ begin
join fin_asset_types fat on fat.id=fa.type_id join fin_asset_types fat on fat.id=fa.type_id
join fin_storages fs on fs.id=fas.storage_id join fin_storages fs on fs.id=fas.storage_id
where where
new.adjust_balance=1 and new.adjust_balance and
fa.code = new.asset_code and fa.code = new.asset_code and
fat.name = new.asset_type and fat.name = new.asset_type and
fs.name = new.storage fs.name = new.storage