telefonicaid / fiware-cygnus

A connector in charge of persisting context data sources into other third-party databases and storage systems, creating a historical view of the context
https://fiware-cygnus.rtfd.io/
GNU Affero General Public License v3.0
65 stars 104 forks source link

Docu: DM sections for STH sinks #2317

Open fgalan opened 9 months ago

fgalan commented 9 months ago

Postgis sink documentation has a section in which DM are described:

https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_postgresql_sink.md#section1.2

However, there isn't a similar section in STH sinks:

https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_sth_sink.md https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_mongo_sink.md

So a similar table should be included, in this case described the MongoDB index created in each case.

See: https://github.com/telefonicaid/fiware-cygnus/pull/2205#issuecomment-1770205208

AlvaroVega commented 5 months ago

@fgalan should we close this ?

There is no table about DM in mongo/STH sink but there is tree entries that could be translated into table rows: https://github.com/telefonicaid/fiware-cygnus/blob/master/doc/cygnus-ngsi/flume_extensions_catalogue/ngsi_sth_sink.md#mongodb-collections-naming-conventions

fgalan commented 5 months ago

I think the issue is still valid (although minor) and it would be solved as you said translating those entries into a table.

Documentation also should explain what happens when a DM different from these one is used in the sink configuration. It seems that in that case, the default DM is used, without raising any warning/error (maybe a warning should be raised...).