Changes for page Part IV. Data and Reference Metadata Namespaces

Last modified by Elena on 2025/09/10 11:19

From 3.13 to 3.14 From 3.15 to 3.16

From version 3.14

edited by Helena
on 2025/07/02 16:17

Change comment: There is no comment for this version

To version 3.15

edited by Helena
on 2025/07/02 16:18

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -826,51 +826,51 @@
  == 4.1 Data Actions ==
--Data messages allow indicating intended actions when used to update an SDMX storage system. This purpose is noted in the action of the data set, which is either inherited from the header of the data message or explicitly stated at the data set level.
++Data messages allow indicating intended actions when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system. This purpose is noted in the action of the [[data set>>doc:sdmx:Glossary.Data set.WebHome]], which is either inherited from the header of the data message or explicitly stated at the [[data set>>doc:sdmx:Glossary.Data set.WebHome]] (% style="color:#e74c3c" %)level(%%).
--Note that the former *Append* and *Information* actions are deprecated. When used to update an SDMX storage system, the *Merge* action is assumed.
++Note that the former *Append* and *Information* actions are deprecated. When used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system, the *Merge* action is assumed.
  === 4.1.1 Merge Action ===
--Data or data-related reference metadata is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any component values. Updating individual values in multi-valued measure, attribute or data-related reference metadata values is not supported either. The complete multi-valued value is to be provided.
++Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be merged, through either update or insertion depending on already existing information. This operation does not allow deleting any [[component>>doc:sdmx:Glossary.Component.WebHome]] values. Updating individual values in multi-valued [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values is not supported either. The complete multi-valued value is to be provided.
--Only non-dimensional components (measure, attribute or data-related reference metadata values) can be **omitted** (null or absent) as long as at least one of those components is present. Bulk merges are thus not supported. Only the provided values are merged.
++Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent) as long as at least one of those [[components>>doc:sdmx:Glossary.Component.WebHome]] is present. Bulk merges are thus not supported. Only the provided values are merged.
--Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions.
++[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these dimensions.
--All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the *Merge* action change their time stamp when used to update an SDMX storage system.
++All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the *Merge* action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system.
  === 4.1.2 Replace Action ===
--Data or data-related reference metadata is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “//replacement levels//”: for entire observations and for any specific dimension combination for data-related reference metadata attributes. Within these “replacement levels” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other attributes (those above the observation level) are merged (see //Merge// action).
++Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be replaced, through either update, insert or delete depending on already existing information. A full replacement is hereby assumed to take place at specific “//replacement (% style="color:#e74c3c" %)levels//(%%)”: for entire observations and for any specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combination for data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]. Within these “replacement (% style="color:#e74c3c" %)levels(%%)” the provided values are inserted or updated, and omitted values are deleted. Values provided for the other [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] (those above the observation (% style="color:#e74c3c" %)level(%%)) are merged (see //Merge// action).
--Only non-dimensional components (measure, attribute or reference metadata values) can be **omitted** (null or absent). Bulk replacing is thus not supported.
++Only non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]] ([[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values) can be **omitted** (null or absent). Bulk replacing is thus not supported.
--Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions.
++[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these dimensions.
  Replacing non-existing elements is not resulting in an error.
--All observations as well as the sets of data-related reference metadata attributes at specific dimension combinations impacted by the //Replace// action change their time stamp when used to update an SDMX storage system.
++All observations as well as the sets of data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] at specific [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] combinations impacted by the //Replace// action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system.
--Because the //replace// action always takes place at specific levels, it cannot be used to replace a whole dataset or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// dataset containing a completely wildcarded key (where all dimension values are omitted) with a //Merge// or //Replace// dataset within the same data message. Similarly, to replace a whole series, a message can combine a //delete// dataset containing only the partial key of the series (where the not used dimension values are omitted) with a //Merge// or //Replace// dataset for that series.
++Because the //replace// action always takes place at specific (% style="color:#e74c3c" %)levels(%%), it cannot be used to replace a whole [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] or a whole series. However, a //“replace all”// effect can be achieved by combining a //Delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing a completely wildcarded key (where all [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] within the same data message. Similarly, to replace a whole series, a message can combine a //delete// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] containing only the partial key of the series (where the not used [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values are omitted) with a //Merge// or //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] for that series.
  === 4.1.3 Delete Action ===
--Data or data-related reference metadata is to be deleted. Deletion is hereby assumed to take place at the lowest level of detail provided in the message.
++Data or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] is to be deleted. Deletion is hereby assumed to take place at the lowest (% style="color:#e74c3c" %)level(%%) of detail provided in the message.
--Any component (including dimensions) can be **omitted** (dimensions: empty, others: null or absent). Omitting dimension values allows for bulk deletions. Partially omitting non-dimension component values allows restricting the deletion of measure, attribute or data-related reference metadata values to the ones being present. Instead of real values for non-dimensional components, it is sufficient to use any valid value.
++Any [[component>>doc:sdmx:Glossary.Component.WebHome]] (including [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]) can be **omitted** ([[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]]: empty, others: null or absent). Omitting [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values allows for bulk deletions. Partially omitting non-[[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] [[component>>doc:sdmx:Glossary.Component.WebHome]] values allows restricting the deletion of [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] or data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] values to the ones being present. Instead of real values for non-dimensional [[components>>doc:sdmx:Glossary.Component.WebHome]], it is sufficient to use any valid value.
--With this, whole datasets, any slices of observations for dimension groups such as time series, observations or individual measure, attribute and data-related reference metadata attributes values can be deleted.
++With this, whole [[datasets>>doc:sdmx:Glossary.Data set.WebHome]], any slices of observations for [[dimension>>doc:sdmx:Glossary.Dimension.WebHome]] groups such as time series, observations or individual [[measure>>doc:sdmx:Glossary.Measure.WebHome]], [[attribute>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] values can be deleted.
--Dimension values for higher-level (data-related reference metadata) attributes can be **switched-off** (using ) when those are not attached to these dimensions.
++[[Dimension>>doc:sdmx:Glossary.Dimension.WebHome]] values for higher-(% style="color:#e74c3c" %)level(%%) (data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]]) [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] can be **switched-off** (using ) when those are not attached to these [[dimensions>>doc:sdmx:Glossary.Dimension.WebHome]].
  Deleting non-existing elements or values is not resulting in an error.
--All observations as well as the sets of attributes and data-related reference metadata at higher partial keys impacted by the *Delete* action change their time stamp when used to update an SDMX storage system.
++All observations as well as the sets of [[attributes>>doc:sdmx:Glossary.Attribute.WebHome]] and data-related [[reference metadata>>doc:sdmx:Glossary.Reference metadata.WebHome]] at higher partial keys impacted by the *Delete* action change their time stamp when used to update an [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] storage system.
  === 4.1.4 Further Details ===
--The following convention is used to indicate the state of components in data messages:
++The following convention is used to indicate the state of [[components>>doc:sdmx:Glossary.Component.WebHome]] in data messages:
  (% style="width:1364.29px" %)
  | | |(% style="width:260px" %)**Dimension value is**|(% style="width:391px" %) |(% style="width:383px" %)**Measure, attribute or reference metadata value is**|(% style="width:184px" %)
@@ -884,23 +884,23 @@
  **Important notes:**
--The terms “//delete//”, “//merge//” and “//replace//” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, SDMX web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. SDMX web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, SDMX web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
++The terms “//delete//”, “//merge//” and “//replace//” do **not** imply a physical replacement or deletion of values in the underlying database. To minimize the physical resource requirements, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service implementations that do not support the //includeHistory// and //asOf// URL parameters might physically replace the existing values in the database. [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that neither support the *updatedAfter* URL parameter might also implement physical deletions. However, [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that support these parameters (or other time-machine features), would not overwrite or delete the physical values.
--SDMX web services that support the //includeHistory// or //asOf// URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of data consumers, such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the SDMX standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the SDMX standard.
++[[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web services that support the //includeHistory// or //asOf// URL parameters should never allow deleting their **historic** data content because this would interfere with the interests of [[data consumers>>doc:sdmx:Glossary.Data consumer.WebHome]], such as data aggregators. Therefore, a specific feature to physically delete previous (outdated) content is intentionally not added to the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard syntax. If such a feature is required by an organisation, then it needs to be implemented as a custom feature outside the [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] standard.
--Likewise, all SDMX-compliant systems that do (or are configured to) support the //updatedAfter// URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
++Likewise, all [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]]-compliant systems that do (or are configured to) support the //updatedAfter// URL parameter need to systematically retain the information about deleted data (or data-related reference metadata).
--All datasets – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These datasets are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate //delete// and //replace// or //merge// actions into one transactional data message.
++All [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] – even with varying actions – within a single data message have always to be treated as **ACID transaction** to guarantee “transactional safety” (full data consistency and validity despite errors, power failures, and other mishaps). These [[datasets>>doc:sdmx:Glossary.Data set.WebHome]] are to be processed in the order of appearance in the message. The advantage of such data messages is thus the ability to bundle separate //delete// and //replace// or //merge// actions into one transactional data message.
--**Recommended{{footnote}}So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory{{/footnote}} dataset actions in SDMX web service responses to GET data queries:**
++**Recommended{{footnote}}So far this is recommended for systems that do not require backward-compatibility. Later, with SDMX 4.0, this may generally be made mandatory{{/footnote}} [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] actions in [[SDMX>>doc:sdmx:Glossary.Statistical data and metadata exchange.WebHome]] web service responses to GET data queries:**
--~1. Without the //updatedAfter//, //includeHistory//, //detail//, //attributes// or //measures// URL parameters:
++~1. Without the //updatedAfter//, //includeHistory//, //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters:
--The response message should contain the retrieved data in a //Replace// dataset (instead of the previous *information* dataset).
++The response message should contain the retrieved data in a //Replace// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous *information* [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]).
--2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //attributes// or //measures// URL parameters:
++2. Without the //updatedAfter// and //includeHistory//, but with //detail//, //[[attributes>>doc:sdmx:Glossary.Attribute.WebHome]]// or //[[measures>>doc:sdmx:Glossary.Measure.WebHome]]// URL parameters:
--The response message should contain the retrieved data in a //Merge// dataset (instead of the previous *Information* dataset).
++The response message should contain the retrieved data in a //Merge// [[dataset>>doc:sdmx:Glossary.Data set.WebHome]] (instead of the previous *Information* [[dataset>>doc:sdmx:Glossary.Data set.WebHome]]).
 . With the //updatedAfter// URL parameter: