DataStore¶
Generalization is AnnotatedIdentifiable.
Superclass hierarchy
Definition¶
Collection of logical records.
Examples¶
The data lineage of an individual BusinessProcess or an entire DataPipeline are both examples of a LogicalRecordRelationStructures. In a data lineage we can observe how LogicalRecords are connected within a BusinessProcess or across BusinessProcesses.
Explanatory notes¶
Keep in mind that a LogicalRecords is a definition, not a “datasets”. LogicalRecords organized in a StructuredCollection is called a LogicalRecordRelationStructure. Instances of LogicalRecords instantiated as organizations of DataPoints hosting data are described in FormatDescription. A DataStore is reusable across studies. Each Study has at most one DataStore.
Subclasses¶
Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
aboutMissing
from DataStore
|
General information about missing data, e.g., that missing data have been standardized across the collection, missing data are present because of merging, etc.- corresponds to DDI2.5 dataMsng. |
0..1 |
|
characterSet
from DataStore
|
Default character set used in the Data Store. |
:ref:`` |
0..1 |
dataStoreType
from DataStore
|
The type of DataStore. Could be delimited file, fixed record length file, relational database, etc. Points to an external definition which can be part of a controlled vocabulary maintained by the DDI Alliance. |
0..1 |
|
duplicates
from DataStore
|
Whether the collection is a bag or a set: a bag is a collection with duplicates allowed, a set is a collection without duplicates. |
:ref:`` |
1..1 |
name
from DataStore
|
A linguistic signifier. Human understandable name (word, phrase, or mnemonic) that reflects the ISO/IEC 11179-5 naming principles. If more than one name is provided provide a context to differentiate usage. |
0..* |
|
purpose
from DataStore
|
Explanation of the intent of some decision or object. Supports the use of multiple languages and structured text. |
0..1 |
|
recordCount
from DataStore
|
The number of records in the Data Store. |
:ref:`` |
0..1 |
Inherited Properties¶
Name |
Description |
Data Type |
Multi- plicity |
---|---|---|---|
agency
from Identifiable
|
Agency expressed as filed with the DDI Agency ID registry [registry.ddialliance.org] with optional additional sub-agency extensions. |
:ref:`` |
1..1 |
id
from Identifiable
|
ID conforming to the allowed structure of the DDI Identifier and must be unique within the Agency. |
:ref:`` |
1..1 |
isPersistent
from Identifiable
|
Default value is false indicating that the content of the current version may change (may be in development mode). Set to true when the content of this version will no longer change. |
:ref:`` |
1..1 |
isUniversallyUnique
from Identifiable
|
Default value is false. If the id of the object was created as a Universally Unique ID (UUID) set to true. |
:ref:`` |
1..1 |
localId
from Identifiable
|
Locally used identifier unique with a specified context, such as a variable name within a dataset. |
0..* |
|
version
from Identifiable
|
Version number of the object. |
:ref:`` |
1..1 |
versionDate
from Identifiable
|
Date and time the object was changed expressed in standard ISO formats. |
0..1 |
|
versionRationale
from Identifiable
|
Reason for making a new version of the object. |
0..1 |
|
versionResponsibility
from Identifiable
|
Contributor who has the ownership and responsibility for the current version. |
:ref:`` |
0..1 |
Associations¶
Multiplicity |
Association |
Navigable Class |
Multiplicity |
---|---|---|---|
0..* |
DataStore_isDefinedBy_Concept |
0..* |
|
0..* |
DataStore_has_LogicalRecord |
0..* |
|
0..* |
DataStore_has_LogicalRecordPosition |
1..1 |
|
0..1 |
DataStore_has_RecordRelation |
0..* |
TBD
Diagram¶
TBD