DatabaseRules - Revision history

Jonathan Amme at 09:48, 20 April 2018

2018-04-20T09:48:38Z

Show changes

Berit Müller: /* Database Schema */

2016-12-01T19:43:34Z

‎Database Schema

Ludwig Schneider: /* Database Table */

2016-11-16T15:35:27Z

‎Database Table

Berit Müller at 10:34, 31 October 2016

2016-10-31T10:34:20Z

Berit Müller at 10:13, 31 October 2016

2016-10-31T10:13:00Z

Berit Müller at 10:08, 31 October 2016

2016-10-31T10:08:48Z

Wolf-Dieter Bunke: /* Open Data */

2016-10-25T08:47:43Z

‎Open Data

Martin Glauer at 17:21, 24 October 2016

2016-10-24T17:21:19Z

Show changes

Wolf-Dieter Bunke: /* Data Referencing */

2016-10-24T14:47:06Z

‎Data Referencing

Wolf-Dieter Bunke: /* Comments on Schema */

2016-10-24T14:46:03Z

‎Comments on Schema

@@ Line 32: / Line 32: @@
 <br/>
 === Database Schema<br/> ===
-*There are schemas to structure tables
+you find the current version of the oedb schema [[Database_schema|here]]<br/><br/>
-*The following schemas are already in existence:<br/>
-**demand<br/>
-**economic
-**emission
-**environmental
-**grid
-**openstreetmap
-**political_boundary
-**scenario<br/>
-**social
-**supply
-**weather<br/>
-−
-<br/>
-−
-*Special schemas:<br/>
-**model_draft<br/>
-***model data<br/>
-***has no version control
-−
-−
-*reference<br/>
-**
-−
-*sources<br/>
-**
-−
-*literature<br/>
-−
-Further schema categories or changes can be [https://github.com/openego/oeplatform/issues discussed on GitHub]. There is a whitelist.<br/>
-−
 <br/>

@@ Line 68: / Line 68: @@
 <br/>
 === Database Table<br/> ===
@@ Line 88: / Line 89: @@
 Example: ''zensus_population_by_gender_per_mun''<br/><br/>
-Remember to put your abbreviations in the
+Remember to put your abbreviations in the Glossary
 == Data Integrity<br/> ==

@@ Line 90: / Line 90: @@
 Remember to put your abbreviations in the
-= Data Integrity<br/> =
+== Data Integrity<br/> ==
 "Data integrity refers to maintaining and assuring the accuracy and consistency of data over its entire life-cycle." ([https://en.wikipedia.org/wiki/Data_integrity Wikipedia]) These two aspects belong to the [[Data quality|data quality]] criteria, the data in the oedb should meet.
@@ Line 99: / Line 99: @@
 *Each table should have a single auto-incremented integer column as Primary Key with the corresponding table constraint.<br/>
-*Grant all privilegs to oeuser (automatically done by the system)<br/><br/>
+*Grant all privilegs to oeuser (automatically done by the system)
 === Geografic Data<br/> ===

@@ Line 6: / Line 6: @@
 The following database rules explain the basic principles of the database called oedb, which will become a part of the openmod internet presence. For further details see also [[Database|here]].<br/>
-= Open Data<br/> =
+== Open Data<br/> ==
 *Only use data with suitable licences<br/>
@@ Line 17: / Line 17: @@
 <br/>
-= Data Documentation<br/> =
+== Data Documentation<br/> ==
 *All data included in the databases has be documented! On this wiki page you learn how to do so<br/>
 *All abreviations have to be documentated in the of the openmod wiki<br/>
-= Naming of Data<br/> =
+== Naming of Data<br/> ==
 *The nomenclature should follow a logical structure<br/>
 *There are different levels of naming<br/>
-== Database Name<br/> ==
+=== Database Name<br/> ===
 *The name of the database is<br/>
@@ Line 33: / Line 33: @@
 <br/>
-== Database Schema<br/> ==
+=== Database Schema<br/> ===
 *There are schemas to structure tables
@@ Line 59: / Line 59: @@
 *reference<br/>
 **
 *sources<br/>
-***literature<br/>
+**
 Further schema categories or changes can be [https://github.com/openego/oeplatform/issues discussed on GitHub]. There is a whitelist.<br/>
@@ Line 66: / Line 69: @@
 <br/>
-== Database Table ==
+=== Database Table<br/> ===
 *always lower case<br/>
@@ Line 93: / Line 96: @@
 <br/>
-== General ==
+=== General<br/> ===
 *Each table should have a single auto-incremented integer column as Primary Key with the corresponding table constraint.<br/>
@@ Line 102: / Line 105: @@
 <br/>
-== Geografic Data<br/> ==
+=== Geografic Data<br/> ===
 *Attribut name is '''geom.'''
@@ Line 118: / Line 121: @@
 <br/>
-= Data Referencing<br/> =
+== Data Referencing<br/> ==
-There are several useful attributes on a table users have to know in order to work with the contained data efficiently. Therefore, ensuring the quality of these meta data is as important as ensuring the quality of the data itself (see also [[Data quality|here]]).
+There are several useful attributes on a table users have to know in order to work with the contained data efficiently. Therefore, ensuring the quality of these meta data is as important as ensuring the quality of the data itself (see also [[Data quality|here]]).<br/>
 For these meta data the documentation open-standard Json is used ([https://en.wikipedia.org/wiki/JSON Wiki] and [http://www.json.org/ Json.org]). The documentation is separated in two major categories:
@@ Line 126: / Line 129: @@
 #Comments on tables: Contains metadata that define several aspects for the whole table
 #Comments on rows: Store important informations on a specific row and the stored data
 <br/>

@@ Line 1: / Line 1: @@
 {{GlossaryTermTemp
 |SubtermOf=Database
-}} The following database rules explain the basic principles of the database called oedb, which will become a part of the openmod internet presence. For further details see also [[Database|here]].<br/>
+}}
+= OpenEnergy Data Base (oedb)<br/> =
 <br/>
 = Open Data<br/> =
@@ Line 16: / Line 15: @@
 <br/>
 = Data Documentation<br/> =
@@ Line 58: / Line 58: @@
+*
 *reference<br/>
-***sources<br/>
+**
 ***literature<br/>
@@ Line 354: / Line 355: @@
 |}
-Each row in the reference_to_entries table (green) contains a ref_data_json documentation string which links to the meta data in the Jabref table public.entries (orange).<br/>
+Each row in the reference_to_entries table (green) contains a ref_data_json documentation string which links to the meta data in the Jabref table public.entries (orange).<br/><br/><u>'''Example:'''</u>
 <br/>
 <u>'''Example:'''</u>
 '''Database table: '''ref_test.parameter_electrical_power_plant
@@ Line 442: / Line 441: @@
 The comments on a row aim to enhance the reproducabilty of data that is present in the database by stating the underlying data that was used to compute this&nbsp; row as well as the applied computational methods.<br/>
-During these processes some kinds of uncertainities might occur as well as the decissions (assumtions) that were made to deal with them. Examplatory, some values might be missing amid this row and a linear development during this period was assumed to fix this gap. Each row has to be annotated by a json dictionary that must contain the following fields: <br/>
+During these processes some kinds of uncertainities might occur as well as the decissions (assumtions) that were made to deal with them. Examplatory, some values might be missing amid this row and a linear development during this period was assumed to fix this gap. Each row has to be annotated by a json dictionary that must contain the following fields:<br/>
 ''<u>Json documentation string structure on row:</u>''<br/>

@@ Line 5: / Line 5: @@
 <br/>
 = Open Data<br/> =
@@ Line 11: / Line 12: @@
 *<span lang="EN-US">Do not upload restricted data into the database</span><br/>
-More Information can be found on [[Choosing a license|Open Licenses.]] Additional to the the Project Open Power System Data is covering this topic on [http://open-power-system-data.org/legal OPSD - Legal].
+More Information can be found on [[Choosing a license|Open Licenses.]] Additional, the Project Open Power System Data is dealing this topic on [http://open-power-system-data.org/legal OPSD - Legal].
 <br/>
 = Data Documentation<br/> =

@@ Line 107: / Line 107: @@
 *Spacial index '''GIST''' has to be set
@@ Line 115: / Line 116: @@
 For these meta data the documentation open-standard Json is used ([https://en.wikipedia.org/wiki/JSON Wiki] and [http://www.json.org/ Json.org]). The documentation is separated in two major categories:
 #Comments on tables: Contains metadata that define several aspects for the whole table
 #Comments on rows: Store important informations on a specific row and the stored data
@@ Line 123: / Line 123: @@
 <br/>
 <br/>
 === Comments on Tables<br/> ===
@@ Line 310: / Line 310: @@
 <br/>
 === Meta Documentation of data collections from several sources: ===

← Older revision		Revision as of 14:46, 24 October 2016
Line 123:		Line 123:
	<br/>		<br/>

−	~~=== <s>Comments on Schema</s><br/> ===~~
−
−	<s>Schemata are used in the database in order to structure tables, functions, assign assignment of permissions and much more. For the documentation purpose a string in json format is set as comment on schema. The attribute names begins with an <u>upper case</u> and are given by the following definition for schemata<span style="font-weight: normal">.</span></s><br/>
−
−	~~<br/>~~
−
−	~~{\| style="width: 643px" cellspacing="1" cellpadding="1"~~
−	~~\|+ <s>Metadata Documentation of schemata</s><br/>~~
−	~~\|- valign="top"~~
−	! scope="col" style="border-width: 1px medium 1px 1px; border-style: solid none solid solid; border-color: rgb(0, 0, 0) -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0.1cm 0cm 0.1cm 0.1cm; width: 198px; height: 15px" \| <div><s>Attribute (level 1)</s><br/></div>
−	! scope="col" style="border-width: 1px medium 1px 1px; border-style: solid none solid solid; border-color: rgb(0, 0, 0) -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0.1cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><s>Attribute (level 2)</s><br/></div>
−	~~! scope="col" style="width: 291px; border: 1px solid rgb(0, 0, 0); padding: 0.1cm" \| <div><s>Description</s><br/></div>~~
−	~~\|- valign="top"~~
−	\| style="height: 15px; width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" \| <div><s>Name</s><br/></div>
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px; height: 15px" \| <div><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm; height: 15px" \| <div><s>Original name of the data set</s></div>
−	~~\|- valign="top"~~
−	\| style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" \| <div><s>Description</s></div>
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Short description of the data set.</s></div>
−	~~\|- valign="top"~~
−	\| style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" \| <div><s>Changes</s></div>
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Information of changes and user</s></div>
−	~~\|- valign="top"~~
−	\| rowspan="4" style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" \| <div><br/></div>
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><s>Name</s></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Name of Person created or changed dataset</s></div>
−	~~\|- valign="top"~~
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><s>Mail</s></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>E-mail Address</s></div>
−	~~\|- valign="top"~~
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><s>Date</s><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Date of changes</s></div>
−	~~\|- valign="top"~~
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><s>Comment</s><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Comment of changes</s></div>
−	~~\|- valign="top"~~
−	\| style="width: 168px; border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 198px" \| <div><s>Note</s><br/></div>
−	\| style="border-width: medium medium 1px 1px; border-style: none none solid solid; border-color: -moz-use-text-color -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0cm 0.1cm 0.1cm; width: 131px" \| <div><br/></div>
−	\| style="width: 291px; border-width: medium 1px 1px; border-style: none solid solid; border-color: -moz-use-text-color rgb(0, 0, 0) rgb(0, 0, 0); padding: 0cm 0.1cm 0.1cm" \| <div><s>Field for notes or ToDo which are not done yet</s><br/></div>
−	\|}
−
−	~~<br/><s>[https://github.com/openego/data_processing/blob/master/data_documentation/documentaion_on_schema_example.sql SQL Json Example]</s>~~
−
−	~~<br/>~~

	<br/>		<br/>